org.jeasy.states.core

Class TransitionBuilder

java.lang.Object

org.jeasy.states.core.TransitionBuilder

public class TransitionBuilder
extends Object

FSM transition builder : this class should be used to build FSM transition instances:

• Source and target states must be declared in FSM states set.
• Source and target states must be defined (not null)
• Event Type must be defined (not null)
• Event Handler is not mandatory

Author:

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

Constructor Summary

Constructors

Constructor and Description
TransitionBuilder() Create a new TransitionBuilder.

Method Summary

Modifier and Type	Method and Description
Transition	build() Build a transition instance.
<E extends Event> TransitionBuilder	eventHandler(EventHandler<E> eventHandler) Set the event handler of the transition.
TransitionBuilder	eventType(Class<? extends Event> eventType) Set event type upon which the transition should be triggered.
TransitionBuilder	name(String name) Set the name of the transition.
TransitionBuilder	sourceState(State sourceState) Set the source state of the transition.
TransitionBuilder	targetState(State targetState) Set the target state of the transition.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitionBuilder

public TransitionBuilder()

Create a new TransitionBuilder.

Method Detail

name

public TransitionBuilder name(String name)

Set the name of the transition.

Parameters:

name - of the transition

Returns:

FSM transition builder

sourceState

public TransitionBuilder sourceState(State sourceState)

Set the source state of the transition.

Parameters:

sourceState - of the transition

Returns:

FSM transition builder

targetState

public TransitionBuilder targetState(State targetState)

Set the target state of the transition.

Parameters:

targetState - of the transition

Returns:

FSM transition builder

eventType

public TransitionBuilder eventType(Class<? extends Event> eventType)

Set event type upon which the transition should be triggered.

Parameters:

eventType - of the transition

Returns:

FSM transition builder

eventHandler

public <E extends Event> TransitionBuilder eventHandler(EventHandler<E> eventHandler)

Set the event handler of the transition.

Parameters:

eventHandler - of the transition

Returns:

FSM transition builder

build

public Transition build()

Build a transition instance.

Returns:

a transition instance.