com.atlassian.bitbucket.event.pull

Class PullRequestDeletionRequestedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.pull.PullRequestEvent

com.atlassian.bitbucket.event.pull.PullRequestDeletionRequestedEvent

All Implemented Interfaces:

CancelableEvent, CancelState, Serializable

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

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

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

Since:

5.1

See Also:

PullRequestService.delete(PullRequestDeleteRequest), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PullRequestDeletionRequestedEvent(Object source, PullRequest pullRequest, CancelState cancelState)

Method Summary

Modifier and Type	Method and Description
void	cancel(KeyedMessage message) Cancels pull request deletion, providing a message explaining why.
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

PullRequestDeletionRequestedEvent

public PullRequestDeletionRequestedEvent(@Nonnull
                                         Object source,
                                         @Nonnull
                                         PullRequest pullRequest,
                                         @Nonnull
                                         CancelState cancelState)

Method Detail

cancel

public void cancel(@Nonnull
                   KeyedMessage message)

Cancels pull request deletion, providing a message explaining why.

Specified by:

cancel in interface CancelState

Parameters:

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

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