Package me.despical.inventoryframework

Enum Class Gui.State

java.lang.Object

java.lang.Enum<Gui.State>

me.despical.inventoryframework.Gui.State

All Implemented Interfaces:

Serializable, Comparable<Gui.State>, Constable

Enclosing class:

Gui

public static enum Gui.State
extends Enum<Gui.State>

The gui state

Since:

1.0.1

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
BOTTOM	This signals that the bottom-hal of the Gui is in use and the player's inventory will be cleared and stored
TOP	This signals that only the top-half of the Gui is in use and the player's inventory will stay like it is

Method Summary

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

TOP

public static final Gui.State TOP

This signals that only the top-half of the Gui is in use and the player's inventory will stay like it is

Since:

1.0.1

BOTTOM

public static final Gui.State BOTTOM

This signals that the bottom-hal of the Gui is in use and the player's inventory will be cleared and stored

Since:

1.0.1

Method Details

values

public static Gui.State[] 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 Gui.State 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