FSMContext7 (SMC library 7.1.0 API)

java.lang.Object
- statemap.FSMContext7

All Implemented Interfaces:

Serializable
```
public abstract class FSMContext7
extends Object
implements Serializable
```
Base class for all SMC-generated application context classes. This class stores the FSM name, current and previous states, the state stack, debugging information and state change listeners.

Author:

Charles Rapp

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_NAME` Default state and transition name is "Default".
`protected static int`	`DEFAULT_TRANSITION_ID` The default transition identifier is zero.
`protected static String`	`ENTRY_NAME` The state entry method name is: "<map>_<state>__Entry_".
`protected static String`	`EXIT_NAME` The state exit method name is: "<map>_<state>__Exit_".
`protected boolean`	`mDebugFlag` When this flag is set to `true`, this class will print out debug messages.
`protected PrintStream`	`mDebugStream` Write debug output to this stream.
`protected String`	`mName` The FSM name.
`protected State7`	`mPreviousState` Stores which state a transition left.
`protected State7`	`mState` The current state.
`protected Deque<State7>`	`mStateStack` This stack is used to store the current state when a push transition is taken.
`protected String`	`mTransition` The current transition name.
`protected static MethodType`	`NO_ARGS_TYPE` The method signature for state entry, exit actions is: `void <method name>()`.
`protected static String`	`STATE_NAME_FORMAT` The state entry method name is: "<map>_<state>".
`static String`	`STATE_PROPERTY` The state change property name.
`protected static String`	`SYSTEM_DEFAULT` The ultimate system default transition method is "defaultTransition".
`protected static String`	`TRANSITION_NAME_FORMAT` The state exit method name is: "<map>_<state>_<transition>".

Constructor Summary

Constructors
Modifier Constructor and Description

protected FSMContext7(State7 initState)
Creates a finite state machine context for the given initial state.

Constructors
Modifier	Constructor and Description
`protected`	`FSMContext7(State7 initState)` Creates a finite state machine context for the given initial state.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStateChangeListener(PropertyChangeListener listener)` Adds a PropertyChangeListener to the listener list.
`void`	`clearState()` Places the current state into the previous state sets the current state to `null`.
`protected void`	`defaultTransition()` The default Default state/Default transition definition is to throw a `TransitionUndefinedException` which contains the current state and current transition in the detailed message.
`void`	`emptyStateStack()` Empties the state stack.
`void`	`enterStartState()` Executes the current state entry action.
`protected void`	`enterState()` Executes the current state entry action, if defined.
`protected abstract void`	`executeAction(MethodHandle mh)` Executes the state entry or exit action.
`protected void`	`exitState()` Executes the current state exit action, if defined.
`boolean`	`getDebugFlag()` When debug is set to `true`, the state machine will print messages to the console.
`PrintStream`	`getDebugStream()` Writes the debug output to this stream.
`String`	`getName()` Returns the FSM name.
`State7`	`getPreviousState()` If this FSM is in transition, then returns the previous state which the last transition left.
`State7`	`getState()` Returns the current state.
`String`	`getTransition()` If this FSM is in transition, then returns the transition name.
`boolean`	`isInTransition()` Returns `true` if this FSM is in a transition and `false` otherwise.
`protected static MethodHandle`	`lookupMethod(MethodHandles.Lookup lookup, Class<?> clazz, String name, MethodType mt)` Returns the virtual method handle found by `lookup` using the given parameters.
`protected static TransitionHandle`	`lookupTransition(MethodHandles.Lookup lookup, Class<?> clazz, String mapName, String stateName, String transName, MethodType methodType)` Returns the transition method handle for the given map, state, transition name, and transition method signature.
`void`	`popState()` Sets the previous state to the current state and pops the top state off the stack and places it into the current state.
`void`	`pushState(State7 state)` Pushes the current state on top of the state stack and sets the current state to `state`.
`void`	`removeStateChangeListener(PropertyChangeListener listener)` Removes a PropertyChangeListener for the state change property.
`void`	`setDebugFlag(boolean flag)` Turns debug output on if `flag` is `true` and off if `flag` is `false`.
`void`	`setDebugStream(PrintStream stream)` Sets the debug output stream to the given value.
`void`	`setName(String name)` Sets the FSM name.
`void`	`setState(State7 state)` Sets the current state to the given value.
`protected String`	`stateName()` Returns the name of the current state or previous state if in transition.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATE_PROPERTY
```
public static final String STATE_PROPERTY
```
    The state change property name.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRANSITION_ID
