Package me.eddie.inventoryguiapi.gui.guis

Enum Class GUIBuilder.GUIStateBehaviour

java.lang.Object

java.lang.Enum<GUIBuilder.GUIStateBehaviour>

me.eddie.inventoryguiapi.gui.guis.GUIBuilder.GUIStateBehaviour

All Implemented Interfaces:

Serializable, Comparable<GUIBuilder.GUIStateBehaviour>, Constable

Enclosing class:

GUIBuilder

public static enum GUIBuilder.GUIStateBehaviour
extends Enum<GUIBuilder.GUIStateBehaviour>

Enum that defines how a GUI's GUIState should be handled

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
BOUND_TO_GUI	This value will mean the default SharedGUI implementation is used, with this implementation the GUIState is bound to the GUI and is persistent.
LOCAL_TO_SESSION	This value will mean the default GUI implementation is used, with this implementation the GUIState is lost when the session ends (GUI closes).

Method Summary

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

LOCAL_TO_SESSION

public static final GUIBuilder.GUIStateBehaviour LOCAL_TO_SESSION

This value will mean the default GUI implementation is used, with this implementation the GUIState is lost when the session ends (GUI closes).

BOUND_TO_GUI

public static final GUIBuilder.GUIStateBehaviour BOUND_TO_GUI

This value will mean the default SharedGUI implementation is used, with this implementation the GUIState is bound to the GUI and is persistent. This means all viewers will see the same GUIState and it persists beyond the GUI closing.

Method Details

values

public static GUIBuilder.GUIStateBehaviour[] 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 GUIBuilder.GUIStateBehaviour 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