Class PullRequestCancelableCommentEvent

All Implemented Interfaces:
CancelableEvent, CancelState, Serializable
Direct Known Subclasses:
PullRequestCommentAddRequestedEvent, PullRequestCommentDeletionRequestedEvent, PullRequestCommentModificationRequestedEvent, PullRequestCommentReplyRequestedEvent

@TransactionAware(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:
  • Constructor Details

  • Method Details

    • 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