org.squirrelframework.foundation.fsm
Enum HistoryType

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

All Implemented Interfaces:

Serializable, Comparable<HistoryType>

public enum HistoryType
extends Enum<HistoryType>

Defines the history behavior of a state (on re-entrance of a super state).

Author:

Henry.He

Enum Constant Summary

DEEP
The state enters into its last active sub-state.

NONE
The state enters into its initial sub-state.

SHALLOW
The state enters into its last active sub-state.

Method Summary

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

The state enters into its initial sub-state. The sub-state itself enters its initial sub-state and so on until the innermost nested state is reached. This is the default.

SHALLOW

public static final HistoryType SHALLOW

The state enters into its last active sub-state. The sub-state itself enters its initial sub-state and so on until the innermost nested state is reached.

DEEP

public static final HistoryType DEEP

The state enters into its last active sub-state. The sub-state itself enters into-its last active state and so on until the innermost nested state is reached.

Method Detail

values

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

Returns:

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

valueOf

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