```
protected static final int DEFAULT_TRANSITION_ID
```
    The default transition identifier is zero.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NAME
```
protected static final String DEFAULT_NAME
```
    Default state and transition name is "Default".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_DEFAULT
```
protected static final String SYSTEM_DEFAULT
```
    The ultimate system default transition method is "defaultTransition".
    
    See Also:
    
    Constant Field Values
  - STATE_NAME_FORMAT
```
protected static final String STATE_NAME_FORMAT
```
    The state entry method name is: "<map>_<state>".
    
    See Also:
    
    Constant Field Values
  - ENTRY_NAME
```
protected static final String ENTRY_NAME
```
    The state entry method name is: "<map>_<state>__Entry_".
    
    See Also:
    
    Constant Field Values
  - EXIT_NAME
```
protected static final String EXIT_NAME
```
    The state exit method name is: "<map>_<state>__Exit_".
    
    See Also:
    
    Constant Field Values
  - TRANSITION_NAME_FORMAT
```
protected static final String TRANSITION_NAME_FORMAT
```
    The state exit method name is: "<map>_<state>_<transition>".
    
    See Also:
    
    Constant Field Values
  - NO_ARGS_TYPE
```
protected static final MethodType NO_ARGS_TYPE
```
    The method signature for state entry, exit actions is: void <method name>().
  - mName
```
protected transient String mName
```
    The FSM name.
  - mState
```
protected transient State7 mState
```
    The current state. Will be null while in transition.
  - mTransition
```
protected transient String mTransition
```
    The current transition name. Used for debugging purposes. Will be en empty string when not in transition.
  - mPreviousState
```
protected transient State7 mPreviousState
```
    Stores which state a transition left. May be null.
  - mStateStack
```
protected transient Deque<State7> mStateStack
```
    This stack is used to store the current state when a push transition is taken.
  - mDebugFlag
```
protected transient boolean mDebugFlag
```
    When this flag is set to true, this class will print out debug messages.
  - mDebugStream
```
protected transient PrintStream mDebugStream
```
    Write debug output to this stream.
- Constructor Detail
  - FSMContext7
```
protected FSMContext7(State7 initState)
```
    Creates a finite state machine context for the given initial state.
    
    Parameters:
    
    initState - the finite state machine's start state.
- Method Detail
  - executeAction
```
protected abstract void executeAction(MethodHandle mh)
```
    Executes the state entry or exit action. Because the entry and exit methods are defined in the subclass and MethodHandle.invokeExact(Object[]) requires that the method be invoked against the subclass instance, the entry/exit method handle is passed to the subclass for execution.
    
    Parameters:
    
    mh - execute this method handle.
    
    See Also:
    
    enterStartState(), enterState(), exitState()
  - getName
```
public String getName()
```
    Returns the FSM name.
    
    Returns:
    
    the FSM name.
  - getDebugFlag
```
public boolean getDebugFlag()
```
    When debug is set to true, the state machine will print messages to the console.
    
    Returns:
    
    true if debug output is generated.
  - getDebugStream
```
public PrintStream getDebugStream()
```
    Writes the debug output to this stream.
    
    Returns:
    
    the debug output stream.
  - isInTransition
```
public boolean isInTransition()
```
    Returns true if this FSM is in a transition and false otherwise.
    
    Returns:
    
    true if this FSM is in a transition and false otherwise.
  - getState
```
public State7 getState()
                throws StateUndefinedException
```
    Returns the current state.
    
    Returns:
    
    current state.
    
    Throws:
    
    StateUndefinedException - if the FSM is in transition.
  - getPreviousState
```
public State7 getPreviousState()
                        throws NullPointerException
```
    If this FSM is in transition, then returns the previous state which the last transition left.
    
    Returns:
    
    the previous state which the current transition left. May return null.
    
    Throws:
    
    NullPointerException
  - getTransition
```
public String getTransition()
```
    If this FSM is in transition, then returns the transition name. If not in transition, then returns an empty string.
    
    Returns:
    
    the current transition name.
  - setName
```
public void setName(String name)
```
    Sets the FSM name.
    
    Parameters:
    
    name - The finite state machine name.
  - setDebugFlag
```
public void setDebugFlag(boolean flag)
```
    Turns debug output on if flag is true and off if flag is false.
    
    Parameters:
    
    flag - true to turn debuggin on and false to turn debugging off.
  - setDebugStream
```
public void setDebugStream(PrintStream stream)
```
    Sets the debug output stream to the given value.
    
    Parameters:
    
    stream - The debug output stream.
  - setState
