com.github.oxo42.stateless4j

Class StateConfiguration<S,T>

java.lang.Object

com.github.oxo42.stateless4j.StateConfiguration<S,T>

public class StateConfiguration<S,T>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StateConfiguration(StateRepresentation<S,T> representation, Func2<S,StateRepresentation<S,T>> lookup)

Method Summary

Modifier and Type	Method and Description
StateConfiguration<S,T>	ignore(T trigger) ignore the specified trigger when in the configured state
StateConfiguration<S,T>	ignoreIf(T trigger, FuncBoolean guard) ignore the specified trigger when in the configured state, if the guard returns true
StateConfiguration<S,T>	onEntry(Action entryAction) Specify an action that will execute when transitioning into the configured state
StateConfiguration<S,T>	onEntry(Action1<Transition<S,T>> entryAction) Specify an action that will execute when transitioning into the configured state
StateConfiguration<S,T>	onEntryFrom(T trigger, Action entryAction) Specify an action that will execute when transitioning into the configured state
StateConfiguration<S,T>	onEntryFrom(T trigger, Action1<Transition<S,T>> entryAction) Specify an action that will execute when transitioning into the configured state
<TArg0> StateConfiguration<S,T>	onEntryFrom(TriggerWithParameters1<TArg0,S,T> trigger, Action1<TArg0> entryAction, java.lang.Class<TArg0> classe0) Specify an action that will execute when transitioning into the configured state
<TArg0> StateConfiguration<S,T>	onEntryFrom(TriggerWithParameters1<TArg0,S,T> trigger, Action2<TArg0,Transition<S,T>> entryAction, java.lang.Class<TArg0> classe0) Specify an action that will execute when transitioning into the configured state
<TArg0,TArg1> StateConfiguration<S,T>	onEntryFrom(TriggerWithParameters2<TArg0,TArg1,S,T> trigger, Action2<TArg0,TArg1> entryAction, java.lang.Class<TArg0> classe0, java.lang.Class<TArg1> classe1) Specify an action that will execute when transitioning into the configured state
<TArg0,TArg1> StateConfiguration<S,T>	onEntryFrom(TriggerWithParameters2<TArg0,TArg1,S,T> trigger, Action3<TArg0,TArg1,Transition<S,T>> entryAction, java.lang.Class<TArg0> classe0, java.lang.Class<TArg1> classe1) Specify an action that will execute when transitioning into the configured state
<TArg0,TArg1,TArg2> StateConfiguration<S,T>	onEntryFrom(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger, Action3<TArg0,TArg1,TArg2> entryAction, java.lang.Class<TArg0> classe0, java.lang.Class<TArg1> classe1, java.lang.Class<TArg2> classe2) Specify an action that will execute when transitioning into the configured state
<TArg0,TArg1,TArg2> StateConfiguration<S,T>	onEntryFrom(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger, Action4<TArg0,TArg1,TArg2,Transition<S,T>> entryAction, java.lang.Class<TArg0> classe0, java.lang.Class<TArg1> classe1, java.lang.Class<TArg2> classe2) Specify an action that will execute when transitioning into the configured state
StateConfiguration<S,T>	onExit(Action exitAction) Specify an action that will execute when transitioning from the configured state
StateConfiguration<S,T>	onExit(Action1<Transition<S,T>> exitAction) Specify an action that will execute when transitioning from the configured state
StateConfiguration<S,T>	permit(T trigger, S destinationState) Accept the specified trigger and transition to the destination state
StateConfiguration<S,T>	permitDynamic(T trigger, Func<S> destinationStateSelector) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
<TArg0> StateConfiguration<S,T>	permitDynamic(TriggerWithParameters1<TArg0,S,T> trigger, Func2<TArg0,S> destinationStateSelector) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
<TArg0,TArg1> StateConfiguration<S,T>	permitDynamic(TriggerWithParameters2<TArg0,TArg1,S,T> trigger, Func3<TArg0,TArg1,S> destinationStateSelector) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
<TArg0,TArg1,TArg2> StateConfiguration<S,T>	permitDynamic(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger, Func4<TArg0,TArg1,TArg2,S> destinationStateSelector) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
StateConfiguration<S,T>	permitDynamicIf(T trigger, Func<S> destinationStateSelector, FuncBoolean guard) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
<TArg0> StateConfiguration<S,T>	permitDynamicIf(TriggerWithParameters1<TArg0,S,T> trigger, Func2<TArg0,S> destinationStateSelector, FuncBoolean guard) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
<TArg0,TArg1> StateConfiguration<S,T>	permitDynamicIf(TriggerWithParameters2<TArg0,TArg1,S,T> trigger, Func3<TArg0,TArg1,S> destinationStateSelector, FuncBoolean guard) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
<TArg0,TArg1,TArg2> StateConfiguration<S,T>	permitDynamicIf(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger, Func4<TArg0,TArg1,TArg2,S> destinationStateSelector, FuncBoolean guard) Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function
StateConfiguration<S,T>	permitIf(T trigger, S destinationState, FuncBoolean guard) Accept the specified trigger and transition to the destination state
StateConfiguration<S,T>	permitReentry(T trigger) Accept the specified trigger, execute exit actions and re-execute entry actions.
StateConfiguration<S,T>	permitReentryIf(T trigger, FuncBoolean guard) Accept the specified trigger, execute exit actions and re-execute entry actions.
StateConfiguration<S,T>	substateOf(S superstate) Sets the superstate that the configured state is a substate of

