com.atlassian.bitbucket.event.pull

Class PullRequestMergedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.pull.PullRequestEvent

com.atlassian.bitbucket.event.pull.PullRequestMergedEvent

All Implemented Interfaces:

RepositoryRefsChangedEvent, Serializable

@AsynchronousPreferred
public class PullRequestMergedEvent
extends PullRequestEvent
implements RepositoryRefsChangedEvent

Event raised when a pull request is merged via the web UI or REST, or when a remote merge is detected.

If the pull request was merged by the system, the commit resulting from the merge (which may or may not be a literal merge commit, depending on the configured merge strategy) will be included. Otherwise, if the pull request was merged remotely, meaning a commit which is a descendant of the from ref was pushed to the to ref, the commit will not be provided.

Listeners that are interested in all repository changes (and not just pull request merges) should listen for RepositoryRefsChangedEvents.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PullRequestMergedEvent(Object source, PullRequest pullRequest) Constructs a new PullRequestMergedEvent.
PullRequestMergedEvent(Object source, PullRequest pullRequest, MinimalCommit commit, String message, Map<String,Object> context) Constructs a new PullRequestMergedEvent.
PullRequestMergedEvent(Object source, PullRequest pullRequest, MinimalCommit commit, String message, String strategyId, Map<String,Object> context) Constructs a new PullRequestMergedEvent.

Method Summary

Modifier and Type	Method and Description
MinimalCommit	getCommit()
Map<String,Object>	getContext()
String	getMessage()
Collection<RefChange>	getRefChanges() Retrieves a collection of the changed refs.
Repository	getRepository() Retrieves the repository in which refs were changed.
String	getStrategyId()
boolean	isMergedRemotely()

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

Methods inherited from interface com.atlassian.bitbucket.event.repository.RepositoryRefsChangedEvent

getUser

Constructor Detail

PullRequestMergedEvent

public PullRequestMergedEvent(@Nonnull
                              Object source,
                              @Nonnull
                              PullRequest pullRequest)

Constructs a new PullRequestMergedEvent. This is a convenience constructor for remotely-merged pull requests, where the merge commit is not known.

Parameters:

source - the entity raising the event

pullRequest - the pull request that was merged

PullRequestMergedEvent

public PullRequestMergedEvent(@Nonnull
                              Object source,
                              @Nonnull
                              PullRequest pullRequest,
                              @Nullable
                              MinimalCommit commit,
                              @Nullable
                              String message,
                              @Nonnull
                              Map<String,Object> context)

Constructs a new PullRequestMergedEvent. The merge commit should be provided if the pull request was merged by the system, and should be left null if the merge was pushed by a user.

Parameters:

source - the entity raising the event

pullRequest - the pull request that was merged

commit - the commit that resulted from the merging the pull request via the web UI or REST, which may by null if the pull request was merged remotely and pushed up

message - the commit message, which may be null

context - additional context provided when merging the pull request, intended to allow plugins to add their own functionality around the merge operation

PullRequestMergedEvent

public PullRequestMergedEvent(@Nonnull
                              Object source,
                              @Nonnull
                              PullRequest pullRequest,
                              @Nullable
                              MinimalCommit commit,
                              @Nullable
                              String message,
                              @Nullable
                              String strategyId,
                              @Nonnull
                              Map<String,Object> context)

Constructs a new PullRequestMergedEvent. The merge commit should be provided if the pull request was merged by the system, and should be left null if the merge was pushed by a user.

Parameters:

source - the entity raising the event

pullRequest - the pull request that was merged

commit - the commit that resulted from the merging the pull request via the web UI or REST, which may by null if the pull request was merged remotely and pushed up

message - the commit message, which may be null

strategyId - the strategy used to merge the pull request

context - additional context provided when merging the pull request, intended to allow plugins to add their own functionality around the merge operation

Since:

4.9

Method Detail

getCommit

@Nullable
public MinimalCommit getCommit()

Returns:

the merge commit, which may be null if the pull request was merged remotely

getContext

@Nonnull
public Map<String,Object> getContext()

Returns:

additional context provided when the merge was requested

getMessage

@Nullable
public String getMessage()

Returns:

the proposed commit message, which may be null

getRefChanges

@Nonnull
public Collection<RefChange> getRefChanges()

Description copied from interface: RepositoryRefsChangedEvent

Retrieves a collection of the changed refs.

Note: While the returned collection will never be null, it may be empty. For example, a remotely merged pull request will have an empty set of changes.

Specified by:

getRefChanges in interface RepositoryRefsChangedEvent

Returns:

a collection of updated refs which may be empty, if the pull request was merged remotely, or contain a single updated ref for the pull request's target branch, if the pull request was merged via the web UI or REST

getRepository

@Nonnull
public Repository getRepository()

Description copied from interface: RepositoryRefsChangedEvent

Retrieves the repository in which refs were changed. All of the changed refs for a single event will always be in the same repository.

Specified by:

getRepository in interface RepositoryRefsChangedEvent

Returns:

the repository into which the pull request was merged

getStrategyId

@Nullable
public String getStrategyId()

Returns:

the ID of the strategy used to merge the pull request

Since:

4.9

isMergedRemotely

public boolean isMergedRemotely()

Returns:

true if the pull request was merged remotely and pushed up; otherwise, false if the pull request was merged via the web UI or REST