com.github.stefvanschie.inventoryframework

Enum Gui.State

java.lang.Object

java.lang.Enum<Gui.State>

com.github.stefvanschie.inventoryframework.Gui.State

All Implemented Interfaces:

Serializable, Comparable<Gui.State>

Enclosing class:

Gui

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

The gui state

Since:

0.4.0

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static Gui.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Gui.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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:

0.4.0

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:

0.4.0

Method Detail

values

public static Gui.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Gui.State c : Gui.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Gui.State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null