com.atlassian.bitbucket.event.pull

Class PullRequestOpenRequestedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.pull.PullRequestEvent

com.atlassian.bitbucket.event.pull.PullRequestOpenRequestedEvent

All Implemented Interfaces:

CancelableEvent, CancelState, Serializable

@TransactionAware(value=IMMEDIATE)
public class PullRequestOpenRequestedEvent
extends PullRequestEvent
implements CancelableEvent

Raised just before a pull request is opened. This event is synchronous, allowing listeners to perform operations in the same database transaction where the pull request will be opened.

This event is cancelable. A listener may prevent the pull request from being opened by canceling this event. Throwing an exception will not prevent the pull request from being opened; the exception will be logged and ignored.

Note: The pull request attached to the event will not have an ID, as it has not been opened yet. Any listener which would like to create associations based on that ID must listen for the PullRequestOpenedEvent instead, which will include it (but will not run in the same transaction).

See Also:

PullRequestService.create(com.atlassian.bitbucket.pull.PullRequestCreateRequest), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PullRequestOpenRequestedEvent(Object source, PullRequest pullRequest, Set<ApplicationUser> reviewers, CancelState cancelState)

Method Summary

Modifier and Type	Method and Description
void	cancel(KeyedMessage message) Cancels pull request creation, providing a message explaining why.
Set<ApplicationUser>	getReviewers() Retrieves a set containing the users who have been specified as reviewers for the pull request that is about to be created.
boolean	isCanceled() Retrieves a flag indicating whether pull request creation has already been canceled by another listener.

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 Detail

PullRequestOpenRequestedEvent

public PullRequestOpenRequestedEvent(@Nonnull
                                     Object source,
                                     @Nonnull
                                     PullRequest pullRequest,
                                     @Nonnull
                                     Set<ApplicationUser> reviewers,
                                     @Nonnull
                                     CancelState cancelState)

Method Detail

cancel

public void cancel(@Nonnull
                   KeyedMessage message)

Cancels pull request creation, providing a message explaining why.

Specified by:

cancel in interface CancelState

Parameters:

message - a descriptive message explaining why the operation has been canceled

getReviewers

@Nonnull
public Set<ApplicationUser> getReviewers()

Retrieves a set containing the users who have been specified as reviewers for the pull request that is about to be created.

The returned set is immutable. Listeners cannot add reviewers using this event. The set may be empty, if no reviewers have been requested, but it will never be null.

Returns:

a set containing 0 or more reviewers for the pull request

isCanceled

public boolean isCanceled()

Retrieves a flag indicating whether pull request creation has already been canceled by another listener.

Specified by:

isCanceled in interface CancelState

Returns:

true if another listener has already canceled pull request creation; otherwise, false