me.lucko.luckperms.api.event

Interface Cancellable

All Known Subinterfaces:

LogBroadcastEvent, LogNetworkPublishEvent, LogNotifyEvent, LogPublishEvent, PreNetworkSyncEvent, PreSyncEvent

public interface Cancellable

Represents an event that can be cancelled

Method Summary

Modifier and Type	Method and Description
@NonNull AtomicBoolean	getCancellationState() Gets an AtomicBoolean holding the cancellation state of the event
default boolean	isCancelled() Returns true if the event is currently cancelled.
default boolean	isNotCancelled() Returns true if the event is not currently cancelled.
default boolean	setCancelled(boolean cancelled) Sets the cancellation state of the event.

Method Detail

getCancellationState

@NonNull AtomicBoolean getCancellationState()

Gets an AtomicBoolean holding the cancellation state of the event

Returns:

the cancellation

isCancelled

default boolean isCancelled()

Returns true if the event is currently cancelled.

Returns:

if the event is cancelled

Since:

4.1

isNotCancelled

default boolean isNotCancelled()

Returns true if the event is not currently cancelled.

Returns:

if the event is not cancelled

Since:

4.1

setCancelled

default boolean setCancelled(boolean cancelled)

Sets the cancellation state of the event.

Parameters:

cancelled - the new state

Returns:

the previous state

Since:

4.1