pl.edu.agh.age.util.fsm

Class StateMachineServiceBuilder<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>

java.lang.Object

pl.edu.agh.age.util.fsm.StateMachineServiceBuilder<S,E>

Type Parameters:

S - the states enumeration.

E - the events enumeration.

public final class StateMachineServiceBuilder<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
extends java.lang.Object

A builder of DefaultStateMachineService instances. It offers a simple, flexible interface for creation of state machines.

Initially, a user is required to provide at least:

• an enumeration of states,
• an enumeration of transitions,
• an entry state (startWith(S)),
• terminal states (terminateIn(S...)).

Failure to do so results in IllegalStateException when build() is called.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StateMachineServiceBuilder.TransitionBuilder An action builder.
class	StateMachineServiceBuilder.WildcardTransitionBuilder An action builder for state-independent actions.

Field Summary

Fields

Modifier and Type	Field and Description
private @MonotonicNonNull EventBus	eventBus
private java.lang.Class<E>	eventClass
private java.util.function.Consumer<java.lang.Throwable>	exceptionHandler
private S	initialState
private static org.slf4j.Logger	logger
private @MonotonicNonNull java.lang.String	name
private java.lang.Class<S>	stateClass
private boolean	synchronous
private @MonotonicNonNull java.util.EnumSet<S>	terminalStates
private Multimap<S,Transition<S,E>>	transitions
private java.util.EnumMap<E,io.vavr.Tuple2<io.vavr.collection.Set<S>,java.util.function.Consumer<FSM<S,E>>>>	wildcardTransitions

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StateMachineServiceBuilder(java.lang.Class<S> states, java.lang.Class<E> events)

Method Summary

Modifier and Type	Method and Description
StateMachineService<S,E>	build() Builds and returns a new service.
(package private) io.vavr.collection.HashMap<S,State<S,E>>	buildStatesMap()
(package private) @Nullable EventBus	eventBus()
(package private) java.lang.Class<E>	eventClass()
(package private) java.util.function.Consumer<java.lang.Throwable>	exceptionHandler()
StateMachineServiceBuilder.TransitionBuilder	in(S state) Starts the declaration of behaviour when the FSM is at the given state.
StateMachineServiceBuilder.WildcardTransitionBuilder	inAnyState() Starts the declaration of behaviour for the events that are not dependent on states.
(package private) S	initialState()
(package private) boolean	isSynchronous()
(package private) java.lang.String	name()
StateMachineServiceBuilder<S,E>	notifyOn(EventBus eventBus)
StateMachineServiceBuilder<S,E>	startWith(S state) Declares an initial state.
(package private) java.lang.Class<S>	stateClass()
(package private) void	synchronous()
(package private) java.util.EnumSet<S>	terminalStates()
StateMachineServiceBuilder<S,E>	terminateIn(S... states) Indicates which states are terminal states.
(package private) Multimap<S,Transition<S,E>>	transitions()
StateMachineServiceBuilder<S,E>	whenFailedCall(java.util.function.Consumer<java.lang.Throwable> exceptionHandler) Starts the declaration of actions taken when the failure occurs.
(package private) java.util.EnumMap<E,io.vavr.Tuple2<io.vavr.collection.Set<S>,java.util.function.Consumer<FSM<S,E>>>>	wildcardTransitions()
StateMachineServiceBuilder<S,E>	withName(java.lang.String name)
static <S extends java.lang.Enum<S>,E extends java.lang.Enum<E>> StateMachineServiceBuilder<S,E>	withStatesAndEvents(java.lang.Class<S> states, java.lang.Class<E> events)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

transitions

private final Multimap<S extends java.lang.Enum<S>,Transition<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>> transitions

wildcardTransitions

private final java.util.EnumMap<E extends java.lang.Enum<E>,io.vavr.Tuple2<io.vavr.collection.Set<S extends java.lang.Enum<S>>,java.util.function.Consumer<FSM<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>>>> wildcardTransitions

stateClass

private final java.lang.Class<S extends java.lang.Enum<S>> stateClass

eventClass

private final java.lang.Class<E extends java.lang.Enum<E>> eventClass

initialState

private S extends java.lang.Enum<S> initialState

terminalStates

private @MonotonicNonNull java.util.EnumSet<S extends java.lang.Enum<S>> terminalStates

eventBus

private @MonotonicNonNull EventBus eventBus

name

private @MonotonicNonNull java.lang.String name

exceptionHandler

private java.util.function.Consumer<java.lang.Throwable> exceptionHandler

synchronous

private boolean synchronous

Constructor Detail

StateMachineServiceBuilder

private StateMachineServiceBuilder(java.lang.Class<S> states,
                                   java.lang.Class<E> events)

Method Detail

withStatesAndEvents

public static <S extends java.lang.Enum<S>,E extends java.lang.Enum<E>> StateMachineServiceBuilder<S,E> withStatesAndEvents(java.lang.Class<S> states,
                                                                                                                            java.lang.Class<E> events)

withName

@EnsuresNonNull(value="this.name")
public StateMachineServiceBuilder<S,E> withName(java.lang.String name)

in

public StateMachineServiceBuilder.TransitionBuilder in(S state)

Starts the declaration of behaviour when the FSM is at the given state.

Parameters:

state - a state.

Returns:

an action builder.

inAnyState

public StateMachineServiceBuilder.WildcardTransitionBuilder inAnyState()

Starts the declaration of behaviour for the events that are not dependent on states.

Returns:

an action builder.

startWith

@EnsuresNonNull(value="initialState")
public StateMachineServiceBuilder<S,E> startWith(S state)

Declares an initial state.

Parameters:

state - a state.

Returns:

this builder instance.

terminateIn

@EnsuresNonNull(value="terminalStates")
public StateMachineServiceBuilder<S,E> terminateIn(S... states)

Indicates which states are terminal states.

Parameters:

states - states that should be marked as terminal states.

Returns:

this builder instance.

whenFailedCall

public StateMachineServiceBuilder<S,E> whenFailedCall(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)

Starts the declaration of actions taken when the failure occurs.

Returns:

a failure behaviour builder.

notifyOn

@EnsuresNonNull(value="this.eventBus")
public StateMachineServiceBuilder<S,E> notifyOn(EventBus eventBus)

build

public StateMachineService<S,E> build()

Builds and returns a new service.

Returns:

a new StateMachineService.

stateClass

java.lang.Class<S> stateClass()

eventClass

java.lang.Class<E> eventClass()

name

java.lang.String name()

transitions

Multimap<S,Transition<S,E>> transitions()

initialState

S initialState()

terminalStates

java.util.EnumSet<S> terminalStates()

eventBus

@Nullable EventBus eventBus()

wildcardTransitions

java.util.EnumMap<E,io.vavr.Tuple2<io.vavr.collection.Set<S>,java.util.function.Consumer<FSM<S,E>>>> wildcardTransitions()

exceptionHandler

java.util.function.Consumer<java.lang.Throwable> exceptionHandler()

isSynchronous

boolean isSynchronous()

buildStatesMap

io.vavr.collection.HashMap<S,State<S,E>> buildStatesMap()

synchronous

void synchronous()