com.nsqre.insquare.Square

Enum SquareState

java.lang.Object

java.lang.Enum<SquareState>

com.nsqre.insquare.Square.SquareState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SquareState>

public enum SquareState
extends java.lang.Enum<SquareState>

SquareState is the enumerator that represents the concept of State of a square. A square can be in an asleep state if there is no activity, awoken state if there is a light activity, caffeinated state if there is an intense activity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASLEEP
AWOKEN
CAFFEINATED

Method Summary

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

AWOKEN

public static final SquareState AWOKEN

ASLEEP

public static final SquareState ASLEEP

CAFFEINATED

public static final SquareState CAFFEINATED

Method Detail

values

public static SquareState[] 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 (SquareState c : SquareState.values())
    System.out.println(c);

Returns:

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

valueOf

public static SquareState 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