Package org.flasby.util.statemachine

Class StateMachine<State,Event>

java.lang.Object

org.flasby.util.statemachine.StateMachine<State,Event>

public class StateMachine<State,Event>
extends Object

implements a Finite State Machine.

Author:

steve

Field Summary

Fields

Modifier and Type	Field	Description
final BiConsumer<State,Event>	NULL_CONSUMER

Constructor Summary

Constructors

Constructor	Description
StateMachine(State initialState)	creates a new FSM in the defined initialState.
StateMachine(State initialState, BiConsumer<State,Event> monitor)	creates a new FSM in the defined initialState.

Method Summary

Modifier and Type	Method	Description
StateMachine<State,Event>	addGlobalTransition(Event event, State to, BiConsumer<State,Event> enterStateAction)
StateMachine<State,Event>	addGlobalTransition(Event event, State to, BiConsumer<State,Event> enterStateAction, BiConsumer<State,Event> exitStateAction)
StateMachine<State,Event>	addTransition(State from, State to, Event event)
StateMachine<State,Event>	addTransition(State from, State to, Event event, BiConsumer<State,Event> enterStateAction)
StateMachine<State,Event>	addTransition(State from, State to, Event event, BiConsumer<State,Event> enterStateAction, BiConsumer<State,Event> exitStateAction)
void	forceTransition(State state, Event event)
State	getState()
void	process(Event event)	process the event and move from the current state to the next one if a transition is defined for the event.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NULL_CONSUMER

public final BiConsumer<State,Event> NULL_CONSUMER

Constructor Details

StateMachine

public StateMachine(State initialState)

creates a new FSM in the defined initialState.

Parameters:

initialState -

StateMachine

public StateMachine(State initialState,
 BiConsumer<State,Event> monitor)

creates a new FSM in the defined initialState.

Parameters:

initialState -

Method Details

process

public void process(Event event)

process the event and move from the current state to the next one if a transition is defined for the event. If no such transition is found then call handleNoTransition(...) and remain in the current state. If a transition is found the the FSM: - invokes the exitStateAction on the transition if such is defined. - moves to the next state - invokes the enterStateAction on the transition if such is defined.

Parameters:

event - The event to process

addTransition

public StateMachine<State,Event> addTransition(State from,
 State to,
 Event event)

addTransition

public StateMachine<State,Event> addTransition(State from,
 State to,
 Event event,
 BiConsumer<State,Event> enterStateAction)

addTransition

public StateMachine<State,Event> addTransition(State from,
 State to,
 Event event,
 BiConsumer<State,Event> enterStateAction,
 BiConsumer<State,Event> exitStateAction)

addGlobalTransition

public StateMachine<State,Event> addGlobalTransition(Event event,
 State to,
 BiConsumer<State,Event> enterStateAction)

addGlobalTransition

public StateMachine<State,Event> addGlobalTransition(Event event,
 State to,
 BiConsumer<State,Event> enterStateAction,
 BiConsumer<State,Event> exitStateAction)

getState

public State getState()

forceTransition

public void forceTransition(State state,
 Event event)