public interface CancelState
Once an operation has been
canceled, it cannot be "un-canceled". Where multiple
observers have the option to cancel an operation, cancellation by any observer should be considered as
final and binding; implementations should not require consensus among all observers.
void cancel(@Nonnull KeyedMessage message)
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.
message- a descriptive message explaining why the operation has been canceled
NullPointerException- if the provided
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.
trueif the operation has been
Copyright © 2022 Atlassian. All rights reserved.