li.cil.oc.api.util

Enum StateAware.State

java.lang.Object

java.lang.Enum<StateAware.State>

li.cil.oc.api.util.StateAware.State

All Implemented Interfaces:

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

Enclosing interface:

StateAware

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

Possible work states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CanWork Indicates that some work can be performed / energy can be consumed, but that the current state is being idle.
IsWorking Indicates that some work is currently being performed / some energy is currently being consumed.
None

Method Summary

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

None

public static final StateAware.State None

CanWork

public static final StateAware.State CanWork

Indicates that some work can be performed / energy can be consumed, but that the current state is being idle.

IsWorking

public static final StateAware.State IsWorking

Indicates that some work is currently being performed / some energy is currently being consumed.

Method Detail

values

public static StateAware.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 (StateAware.State c : StateAware.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 StateAware.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