Package dev.itsharshxd.zentrix.api.scenario.hook

Enum Class HookOutcome.Kind

java.lang.Object

java.lang.Enum<HookOutcome.Kind>

dev.itsharshxd.zentrix.api.scenario.hook.HookOutcome.Kind

All Implemented Interfaces:

Serializable, Comparable<HookOutcome.Kind>, Constable

Enclosing class:

HookOutcome<V>

public static enum HookOutcome.Kind
extends Enum<HookOutcome.Kind>

The three answers a handler can give.

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	Suppress the behaviour entirely.
PASS	Defer to the remaining scenarios and, finally, to Zentrix.
REPLACE	Take over the decision with a substituted value.

Method Summary

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

Defer to the remaining scenarios and, finally, to Zentrix.

REPLACE

public static final HookOutcome.Kind REPLACE

Take over the decision with a substituted value.

CANCEL

public static final HookOutcome.Kind CANCEL

Suppress the behaviour entirely.

Method Details

values

public static HookOutcome.Kind[] 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 HookOutcome.Kind 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