org.squirrelframework.foundation.fsm
Enum StateMachineStatus

java.lang.Object
  java.lang.Enum<StateMachineStatus>
      org.squirrelframework.foundation.fsm.StateMachineStatus

All Implemented Interfaces:

Serializable, Comparable<StateMachineStatus>

public enum StateMachineStatus
extends Enum<StateMachineStatus>

Indicate state machine running status

Author:

Henry.He

Enum Constant Summary

BUSY
State machine is processing events

ERROR
State machine is in error state

IDLE
State machine is started but not processing any event

INITIALIZED
State machine is instantiated but not started

TERMINATED
State machine is terminated

Method Summary

static StateMachineStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static StateMachineStatus[]	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

INITIALIZED

public static final StateMachineStatus INITIALIZED

State machine is instantiated but not started

IDLE

public static final StateMachineStatus IDLE

State machine is started but not processing any event

BUSY

public static final StateMachineStatus BUSY

State machine is processing events

TERMINATED

public static final StateMachineStatus TERMINATED

State machine is terminated

ERROR

public static final StateMachineStatus ERROR

State machine is in error state

Method Detail

values

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

Returns:

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

valueOf

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