```
public void setState(State7 state)
```
    Sets the current state to the given value.
    
    Parameters:
    
    state - The current state.
  - clearState
```
public void clearState()
```
    Places the current state into the previous state sets the current state to null.
  - pushState
```
public void pushState(State7 state)
```
    Pushes the current state on top of the state stack and sets the current state to state.
    
    Parameters:
    
    state - The new current state.
    
    Throws:
    
    NullPointerException - if state is null.
  - popState
```
public void popState()
              throws EmptyStackException
```
    Sets the previous state to the current state and pops the top state off the stack and places it into the current state.
    
    Throws:
    
    EmptyStackException - if the state stack is empty.
  - emptyStateStack
```
public void emptyStateStack()
```
    Empties the state stack.
  - enterStartState
```
public void enterStartState()
```
    Executes the current state entry action. This method is redundant with enterState() and is provided for backward compatibility.
    
    See Also:
    
    enterState()
  - addStateChangeListener
```
public void addStateChangeListener(PropertyChangeListener listener)
```
    Adds a PropertyChangeListener to the listener list. The listener is registered for state property changes only. The same listener may be added more than once. For each state change, the listener will be invoked the number of times it was added. If listener is null, no exception is thrown and no action is taken.
    
    Parameters:
    
    listener - The PropertyChangeListener to be added.
  - removeStateChangeListener
```
public void removeStateChangeListener(PropertyChangeListener listener)
```
    Removes a PropertyChangeListener for the state change property. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null or was never added, no exception is thrown and no action is taken.
    
    Parameters:
    
    listener - The PropertyChangeListener to be removed.
  - defaultTransition
```
protected void defaultTransition()
```
    The default Default state/Default transition definition is to throw a TransitionUndefinedException which contains the current state and current transition in the detailed message.
  - stateName
```
protected String stateName()
```
    Returns the name of the current state or previous state if in transition. If there is no current or previous state set, then returns "(state unknown)".
    
    Returns:
    
    the current or previous state name.
  - enterState
```
protected void enterState()
```
    Executes the current state entry action, if defined.
  - exitState
```
protected void exitState()
```
    Executes the current state exit action, if defined.
  - lookupMethod
```
protected static MethodHandle lookupMethod(MethodHandles.Lookup lookup,
                                           Class<?> clazz,
                                           String name,
                                           MethodType mt)
```
    Returns the virtual method handle found by lookup using the given parameters. If the lookup fails, then returns null.
    
    Parameters:
    
    lookup - used to retrieve the virtual method handle.
    
    clazz - the method is implemented in this class.
    
    name - the method name.
    
    mt - the method signature.
    
    Returns:
    
    the virtual method handle for the given class, method name, and signature.
  - lookupTransition
```
protected static TransitionHandle lookupTransition(MethodHandles.Lookup lookup,
                                                   Class<?> clazz,
                                                   String mapName,
                                                   String stateName,
                                                   String transName,
                                                   MethodType methodType)
```
    Returns the transition method handle for the given map, state, transition name, and transition method signature. If the method is not found in the current state, then returns the appropriate default transition. The search order is:
    1. <map>::<state>::<transition>(parameters)
    2. <map>::Default::<transition>(parameters)
    3. <map>::<state>::Default()
    4. <map>::Default::Default()
    5. defaultTransition()
    Parameters:
    
    lookup - used to retrieve the virtual method handle.
    
    clazz - the method is implemented in this class.
    
    mapName - the map name.
    
    stateName - the state name.
    
    transName - the transition name.
    
    methodType - the transition method signature.
    
    Returns:
    
    the transition method handle.

Class FSMContext7

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_PROPERTY

DEFAULT_TRANSITION_ID

DEFAULT_NAME

SYSTEM_DEFAULT

STATE_NAME_FORMAT

ENTRY_NAME

EXIT_NAME

TRANSITION_NAME_FORMAT

NO_ARGS_TYPE

mName

mState

mTransition

mPreviousState

mStateStack

mDebugFlag

mDebugStream

Constructor Detail

FSMContext7

Method Detail

executeAction

getName

getDebugFlag

getDebugStream

isInTransition

getState

getPreviousState

getTransition

setName

setDebugFlag

setDebugStream

setState

clearState

pushState

popState

emptyStateStack

enterStartState

addStateChangeListener

removeStateChangeListener

defaultTransition

stateName

enterState

exitState

lookupMethod

lookupTransition