Package adams.flow.core

Enum RatState

java.lang.Object

java.lang.Enum<RatState>

adams.flow.core.RatState

All Implemented Interfaces:

Serializable, Comparable<RatState>

public enum RatState
extends Enum<RatState>

The possible states for a Rat.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
PAUSED
RUNNING

Method Summary

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

PAUSED

public static final RatState PAUSED

RUNNING

public static final RatState RUNNING

Method Detail

values

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

Returns:

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

valueOf

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