public abstract class

RefChangeRequestedEvent

extends ApplicationEvent
implements CancelableEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.bitbucket.event.ApplicationEvent
       ↳ com.atlassian.bitbucket.event.repository.RefChangeRequestedEvent
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A base class for ref change request events

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
RefChangeRequestedEvent(Object source, Repository repository, CancelState cancelState)
Public Methods
void cancel(KeyedMessage message)
Cancels the operation, providing a message explaining why.
@Nonnull Repository getRepository()
boolean isCanceled()
Retrieves a flag indicating whether the operation has been canceled.
[Expand]
Inherited Methods
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 RefChangeRequestedEvent (Object source, Repository repository, CancelState cancelState)

Public Methods

public void cancel (KeyedMessage message)

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.

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

@Nonnull public Repository getRepository ()

public boolean isCanceled ()

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.

Returns
  • true if the operation has been canceled; otherwise, false