com.github.pnavais.machine.builder

Class StateMachineBuilder.OnBuilder

java.lang.Object

com.github.pnavais.machine.builder.StateMachineBuilder.OnBuilder

Enclosing class:

StateMachineBuilder

public static class StateMachineBuilder.OnBuilder
extends Object

Internal builder class to optionally add message filtering before ending 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.
StateMachine	build() Finish the current transition and retrieves the current state machine built instance.
StateMachineBuilder	builder() Retrieves the current State Machine builder
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.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

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

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

builder

public StateMachineBuilder builder()

Retrieves the current State Machine builder

Returns:

the State machine builder