Enum Class ActionResult

java.lang.Object

java.lang.Enum<ActionResult>

com.github.darksoulq.abyssallib.server.event.ActionResult

All Implemented Interfaces:

Serializable, Comparable<ActionResult>, Constable

public enum ActionResult
extends Enum<ActionResult>

Represents the result of an event or action handler.

This is used to indicate whether the default/original behavior should proceed or be cancelled/interrupted.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCEL	Indicates that the action or event should be cancelled.
PASS	Indicates that the original/default logic should continue to run.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PASS

public static final ActionResult PASS

Indicates that the original/default logic should continue to run.

This does not block any following operations and lets the event propagate normally.

CANCEL

public static final ActionResult CANCEL

Indicates that the action or event should be cancelled.

No further logic (including default behavior) should be executed.

Method Details

values

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