Methods inherited from class java.lang.Object

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

Constructor Detail

StateConfiguration

public StateConfiguration(StateRepresentation<S,T> representation,
                          Func2<S,StateRepresentation<S,T>> lookup)

Method Detail

permit

public StateConfiguration<S,T> permit(T trigger,
                                      S destinationState)

Accept the specified trigger and transition to the destination state

Parameters:

trigger - The accepted trigger

destinationState - The state that the trigger will cause a transition to

Returns:

The reciever

permitIf

public StateConfiguration<S,T> permitIf(T trigger,
                                        S destinationState,
                                        FuncBoolean guard)

Accept the specified trigger and transition to the destination state

Parameters:

trigger - The accepted trigger

destinationState - The state that the trigger will cause a transition to

guard - Function that must return true in order for the trigger to be accepted

Returns:

The reciever

permitReentry

public StateConfiguration<S,T> permitReentry(T trigger)

Accept the specified trigger, execute exit actions and re-execute entry actions. Reentry behaves as though the configured state transitions to an identical sibling state

Applies to the current state only. Will not re-execute superstate actions, or cause actions to execute transitioning between super- and sub-states

Parameters:

trigger - The accepted trigger

Returns:

The reciever

permitReentryIf

public StateConfiguration<S,T> permitReentryIf(T trigger,
                                               FuncBoolean guard)

Accept the specified trigger, execute exit actions and re-execute entry actions. Reentry behaves as though the configured state transitions to an identical sibling state

Applies to the current state only. Will not re-execute superstate actions, or cause actions to execute transitioning between super- and sub-states

Parameters:

trigger - The accepted trigger

guard - Function that must return true in order for the trigger to be accepted

Returns:

The reciever

ignore

public StateConfiguration<S,T> ignore(T trigger)

ignore the specified trigger when in the configured state

Parameters:

trigger - The trigger to ignore

Returns:

The receiver

ignoreIf

public StateConfiguration<S,T> ignoreIf(T trigger,
                                        FuncBoolean guard)

ignore the specified trigger when in the configured state, if the guard returns true

Parameters:

trigger - The trigger to ignore

guard - Function that must return true in order for the trigger to be ignored

Returns:

The receiver

onEntry

public StateConfiguration<S,T> onEntry(Action entryAction)

Specify an action that will execute when transitioning into the configured state

Parameters:

entryAction - Action to execute

Returns:

The receiver

onEntry

public StateConfiguration<S,T> onEntry(Action1<Transition<S,T>> entryAction)

Specify an action that will execute when transitioning into the configured state

Parameters:

entryAction - Action to execute, providing details of the transition

Returns:

The receiver

onEntryFrom

public StateConfiguration<S,T> onEntryFrom(T trigger,
                                           Action entryAction)

Specify an action that will execute when transitioning into the configured state

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute

Returns:

The receiver

onEntryFrom

public StateConfiguration<S,T> onEntryFrom(T trigger,
                                           Action1<Transition<S,T>> entryAction)

Specify an action that will execute when transitioning into the configured state

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

Returns:

The receiver

onEntryFrom

public <TArg0> StateConfiguration<S,T> onEntryFrom(TriggerWithParameters1<TArg0,S,T> trigger,
                                                   Action1<TArg0> entryAction,
                                                   java.lang.Class<TArg0> classe0)

Specify an action that will execute when transitioning into the configured state

Type Parameters:

TArg0 - Type of the first trigger argument

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

classe0 - Class argument

Returns:

The receiver

onEntryFrom

public <TArg0> StateConfiguration<S,T> onEntryFrom(TriggerWithParameters1<TArg0,S,T> trigger,
                                                   Action2<TArg0,Transition<S,T>> entryAction,
                                                   java.lang.Class<TArg0> classe0)

Specify an action that will execute when transitioning into the configured state

Type Parameters:

TArg0 - Type of the first trigger argument

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

classe0 - Class argument

Returns:

The receiver

onEntryFrom

public <TArg0,TArg1> StateConfiguration<S,T> onEntryFrom(TriggerWithParameters2<TArg0,TArg1,S,T> trigger,
                                                         Action2<TArg0,TArg1> entryAction,
                                                         java.lang.Class<TArg0> classe0,
                                                         java.lang.Class<TArg1> classe1)

Specify an action that will execute when transitioning into the configured state

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

classe0 - Class argument

classe1 - Class argument

Returns:

The receiver

onEntryFrom

public <TArg0,TArg1> StateConfiguration<S,T> onEntryFrom(TriggerWithParameters2<TArg0,TArg1,S,T> trigger,
                                                         Action3<TArg0,TArg1,Transition<S,T>> entryAction,
                                                         java.lang.Class<TArg0> classe0,
                                                         java.lang.Class<TArg1> classe1)

