org.jeasy.states.api

Interface FiniteStateMachine

public interface FiniteStateMachine

FSM interface. This is the main abstraction for a finite state machine.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Method Summary

Modifier and Type	Method and Description
State	fire(Event event) Fire an event.
State	getCurrentState() Return current FSM state.
Set<State>	getFinalStates() Return FSM final states.
State	getInitialState() Return FSM initial state.
Event	getLastEvent() Return the last triggered event.
Transition	getLastTransition() Return the last transition made.
Set<State>	getStates() Return FSM registered states.
Set<Transition>	getTransitions() Return FSM registered transitions.

Method Detail

getCurrentState

State getCurrentState()

Return current FSM state.

Returns:

current FSM state

getInitialState

State getInitialState()

Return FSM initial state.

Returns:

FSM initial state

getFinalStates

Set<State> getFinalStates()

Return FSM final states.

Returns:

FSM final states

getStates

Set<State> getStates()

Return FSM registered states.

Returns:

FSM registered states

getTransitions

Set<Transition> getTransitions()

Return FSM registered transitions.

Returns:

FSM registered transitions

getLastEvent

Event getLastEvent()

Return the last triggered event.

Returns:

the last triggered event

getLastTransition

Transition getLastTransition()

Return the last transition made.

Returns:

the last transition made

fire

State fire(Event event)
    throws FiniteStateMachineException

Fire an event. According to event type, the FSM will make the right transition.

Parameters:

event - to fire

Returns:

The next FSM state defined by the transition to make

Throws:

FiniteStateMachineException - thrown if an exception occurs during event handling