org.squirrelframework.foundation.fsm

Enum StateCompositeType

java.lang.Object

java.lang.Enum<StateCompositeType>

org.squirrelframework.foundation.fsm.StateCompositeType

All Implemented Interfaces:

Serializable, Comparable<StateCompositeType>

public enum StateCompositeType
extends Enum<StateCompositeType>

Composite state is defined as state that has substates (nested states). Substates could be sequential (disjoint) or parallel (orthogonal). StateCompositeType defines the type of composite state.

Author:

Henry.He

Enum Constant Summary

Enum Constants

Enum Constant and Description
PARALLEL The child states are parallel.
SEQUENTIAL The child states are mutually exclusive and an initial state must be set by calling MutableState.setInitialState()

Method Summary

Methods

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

SEQUENTIAL

public static final StateCompositeType SEQUENTIAL

The child states are mutually exclusive and an initial state must be set by calling MutableState.setInitialState()

PARALLEL

public static final StateCompositeType PARALLEL

The child states are parallel. When the parent state is entered, all its child states are entered in parallel.

Method Detail

values

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

Returns:

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

valueOf

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