com.github.pnavais.machine.builder

Class StateMachineBuilder.ToBuilder

java.lang.Object

com.github.pnavais.machine.builder.StateMachineBuilder.ToBuilder

Enclosing class:

StateMachineBuilder

public static class StateMachineBuilder.ToBuilder
extends Object

Internal builder class to end the definition of a new transition.

Method Summary

Modifier and Type	Method and Description
StateMachineBuilder.OnBuilder	arriving(@NonNull Function<StateContext,Status> handler) Adds a filtering function for incoming messages in target state of the transition by transforming the current target state into a FilteredState.
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() Finish the current transition and retrieves the current state machine built instance.
StateMachineBuilder.FromBuilder	from(State state) Starts a new transition from the given state using an empty message for the current transition.
StateMachineBuilder.FromBuilder	from(String state) Starts a new transition from the given state name using an empty message for the current transition.
StateMachineBuilder.OnBuilder	leaving(Function<StateContext,Status> handler) Adds a filtering function for triggering messages from origin state of the transition by transforming the current origin state into a FilteredState.
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.OnBuilder	on(Message message) Ends the transition by applying a custom message and retrieving the initial builder.
StateMachineBuilder.OnBuilder	on(String message) Ends the transition by applying the message and retrieving the initial builder.
StateMachineBuilder.ToBuilder	selfLoop(State state) Creates a self loop for the given state.
StateMachineBuilder.ToBuilder	selfLoop(String state) Creates a self loop for the state specified by the given name.

Methods inherited from class java.lang.Object

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

Method Detail

from

public StateMachineBuilder.FromBuilder from(String state)

Starts a new transition from the given state name using an empty message for the current transition.

Parameters:

state - the next source state

Returns:

the from builder

from

public StateMachineBuilder.FromBuilder from(State state)

Starts a new transition from the given state using an empty message for the current transition.

Parameters:

state - the next source state

Returns:

the from builder

selfLoop

public StateMachineBuilder.ToBuilder selfLoop(String state)

Creates a self loop for the state specified by the given name.

Parameters:

state - the state name

Returns:

the from builder

selfLoop

public StateMachineBuilder.ToBuilder selfLoop(State state)

Creates a self loop for the given state.

Parameters:

state - the state

Returns:

the from builder

build

public StateMachine build()

Finish the current transition and retrieves the current state machine built instance.

Returns:

the current state machine instance

on

public StateMachineBuilder.OnBuilder on(String message)

Ends the transition by applying the message and retrieving the initial builder.

Parameters:

message - the string message to add

Returns:

the initial builder

on

public StateMachineBuilder.OnBuilder on(Message message)

Ends the transition by applying a custom message and retrieving the initial builder.

Parameters:

message - the custom message to add

Returns:

the initial builder

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

leaving

public StateMachineBuilder.OnBuilder leaving(Function<StateContext,Status> handler)

Adds a filtering function for triggering messages from origin state of the transition by transforming the current origin state into a FilteredState.

Parameters:

handler - the handler function to execute when leaving origin

Returns:

the StateMachineBuilder.OnBuilder instance

arriving

public StateMachineBuilder.OnBuilder arriving(@NonNull
                                              @NonNull Function<StateContext,Status> handler)

Adds a filtering function for incoming messages in target state of the transition by transforming the current target state into a FilteredState.

Parameters:

handler - the handler function to execute when arriving target

Returns:

the StateMachineBuilder.OnBuilder instance