Package io.github.thecsdev.tcdcommons.api.event

Enum Class TEventResult

java.lang.Object

java.lang.Enum<TEventResult>

io.github.thecsdev.tcdcommons.api.event.TEventResult

All Implemented Interfaces:

Serializable, Comparable<TEventResult>, Constable

public enum TEventResult
extends Enum<TEventResult>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCEL_ALL
CANCEL_EVENT
CANCEL_NONE
CANCEL_PROPAGATION

Method Summary

Modifier and Type	Method	Description
TEventResult	combine(TEventResult other)
final boolean	isEventCancelled()
final boolean	isPropagationCancelled()
static TEventResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TEventResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CANCEL_EVENT

public static final TEventResult CANCEL_EVENT

CANCEL_PROPAGATION

public static final TEventResult CANCEL_PROPAGATION

CANCEL_NONE

public static final TEventResult CANCEL_NONE

CANCEL_ALL

public static final TEventResult CANCEL_ALL

Method Details

values

public static TEventResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TEventResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isEventCancelled

public final boolean isEventCancelled()

isPropagationCancelled

public final boolean isPropagationCancelled()

combine

public TEventResult combine(TEventResult other)