Eclipse ORB Primitive Function Library 5.1.1 · org.glassfish.pfl.basic.fsm.StateEngine

Modifier and Type	Field and Description
private Action	defaultAction
private static Action	emptyAction
private boolean	initializing
private Map<State.Kind, Set<State>>	stateKinds
private Map<State.Kind, Set<State>>	unmodifiableStateKinds

Access	Constructor and Description
private	StateEngine()

Method Summary

Modifier and Type	Method and Description
public StateEngine	add(State oldState, Input input, Guard guard, Action action, State newState) Add a new transition (old,in,guard,act,new) to the state engine.
public StateEngine	add(State oldState, Set<Input> input, Guard guard, Action action, State newState) Repeatedly calls add( State, Input, Guard, Action, State ) for each element of input.
public StateEngine	add(State oldState, Input input, Action action, State newState) Add a transition with a guard that always evaluates to true.
public StateEngine	add(State oldState, Set<Input> input, Action action, State newState) Repeatedly call add( State, Input, Action, State ) for each element of input.
public static StateEngine	create() Create an empty uninitialized state engine.
public void	doIt(Runner runner, Input in, boolean debug) Actually perform a state transition on the FSM on the runner.peek() FSM under Input in.
public void	done() Called after all transitions have been added to the state engine.
private void	dprint(String msg)
private Action	getDefaultAction(State currentState)
private State	getDefaultNextState(State currentState)
private Set<State>	getKindSet(State.Kind kind)
public Set<State>	getStates(State.Kind kind) Return the set of final states for this state engine.
private void	innerDoIt(Runner runner, Input in, boolean debug)
private void	mustBeInitializing()
private void	mustNotBeInitializing()
pack-priv void	performStateTransition(Runner runner, Input in, State nextState, Action action, boolean debug)
public StateEngine	setDefault(State oldState, Action action, State newState) Set the default transition and action for a state.
public StateEngine	setDefault(State oldState, State newState) Equivalent to setDefault( oldState, act, newState ) where act is an action that does nothing.
public StateEngine	setDefault(State oldState) Euaivalent to setDefault( oldState, oldState )
public void	setDefaultAction(Action act) Set the default action used in this state engine.
private void	updateStateMap(State oldState, State newState)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

defaultAction	back to summary
private Action defaultAction

emptyAction	back to summary
private static Action emptyAction

initializing	back to summary
private boolean initializing

stateKinds	back to summary
private Map<State.Kind, Set<State>> stateKinds

unmodifiableStateKinds	back to summary
private Map<State.Kind, Set<State>> unmodifiableStateKinds

StateEngine	back to summary
private StateEngine()

Method Detail

add	back to summary
public StateEngine add(State oldState, Input input, Guard guard, Action action, State newState) Add a new transition (old,in,guard,act,new) to the state engine. Multiple calls to add with the same old and in are permitted, in which case only a transition in which the guard evaluates to true will be taken. If no such transition is enabled, a default will be taken. If more than one transition is enabled, one will be chosen arbitrarily. This method can only be called before done(). An attempt to call it after done() results in an IllegalStateException.

add

back to summary

public StateEngine add(State oldState, Input input, Guard guard, Action action, State newState)

Add a new transition (old,in,guard,act,new) to the state engine. Multiple calls to add with the same old and in are permitted, in which case only a transition in which the guard evaluates to true will be taken. If no such transition is enabled, a default will be taken. If more than one transition is enabled, one will be chosen arbitrarily. This method can only be called before done(). An attempt to call it after done() results in an IllegalStateException.

add	back to summary
public StateEngine add(State oldState, Set<Input> input, Guard guard, Action action, State newState) Repeatedly calls add( State, Input, Guard, Action, State ) for each element of input.

add	back to summary
public StateEngine add(State oldState, Input input, Action action, State newState) Add a transition with a guard that always evaluates to true.

add	back to summary
public StateEngine add(State oldState, Set<Input> input, Action action, State newState) Repeatedly call add( State, Input, Action, State ) for each element of input.

create	back to summary
public static StateEngine create() Create an empty uninitialized state engine.

doIt	back to summary
public void doIt(Runner runner, Input in, boolean debug) Actually perform a state transition on the FSM on the runner.peek() FSM under Input in.

done	back to summary
public void done() Called after all transitions have been added to the state engine. This provides an opportunity for the implementation to optimize its representation before the state engine is used. This method may only be called once. An attempt to call it more than once results in an IllegalStateException. Note that a valid StateEngine must satisfy the following conditions: It must contain exactly one state with Kind INITIAL. No final state may have an outgoing transition. If either of these conditions are violated, done() throws an IllegalStateException.

done

back to summary

public void done()

Called after all transitions have been added to the state engine. This provides an opportunity for the implementation to optimize its representation before the state engine is used. This method may only be called once. An attempt to call it more than once results in an IllegalStateException.

Note that a valid StateEngine must satisfy the following conditions:

It must contain exactly one state with Kind INITIAL.
No final state may have an outgoing transition.

If either of these conditions are violated, done() throws an IllegalStateException.

dprint	back to summary
private void dprint(String msg)

getDefaultAction	back to summary
private Action getDefaultAction(State currentState)

getDefaultNextState	back to summary
private State getDefaultNextState(State currentState)

getKindSet	back to summary
private Set<State> getKindSet(State.Kind kind)

getStates	back to summary
public Set<State> getStates(State.Kind kind) Return the set of final states for this state engine. This may be an empty set.

innerDoIt	back to summary
private void innerDoIt(Runner runner, Input in, boolean debug)

mustBeInitializing	back to summary
private void mustBeInitializing()

mustNotBeInitializing	back to summary
private void mustNotBeInitializing()

performStateTransition	back to summary
pack-priv void performStateTransition(Runner runner, Input in, State nextState, Action action, boolean debug)

setDefault	back to summary
public StateEngine setDefault(State oldState, Action action, State newState) Set the default transition and action for a state. This transition will be used if no more specific transition was defined for the actual input. Repeated calls to this method simply change the default. This method can only be called before done(). An attempt to call it after done() results in an IllegalStateException.

setDefault

back to summary

public StateEngine setDefault(State oldState, Action action, State newState)

Set the default transition and action for a state. This transition will be used if no more specific transition was defined for the actual input. Repeated calls to this method simply change the default. This method can only be called before done(). An attempt to call it after done() results in an IllegalStateException.

setDefault	back to summary
public StateEngine setDefault(State oldState, State newState) Equivalent to setDefault( oldState, act, newState ) where act is an action that does nothing.

setDefault	back to summary
public StateEngine setDefault(State oldState) Euaivalent to setDefault( oldState, oldState )

setDefaultAction	back to summary
public void setDefaultAction(Action act) Set the default action used in this state engine. This is the action that is called whenever there is no applicable transition. Normally this would simply flag an error. This method can only be called before done(). An attempt to call it after done() results in an IllegalStateException.

updateStateMap	back to summary
private void updateStateMap(State oldState, State newState)

public Class StateEngine

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail