com.kangirigungi.jstatemachine

Interface IStateMachine<StateId,Event>

public interface IStateMachine<StateId,Event>

Interface for a state machine. It represents a working state machine. Use the processEvent method to supply the state machine with events. The action callbacks are called automatically from within this method.

Do not derive directly from this class. Use StateMachineBuilder.create() to acquire an implementation of this interface.

Method Summary

Methods

Modifier and Type	Method and Description
StateId	getCurrentState() Get the current state of the top level state machine.
java.util.List<StateId>	getCurrentStates() Get a list of states that represents the current state of the state machine and all its substates.
void	processEvent(Event event) Process one event of the state machine.

Method Detail

getCurrentState

StateId getCurrentState()

Get the current state of the top level state machine.

getCurrentStates

java.util.List<StateId> getCurrentStates()

Get a list of states that represents the current state of the state machine and all its substates. The first element of the result is the state of the top level state machine, and the last element is the state of the deepest substate.

processEvent

void processEvent(Event event)

Process one event of the state machine. Make any necessary state changes and call the action callbacks (transition, entry and exit actions).

Note: Do not call this method from within an action callback.

Parameters:

event - The event to be processed.

Throws:

InTransitionException - If a callback is called while a transition is taking place.