com.github.oxo42.stateless4j

Class StateMachineConfig<TState,TTrigger>

java.lang.Object

com.github.oxo42.stateless4j.StateMachineConfig<TState,TTrigger>

public class StateMachineConfig<TState,TTrigger>
extends java.lang.Object

The state machine configuration. Reusable.

Constructor Summary

Constructors

Constructor and Description
StateMachineConfig()

Method Summary

Modifier and Type	Method and Description
StateConfiguration<TState,TTrigger>	configure(TState state) Begin configuration of the entry/exit actions and allowed transitions when the state machine is in a particular state
void	generateDotFileInto(java.io.OutputStream dotFile)
StateRepresentation<TState,TTrigger>	getRepresentation(TState state) Return StateRepresentation for the specified state.
TriggerWithParameters<TState,TTrigger>	getTriggerConfiguration(TTrigger trigger)
<TArg0> TriggerWithParameters1<TArg0,TState,TTrigger>	setTriggerParameters(TTrigger trigger, java.lang.Class<TArg0> classe0) Specify the arguments that must be supplied when a specific trigger is fired
<TArg0,TArg1> TriggerWithParameters2<TArg0,TArg1,TState,TTrigger>	setTriggerParameters(TTrigger trigger, java.lang.Class<TArg0> classe0, java.lang.Class<TArg1> classe1) Specify the arguments that must be supplied when a specific trigger is fired
<TArg0,TArg1,TArg2> TriggerWithParameters3<TArg0,TArg1,TArg2,TState,TTrigger>	setTriggerParameters(TTrigger trigger, java.lang.Class<TArg0> classe0, java.lang.Class<TArg1> classe1, java.lang.Class<TArg2> classe2) Specify the arguments that must be supplied when a specific trigger is fired

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineConfig

public StateMachineConfig()

Method Detail

getRepresentation

public StateRepresentation<TState,TTrigger> getRepresentation(TState state)

Return StateRepresentation for the specified state. May return null.

Parameters:

state - The state

Returns:

StateRepresentation for the specified state, or null.

getTriggerConfiguration

public TriggerWithParameters<TState,TTrigger> getTriggerConfiguration(TTrigger trigger)

configure

public StateConfiguration<TState,TTrigger> configure(TState state)

Begin configuration of the entry/exit actions and allowed transitions when the state machine is in a particular state

Parameters:

state - The state to configure

Returns:

A configuration object through which the state can be configured

setTriggerParameters

public <TArg0> TriggerWithParameters1<TArg0,TState,TTrigger> setTriggerParameters(TTrigger trigger,
                                                                                  java.lang.Class<TArg0> classe0)

Specify the arguments that must be supplied when a specific trigger is fired

Type Parameters:

TArg0 - Type of the first trigger argument

Parameters:

trigger - The underlying trigger value

classe0 - Class argument

Returns:

An object that can be passed to the fire() method in order to fire the parameterised trigger

setTriggerParameters

public <TArg0,TArg1> TriggerWithParameters2<TArg0,TArg1,TState,TTrigger> setTriggerParameters(TTrigger trigger,
                                                                                              java.lang.Class<TArg0> classe0,
                                                                                              java.lang.Class<TArg1> classe1)

Specify the arguments that must be supplied when a specific trigger is fired

Type Parameters:

TArg0 - Type of the first trigger argument

TArg1 - Type of the second trigger argument

Parameters:

trigger - The underlying trigger value

classe0 - Class argument

classe1 - Class argument

Returns:

An object that can be passed to the fire() method in order to fire the parameterised trigger

setTriggerParameters

public <TArg0,TArg1,TArg2> TriggerWithParameters3<TArg0,TArg1,TArg2,TState,TTrigger> setTriggerParameters(TTrigger trigger,
                                                                                                          java.lang.Class<TArg0> classe0,
                                                                                                          java.lang.Class<TArg1> classe1,
                                                                                                          java.lang.Class<TArg2> classe2)

Specify the arguments that must be supplied when a specific trigger is fired

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 underlying trigger value

classe0 - Class argument

classe1 - Class argument

classe2 - Class argument

Returns:

An object that can be passed to the fire() method in order to fire the parameterised trigger

generateDotFileInto

public void generateDotFileInto(java.io.OutputStream dotFile)
                         throws java.io.IOException

Throws:

java.io.IOException