com.github.pnavais.machine.builder

Class StateMachineBuilder

java.lang.Object

com.github.pnavais.machine.builder.StateMachineBuilder

public class StateMachineBuilder
extends Object

A simple builder for StateMachine instances

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateMachineBuilder.FilterBuilder Internal builder class to begin the definition of a new filter.
static class	StateMachineBuilder.FromBuilder Internal builder class to begin the definition of a new transition.
static class	StateMachineBuilder.OnBuilder Internal builder class to optionally add message filtering before ending the definition of a new transition.
static class	StateMachineBuilder.ToBuilder Internal builder class to end the definition of a new transition.

Constructor Summary

Constructors

Constructor and Description
StateMachineBuilder() The constructor

Method Summary

Modifier and Type	Method and Description
StateMachineBuilder	add(@NonNull StateTransition transition) Adds the given transition to the transition map.
StateMachineBuilder.FilterBuilder	arriving(State state) Initializes the builder to add a global filter for arrivals for the given state.
StateMachineBuilder.FilterBuilder	arriving(String stateName) Initializes the builder to add a global filter for arrivals for the state specified by the given name.
StateMachine	build() Creates and initializes a State Machine from the transition map currently built.
StateMachineBuilder.FromBuilder	from(State srcState) Starts the building of a new transition by specifying the source state.
StateMachineBuilder.FromBuilder	from(String srcStateName) Starts the building of a new transition by specifying the source state's name
StateTransitionMap	getTransitionMap() Retrieves the current transition map.
StateMachineBuilder.FilterBuilder	leaving(State state) Initializes the builder to add a global filter for departures for the given state.
StateMachineBuilder.FilterBuilder	leaving(String stateName) Initializes the builder to add a global filter for departures for the state specified by the given name.
StateMachineBuilder.ToBuilder	selfLoop(State state) Starts a definition of a loop for the given state
StateMachineBuilder.ToBuilder	selfLoop(String stateName) Starts the definition of a loop for the given state's name

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineBuilder

public StateMachineBuilder()

The constructor

Method Detail

from

public StateMachineBuilder.FromBuilder from(String srcStateName)

Starts the building of a new transition by specifying the source state's name

Parameters:

srcStateName - the source state's name

Returns:

the FromBuilder builder clause

from

public StateMachineBuilder.FromBuilder from(State srcState)

Starts the building of a new transition by specifying the source state.

Parameters:

srcState - the source state

Returns:

the FromBuilder builder clause

add

public StateMachineBuilder add(@NonNull
                               @NonNull StateTransition transition)

Adds the given transition to the transition map.

Parameters:

transition - the transition to add

Returns:

the builder transitionMap for chaining purposes.

selfLoop

public StateMachineBuilder.ToBuilder selfLoop(String stateName)

Starts the definition of a loop for the given state's name

Parameters:

stateName - the state name

Returns:

the ToBuilder builder clause

selfLoop

public StateMachineBuilder.ToBuilder selfLoop(State state)

Starts a definition of a loop for the given state

Parameters:

state - the state

Returns:

the ToBuilder builder clause

leaving

public StateMachineBuilder.FilterBuilder leaving(String stateName)

Initializes the builder to add a global filter for departures for the state specified by the given name.

Parameters:

stateName - the state name

Returns:

the filter builder

leaving

public StateMachineBuilder.FilterBuilder leaving(State state)

Initializes the builder to add a global filter for departures for the given state.

Parameters:

state - the state

Returns:

the filter builder

arriving

public StateMachineBuilder.FilterBuilder arriving(String stateName)

Initializes the builder to add a global filter for arrivals for the state specified by the given name.

Parameters:

stateName - the state name

Returns:

the filter builder

arriving

public StateMachineBuilder.FilterBuilder arriving(State state)

Initializes the builder to add a global filter for arrivals for the given state.

Parameters:

state - the state

Returns:

the filter builder

build

public StateMachine build()

Creates and initializes a State Machine from the transition map currently built.

Returns:

the new state machine initialized with the current transitions.

getTransitionMap

public StateTransitionMap getTransitionMap()

Retrieves the current transition map.

Returns:

the transition map