Package com.atlassian.bitbucket.event.pull

Class PullRequestRescopedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.pull.PullRequestEvent

com.atlassian.bitbucket.event.pull.PullRequestRescopedEvent

All Implemented Interfaces:

Serializable

@AsynchronousPreferred
public class PullRequestRescopedEvent
extends PullRequestEvent

Event that is raised when the ref for the source-branch and/or the target-branch of a pull request is updated. Note that this does not necessarily mean that the list of commits that the pull request covers will change.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PullRequestRescopedEvent(Object source, PullRequest pullRequest, String previousFromHash, String previousToHash)
PullRequestRescopedEvent(Object source, PullRequest pullRequest, String previousFromHash, String previousToHash, RescopeDetails addedCommits, RescopeDetails removedCommits)

Method Summary

Modifier and Type	Method	Description
RescopeDetails	getAddedCommits()
String	getPreviousFromHash()
String	getPreviousToHash()
RescopeDetails	getRemovedCommits()
boolean	isFromHashUpdated()
boolean	isToHashUpdated()

Methods inherited from class com.atlassian.bitbucket.event.pull.PullRequestEvent

getAction, getPullRequest

Methods inherited from class com.atlassian.bitbucket.event.ApplicationEvent

getDate, getUser

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PullRequestRescopedEvent

public PullRequestRescopedEvent(@Nonnull
 Object source,
 @Nonnull
 PullRequest pullRequest,
 @Nonnull
 String previousFromHash,
 @Nonnull
 String previousToHash)

PullRequestRescopedEvent

public PullRequestRescopedEvent(@Nonnull
 Object source,
 @Nonnull
 PullRequest pullRequest,
 @Nonnull
 String previousFromHash,
 @Nonnull
 String previousToHash,
 @Nullable
 RescopeDetails addedCommits,
 @Nullable
 RescopeDetails removedCommits)

Parameters:

source - the object on which the event initially occurred.

pullRequest - the rescoped pull request

previousFromHash - the previous from hash

previousToHash - the previous to hash

addedCommits - commits added

removedCommits - commits removed

Since:

4.5

Method Details

getAddedCommits

@Nullable
public RescopeDetails getAddedCommits()

Returns:

details about what commits, if any were added to the scope of the pull request. The commits list is limited for performance reasons. Use RescopeDetails.getTotal() to determine the total number of commits that were added to the scope of the pull request. If more commits were added to the scope than are returned in this list, the list will contain the most recent commits that were added. Returns null if the scope change hasn't been determined.

Since:

4.5

getPreviousFromHash

@Nonnull
public String getPreviousFromHash()

getPreviousToHash

@Nonnull
public String getPreviousToHash()

getRemovedCommits

@Nullable
public RescopeDetails getRemovedCommits()

Returns:

details about what commits, if any were removed from the scope of the pull request. The commits list is limited for performance reasons. Use RescopeDetails.getTotal() to determine the total number of commits that were removed from the scope of the pull request. If more commits were removed from the scope than are returned in this list, the list will contain the most recent commits that were removed. Returns null if the scope change hasn't been determined.

Since:

4.5

isFromHashUpdated

public boolean isFromHashUpdated()

Returns:

true if the from-hash has been updated in this scope change. false otherwise

Since:

4.5

isToHashUpdated

public boolean isToHashUpdated()

Returns:

true if the to-hash has been updated in this scope change. false otherwise

Since:

4.5