org.jeasy.states.core

Class FiniteStateMachineBuilder

java.lang.Object

org.jeasy.states.core.FiniteStateMachineBuilder

public class FiniteStateMachineBuilder
extends Object

FSM builder : this class is the main entry point to build FSM instances. Only states set and initial state are mandatory.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FiniteStateMachineBuilder(Set<State> states, State initialState) Create a new FiniteStateMachineBuilder.

Method Summary

Modifier and Type	Method and Description
FiniteStateMachine	build() Build a FSM instance.
FiniteStateMachineBuilder	registerFinalState(State finalState) Register FSM final state which is not mandatory.
FiniteStateMachineBuilder	registerFinalStates(Set<State> finalStates) Register FSM final states set.
FiniteStateMachineBuilder	registerTransition(Transition transition) Register a transition within FSM transitions set.
FiniteStateMachineBuilder	registerTransitions(Set<Transition> transitions) Register a set of transitions within FSM transitions set.

Methods inherited from class java.lang.Object

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

Constructor Detail

FiniteStateMachineBuilder

public FiniteStateMachineBuilder(Set<State> states,
                                 State initialState)

Create a new FiniteStateMachineBuilder.

Parameters:

states - set of the machine

initialState - of the machine

Method Detail

registerTransition

public FiniteStateMachineBuilder registerTransition(Transition transition)

Register a transition within FSM transitions set. If the transition is not valid, this method may throw an IllegalArgumentException.

Parameters:

transition - the transition to register

Returns:

a configured FSM Builder instance

registerTransitions

public FiniteStateMachineBuilder registerTransitions(Set<Transition> transitions)

Register a set of transitions within FSM transitions set. If a transition is not valid, this method throws an IllegalArgumentException.

Parameters:

transitions - the transitions set to register

Returns:

a configured FSM Builder instance

registerFinalState

public FiniteStateMachineBuilder registerFinalState(State finalState)

Register FSM final state which is not mandatory. Once in final state, the FSM will ignore all incoming events.

Parameters:

finalState - the FSM final state

Returns:

a configured FSM Builder instance

registerFinalStates

public FiniteStateMachineBuilder registerFinalStates(Set<State> finalStates)

Register FSM final states set. Once in final state, the FSM will ignore all incoming events.

Parameters:

finalStates - the FSM final states to register

Returns:

a configured FSM Builder instance

build

public FiniteStateMachine build()

Build a FSM instance. This method checks if FSM definition is valid. If FSM state is not valid, this methods throws an IllegalStateException

Returns:

a configured FSM instance