Package ion.Core

Enum Class Action.State

java.lang.Object

java.lang.Enum<Action.State>

ion.Core.Action.State

All Implemented Interfaces:

Serializable, Comparable<Action.State>, Constable

Enclosing class:

Action<TStartArguments>

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

Represents the possible states of an Action. When in the Running state, an Action raises a Step event for each Update step of the Simulation. Both the Idle and Paused states indicate that an Action is not running but the Pause state usually has some associated progression information.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Idle
Paused
Running

Method Summary

Modifier and Type	Method	Description
static Action.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Action.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Running

public static final Action.State Running

Idle

public static final Action.State Idle

Paused

public static final Action.State Paused

Method Details

values

public static Action.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Action.State valueOf(String name)

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

NullPointerException - if the argument is null