Specify an action that will execute when transitioning into the configured state

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

classe0 - Class argument

classe1 - Class argument

Returns:

The receiver

onEntryFrom

public <TArg0,TArg1,TArg2> StateConfiguration<S,T> onEntryFrom(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger,
                                                               Action3<TArg0,TArg1,TArg2> entryAction,
                                                               java.lang.Class<TArg0> classe0,
                                                               java.lang.Class<TArg1> classe1,
                                                               java.lang.Class<TArg2> classe2)

Specify an action that will execute when transitioning into the configured state

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

TArg2 - Type of the third trigger argument

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

classe0 - Class argument

classe1 - Class argument

classe2 - Class argument

Returns:

The receiver

onEntryFrom

public <TArg0,TArg1,TArg2> StateConfiguration<S,T> onEntryFrom(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger,
                                                               Action4<TArg0,TArg1,TArg2,Transition<S,T>> entryAction,
                                                               java.lang.Class<TArg0> classe0,
                                                               java.lang.Class<TArg1> classe1,
                                                               java.lang.Class<TArg2> classe2)

Specify an action that will execute when transitioning into the configured state

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

TArg2 - Type of the third trigger argument

Parameters:

trigger - The trigger by which the state must be entered in order for the action to execute

entryAction - Action to execute, providing details of the transition

classe0 - Class argument

classe1 - Class argument

classe2 - Class argument

Returns:

The receiver

onExit

public StateConfiguration<S,T> onExit(Action exitAction)

Specify an action that will execute when transitioning from the configured state

Parameters:

exitAction - Action to execute

Returns:

The receiver

onExit

public StateConfiguration<S,T> onExit(Action1<Transition<S,T>> exitAction)

Specify an action that will execute when transitioning from the configured state

Parameters:

exitAction - Action to execute

Returns:

The receiver

substateOf

public StateConfiguration<S,T> substateOf(S superstate)

Sets the superstate that the configured state is a substate of

Substates inherit the allowed transitions of their superstate. When entering directly into a substate from outside of the superstate, entry actions for the superstate are executed. Likewise when leaving from the substate to outside the supserstate, exit actions for the superstate will execute.

Parameters:

superstate - The superstate

Returns:

The receiver

permitDynamic

public StateConfiguration<S,T> permitDynamic(T trigger,
                                             Func<S> destinationStateSelector)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

Returns:

The reciever

permitDynamic

public <TArg0> StateConfiguration<S,T> permitDynamic(TriggerWithParameters1<TArg0,S,T> trigger,
                                                     Func2<TArg0,S> destinationStateSelector)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Type Parameters:

TArg0 - Type of the first trigger argument

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

Returns:

The receiver

permitDynamic

public <TArg0,TArg1> StateConfiguration<S,T> permitDynamic(TriggerWithParameters2<TArg0,TArg1,S,T> trigger,
                                                           Func3<TArg0,TArg1,S> destinationStateSelector)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

Returns:

The receiver

permitDynamic

public <TArg0,TArg1,TArg2> StateConfiguration<S,T> permitDynamic(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger,
                                                                 Func4<TArg0,TArg1,TArg2,S> destinationStateSelector)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

TArg2 - Type of the third trigger argument

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

Returns:

The receiver

permitDynamicIf

public StateConfiguration<S,T> permitDynamicIf(T trigger,
                                               Func<S> destinationStateSelector,
                                               FuncBoolean guard)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

guard - Function that must return true in order for the trigger to be accepted

Returns:

The reciever

permitDynamicIf

public <TArg0> StateConfiguration<S,T> permitDynamicIf(TriggerWithParameters1<TArg0,S,T> trigger,
                                                       Func2<TArg0,S> destinationStateSelector,
                                                       FuncBoolean guard)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Type Parameters:

TArg0 - Type of the first trigger argument

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

guard - Function that must return true in order for the trigger to be accepted

Returns:

The reciever

permitDynamicIf

public <TArg0,TArg1> StateConfiguration<S,T> permitDynamicIf(TriggerWithParameters2<TArg0,TArg1,S,T> trigger,
                                                             Func3<TArg0,TArg1,S> destinationStateSelector,
                                                             FuncBoolean guard)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

guard - Function that must return true in order for the trigger to be accepted

Returns:

The reciever

permitDynamicIf

public <TArg0,TArg1,TArg2> StateConfiguration<S,T> permitDynamicIf(TriggerWithParameters3<TArg0,TArg1,TArg2,S,T> trigger,
                                                                   Func4<TArg0,TArg1,TArg2,S> destinationStateSelector,
                                                                   FuncBoolean guard)

Accept the specified trigger and transition to the destination state, calculated dynamically by the supplied function

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

TArg2 - Type of the third trigger argument

Parameters:

trigger - The accepted trigger

destinationStateSelector - Function to calculate the state that the trigger will cause a transition to

guard - Function that must return true in order for the trigger to be accepted

Returns:

The reciever