Package dev.kosmx.playerAnim.core.impl.event

Enum Class EventResult

java.lang.Object

java.lang.Enum<EventResult>

dev.kosmx.playerAnim.core.impl.event.EventResult

All Implemented Interfaces:

Serializable, Comparable<EventResult>, Constable

public enum EventResult
extends Enum<EventResult>

Generic event results See the actual event documentation for actual behaviour

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
CONSUME	Cancel the event, then does nothing.
FAIL	Event failed, cancel the further processing, see the event's documentation
PASS	Your listener did nothing, in won't change the result of the event
SUCCESS	Cancel the event and success.

Method Summary

Modifier and Type	Method	Description
static EventResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventResult[]	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

PASS

public static final EventResult PASS

Your listener did nothing, in won't change the result of the event

SUCCESS

public static final EventResult SUCCESS

Cancel the event and success. see the event's documentation

FAIL

public static final EventResult FAIL

Event failed, cancel the further processing, see the event's documentation

CONSUME

public static final EventResult CONSUME

Cancel the event, then does nothing. sometimes the same as SUCCESS

Method Details

values

public static EventResult[] 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 EventResult 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