Modifier and Type	Class and Description
public static enum	State.Kind Kind of state.

Modifier and Type	Field and Description
private Action	defaultAction
private State	defaultNextState
private Map<Input, Set<Transition>>	inputMap
private Map<Input, Set<Transition>>	inputMapImage
private Map<Input, Set<Transition>>	inputMapRangeImage
private State.Kind	kind

Access	Constructor and Description
public	State(String name)
public	State(String name, State.Kind kind)
public	State(Set<State> states, String name)
public	State(Set<State> states, String name, State.Kind kind)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addTransition(Input in, Transition ga)
public Action	getDefaultAction() Get the default transition action that is used if the default next state is used.
public State	getDefaultNextState() Return the default next state for this state.
public Map<Input, Set<Transition>>	getInputMap()
public State.Kind	getKind() Return the Kind of this state.
pack-priv Set<Transition>	getTransitions(Input in)
public void	postAction(FSM fsm) Method that defines action that occurs whenever this state is exited, that is, when the state is changed from this state to a new state.
public FSM	preAction(FSM fsm) Method that defines action that occurs whenever this state is entered from a different state.
public State	returnAction(FSM fsm, FSM nestedFSM) If this state has Kind REFERENCE, and its preAction pushes a nested FSM onto the stack, the returnAction method is called after the nested FSM reaches a final state.
pack-priv void	setDefaultAction(Action defaultAction)
pack-priv void	setDefaultNextState(State defaultNextState)

Inherited from org.glassfish.pfl.basic.fsm.NameBase:: getName toString

Field Detail

defaultAction	back to summary
private Action defaultAction

defaultNextState	back to summary
private State defaultNextState

inputMap	back to summary
private Map<Input, Set<Transition>> inputMap

inputMapImage	back to summary
private Map<Input, Set<Transition>> inputMapImage

inputMapRangeImage	back to summary
private Map<Input, Set<Transition>> inputMapRangeImage

kind	back to summary
private State.Kind kind

Constructor Detail

State	back to summary
public State(String name)

State	back to summary
public State(String name, State.Kind kind)

State	back to summary
public State(Set<State> states, String name)

State	back to summary
public State(Set<State> states, String name, State.Kind kind)

Method Detail

addTransition	back to summary
pack-priv void addTransition(Input in, Transition ga)

getDefaultAction	back to summary
public Action getDefaultAction() Get the default transition action that is used if the default next state is used.

getDefaultNextState	back to summary
public State getDefaultNextState() Return the default next state for this state. This is the next state if the input is not found in the action map.

getInputMap	back to summary
public Map<Input, Set<Transition>> getInputMap()

getKind	back to summary
public State.Kind getKind() Return the Kind of this state.

getTransitions	back to summary
pack-priv Set<Transition> getTransitions(Input in)

postAction	back to summary
public void postAction(FSM fsm) Method that defines action that occurs whenever this state is exited, that is, when the state is changed from this state to a new state. Any exceptions except ThreadDeath thrown by this method are ignored. This method can be overridden in a state implementation if needed.

postAction

back to summary

public void postAction(FSM fsm)

Method that defines action that occurs whenever this state is exited, that is, when the state is changed from this state to a new state.

Any exceptions except ThreadDeath thrown by this method are ignored. This method can be overridden in a state implementation if needed.

preAction	back to summary
public FSM preAction(FSM fsm) Method that defines action that occurs whenever this state is entered from a different state. preAction is not called on a self-transition. If preAction returns a non-null result, the result becomes the current FSM. Any exceptions except ThreadDeath thrown by this method are ignored. This method can be overridden in a state implementation if needed.

preAction

back to summary

public FSM preAction(FSM fsm)

Method that defines action that occurs whenever this state is entered from a different state. preAction is not called on a self-transition. If preAction returns a non-null result, the result becomes the current FSM.

Any exceptions except ThreadDeath thrown by this method are ignored. This method can be overridden in a state implementation if needed.

returnAction	back to summary
public State returnAction(FSM fsm, FSM nestedFSM) If this state has Kind REFERENCE, and its preAction pushes a nested FSM onto the stack, the returnAction method is called after the nested FSM reaches a final state. The nested FSM is passed into nestedFSM, and fsm is the new top of stack, which is the FSM that was active when the preAction was called. The result is the new state that will be assumed after this REFERENCE's state postAction method is called. If the returnAction method sets the state to a new state, the postAction method is called as usuTransition. Any exceptions except ThreadDeath thrown by this method are ignored. This method can be overridden in a state implementation if needed.

returnAction

back to summary

public State returnAction(FSM fsm, FSM nestedFSM)

If this state has Kind REFERENCE, and its preAction pushes a nested FSM onto the stack, the returnAction method is called after the nested FSM reaches a final state. The nested FSM is passed into nestedFSM, and fsm is the new top of stack, which is the FSM that was active when the preAction was called. The result is the new state that will be assumed after this REFERENCE's state postAction method is called.

If the returnAction method sets the state to a new state, the postAction method is called as usuTransition.

Any exceptions except ThreadDeath thrown by this method are ignored. This method can be overridden in a state implementation if needed.

setDefaultAction	back to summary
pack-priv void setDefaultAction(Action defaultAction)

setDefaultNextState	back to summary
pack-priv void setDefaultNextState(State defaultNextState)

org.glassfish.pfl.basic.fsm back to summary

public final Enum State.Kind

Class Inheritance

extends Enum<State.Kind>

java.lang.Object
java.lang.Enum
org.glassfish.pfl.basic.fsm.State.Kind

Kind of state. A StateEngine must have at least one INITIAL state. An FSM may only be created in an INITIAL state. It may have 0 or more FINAL states. A FINAL state may only be the target of a state transition. If a state engine is used as a submachine, it must have at least one final state.

A REFERENCE state is handled specially. It is used to call into another state engine much as a normal subroutine call. A REFERENCE state (like a FINAL state) may not have any transitions that leave it. The returnAction method on a REFERENCE state is responsible for setting the state directly.

Field Summary

Modifier and Type	Field and Description
public static final State.Kind	FINAL
public static final State.Kind	INITIAL
public static final State.Kind	NORMAL
public static final State.Kind	REFERENCE

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static State.Kind	valueOf(String name)
public static State.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FINAL	back to summary
public static final State.Kind FINAL

INITIAL	back to summary
public static final State.Kind INITIAL

NORMAL	back to summary
public static final State.Kind NORMAL

REFERENCE	back to summary
public static final State.Kind REFERENCE

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static State.Kind valueOf(String name)

values	back to summary
public static State.Kind[] values()

public Class State

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum State.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail