com.atlassian.bitbucket.event.pull

Class PullRequestCancelableCommentEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.pull.PullRequestEvent

com.atlassian.bitbucket.event.pull.PullRequestCancelableCommentEvent

All Implemented Interfaces:

CancelableEvent, CancelState, Serializable

Direct Known Subclasses:

PullRequestCommentAddRequestedEvent, PullRequestCommentDeletionRequestedEvent, PullRequestCommentModificationRequestedEvent, PullRequestCommentReplyRequestedEvent

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

Subclasses of this event are synchronous and allow callers to cancel the action and/or participate in the transaction (by persisting related entities, for example).

Since:

6.6

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PullRequestCancelableCommentEvent(Object source, PullRequest pullRequest, Comment comment, Comment parent, CommentAction commentAction, CancelState cancelState)

Method Summary

Modifier and Type	Method and Description
void	cancel(KeyedMessage message) Cancels the operation, providing a message explaining why.
Comment	getComment()
CommentAction	getCommentAction()
Comment	getParent()
boolean	isCanceled() Retrieves a flag indicating whether the operation has been canceled.

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

PullRequestCancelableCommentEvent

protected PullRequestCancelableCommentEvent(@Nonnull
                                            Object source,
                                            @Nonnull
                                            PullRequest pullRequest,
                                            @Nonnull
                                            Comment comment,
                                            @Nullable
                                            Comment parent,
                                            @Nonnull
                                            CommentAction commentAction,
                                            @Nonnull
                                            CancelState cancelState)

Method Detail

cancel

public void cancel(@Nonnull
                   KeyedMessage message)

Description copied from interface: CancelState

Cancels the operation, providing a message explaining why.

The cancellation message is required, and should be as descriptive and clear as possible to allow end users to correct, if possible, the issue that triggered cancellation.

Specified by:

cancel in interface CancelState

Parameters:

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

getComment

@Nonnull
public Comment getComment()

getCommentAction

@Nonnull
public CommentAction getCommentAction()

getParent

@Nullable
public Comment getParent()

isCanceled

public boolean isCanceled()

Description copied from interface: CancelState

Retrieves a flag indicating whether the operation has been canceled.

In situations where multiple observers have the option to cancel an operation, for example when multiple listeners receive the same CancelableEvent, this flag can be useful for determining that another observer has already canceled the operation.

Specified by:

isCanceled in interface CancelState

Returns:

true if the operation has been canceled; otherwise, false