Package com.planet_ink.coffee_mud.Areas.interfaces

Enum Area.State

java.lang.Object

java.lang.Enum<Area.State>

com.planet_ink.coffee_mud.Areas.interfaces.Area.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Area.State>

Enclosing interface:

Area

public static enum Area.State
extends java.lang.Enum<Area.State>

State flag for areas.

See Also:

Area.getAreaState()

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE
FROZEN	Area is threaded, and running, but not mobile
PASSIVE	Area is mobile, threaded, and running
STOPPED	Area is thread, but not running or mobile

Method Summary

Modifier and Type	Method	Description
static Area.State	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Area.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

ACTIVE

public static final Area.State ACTIVE

PASSIVE

public static final Area.State PASSIVE

Area is mobile, threaded, and running

FROZEN

public static final Area.State FROZEN

Area is threaded, and running, but not mobile

STOPPED

public static final Area.State STOPPED

Area is thread, but not running or mobile

Method Detail

values

public static Area.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 (Area.State c : Area.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 Area.State valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null