@TransactionAware public class

PullRequestOpenRequestedEvent

extends PullRequestEvent
implements CancelableEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.bitbucket.event.ApplicationEvent
       ↳ com.atlassian.bitbucket.event.pull.PullRequestEvent
         ↳ com.atlassian.bitbucket.event.pull.PullRequestOpenRequestedEvent

Class Overview

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(String, String, java.util.Set, Repository, String, Repository, String)

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
PullRequestOpenRequestedEvent(Object source, PullRequest pullRequest, Set<ApplicationUser> reviewers, CancelState cancelState)
Public Methods
void cancel(KeyedMessage message)
Cancels pull request creation, providing a message explaining why.
@Nonnull 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.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.event.pull.PullRequestEvent
From class com.atlassian.bitbucket.event.ApplicationEvent
From class java.util.EventObject
From class java.lang.Object
From interface com.atlassian.bitbucket.util.CancelState

Public Constructors

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

Public Methods

public void cancel (KeyedMessage message)

Cancels pull request creation, providing a message explaining why.

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

@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

public boolean isCanceled ()

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

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