de.scravy.machina

Class StateMachineBuilder<S,E,T,C,M extends StateMachine<S,E,T>>

java.lang.Object

de.scravy.machina.StateMachineBuilder<S,E,T,C,M>

Type Parameters:

S - State

E - Event

T - Event Type

C - Context

M - Target Machine Type

public final class StateMachineBuilder<S,E,T,C,M extends StateMachine<S,E,T>>
extends Object

A builder to create SimpleStateMachines.

Since:

1.0.0

Author:

Julian Fleischer

Method Summary

Modifier and Type	Method and Description
M	build() Builds a new state machine of target type M from this builder.
static StateMachineBuilder<Object,Object,Object,Void,GenericStateMachine>	create() Creates a new Builder that builds a state machine which accepts any kinds of objects as States, Events, etc.
static <S,E,T,M extends SimpleStateMachine<S,E,T>> StateMachineBuilder<S,E,T,Void,M>	create(Class<M> iface) Creates a new builder that builds state machines from an interface definition.
static <S,E> StateMachineBuilder<S,E,E,Void,SimpleStateMachine<S,E,E>>	create(Class<S> states, Class<E> events) Creates a new Builder that builds simple state machines.
static <S,E,T> StateMachineBuilder<S,E,T,Void,SimpleStateMachine<S,E,T>>	create(Class<S> states, Class<E> events, Class<T> eventTypes) Creates a new builder that builds state machines with a distinct event type.
static <S,E,T,C,M extends StateMachineWithContext<S,E,T,C>> StateMachineBuilder<S,E,T,C,M>	createWithContext(Class<M> iface) Creates a builder that builds state machines with a distinct event type and a computational context from an interface definition.
static <S,E,T,C> StateMachineBuilder<S,E,E,C,StateMachineWithContext<S,E,E,C>>	createWithContext(Class<S> states, Class<E> events, Class<C> context) Creates a builder that builds state machines with a computational context.
static <S,E,T,C> StateMachineBuilder<S,E,T,C,StateMachineWithContext<S,E,T,C>>	createWithContext(Class<S> states, Class<E> events, Class<T> eventTypes, Class<C> context) Creates a builder that builds state machines with a distinct event type and a computational context.
StateMachineBuilder<S,E,T,C,M>	withCatchall(S from, S to)
StateMachineBuilder<S,E,T,C,M>	withEventTypeClassifier(EventTypeClassifier<E,T> eventTypeClassifier)
StateMachineBuilder<S,E,T,C,M>	withFallback(S from, S to)
StateMachineBuilder<S,E,T,C,M>	withInitialState(S initialState)
StateMachineBuilder<S,E,T,C,M>	withListener(StateMachineListener<S,E,T,C> listener) Define a new listener.
StateMachineBuilder<S,E,T,C,M>	withTransition(S from, T on, S to) Define a new transition.
StateMachineBuilder<S,E,T,C,M>	withTransition(S from, T on, S to, Guard<E,C> guard) Define a new transition guarded by a Guard.
StateMachineBuilder<S,E,T,C,M>	withTransition(S from, T on, S to, String guard) Define a new transition guarded by an MVEL expression.
StateMachineBuilder<S,E,T,C,M>	withTransitions(Transition.TransitionBuilder2<S,T>... transitions) Defines a bunch of new Transitions using Transition.from(Object).

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StateMachineBuilder<Object,Object,Object,Void,GenericStateMachine> create()

Creates a new Builder that builds a state machine which accepts any kinds of objects as States, Events, etc. This method is most useful for playing around, quickly prototyping.

Returns:

A new Builder that creates a GenericStateMachine.

Since:

1.2.0

create

public static <S,E> StateMachineBuilder<S,E,E,Void,SimpleStateMachine<S,E,E>> create(Class<S> states,
                                                                                     Class<E> events)

Creates a new Builder that builds simple state machines.

Parameters:

states - The class that all states inherit from.

events - The class that all events inherit from.

Returns:

The new Builder that builds simple state machines.

Since:

1.0.0

create

public static <S,E,T> StateMachineBuilder<S,E,T,Void,SimpleStateMachine<S,E,T>> create(Class<S> states,
                                                                                       Class<E> events,
                                                                                       Class<T> eventTypes)

Creates a new builder that builds state machines with a distinct event type.

Parameters:

states - The class that all states inherit from.

events - The class that all events inherit from.

eventTypes - The class that all event types inherit from.

Returns:

The new builder that builds state machines with a distinct event type.

Since:

1.0.0

create

public static <S,E,T,M extends SimpleStateMachine<S,E,T>> StateMachineBuilder<S,E,T,Void,M> create(Class<M> iface)

Creates a new builder that builds state machines from an interface definition.

Parameters:

iface - The interface to read the state, event, event types and context classes form. This interface must implement SimpleStateMachine. The types are read from the ParameterizedType.

Returns:

The new builder that builds state machines from an interface definition.

Since:

1.0.0

createWithContext

public static <S,E,T,C> StateMachineBuilder<S,E,E,C,StateMachineWithContext<S,E,E,C>> createWithContext(Class<S> states,
                                                                                                        Class<E> events,
                                                                                                        Class<C> context)

Creates a builder that builds state machines with a computational context.

Parameters:

states - The class that all states inherit from.

events - The class that all events inherit from.

context - The class that implements the context.

Returns:

The new builder that builds state machines with a computational context.

Since:

1.0.0

createWithContext

public static <S,E,T,C> StateMachineBuilder<S,E,T,C,StateMachineWithContext<S,E,T,C>> createWithContext(Class<S> states,
                                                                                                        Class<E> events,
                                                                                                        Class<T> eventTypes,
                                                                                                        Class<C> context)

Creates a builder that builds state machines with a distinct event type and a computational context.

Parameters:

states - The class that all states inherit from.

events - The class that all events inherit from.

eventTypes - The class that all event types inherit from.

context - The class that implements the context.

Returns:

The new builder.

Since:

1.0.0

createWithContext

public static <S,E,T,C,M extends StateMachineWithContext<S,E,T,C>> StateMachineBuilder<S,E,T,C,M> createWithContext(Class<M> iface)

Creates a builder that builds state machines with a distinct event type and a computational context from an interface definition.

Parameters:

iface - The interface to read the state, event, event types and context classes form. This interface must implement StateMachineWithContext. The types are read from the ParameterizedType.

Returns:

The new builder.

Since:

1.0.0

withTransition

public StateMachineBuilder<S,E,T,C,M> withTransition(S from,
                                                     T on,
                                                     S to)

Define a new transition.

Parameters:

from - The state from which this transition originates.

on - The event on which this transition is eligible.

to - The state this transition leads to.

Returns:

The builder with that transition added.

Since:

1.0.0

withTransitions

@SafeVarargs
public final StateMachineBuilder<S,E,T,C,M> withTransitions(Transition.TransitionBuilder2<S,T>... transitions)

Defines a bunch of new Transitions using Transition.from(Object).

Parameters:

transitions -

Returns:

A builder with the defined Transitions added.

Since:

1.2.0

withFallback

public StateMachineBuilder<S,E,T,C,M> withFallback(S from,
                                                   S to)

Parameters:

from -

to -

Returns:

Since:

1.2.0

withCatchall

public StateMachineBuilder<S,E,T,C,M> withCatchall(S from,
                                                   S to)

Parameters:

from -

to -

Returns:

Since:

1.3.0

withTransition

public StateMachineBuilder<S,E,T,C,M> withTransition(S from,
                                                     T on,
                                                     S to,
                                                     String guard)

Define a new transition guarded by an MVEL expression. You can use the variables e, event, c, and code to refer the the current Event of type E and the context of type C.

Parameters:

from - The state from which this transition originates.

on - The event on which this transition is eligible.

to - The state this transition leads to.

guard - The guard (an MVEL expression which has to evaluate to true) that has to be passed before this transition can be considered eligible.

Returns:

The builder with that transition added.

Since:

1.0.0

withTransition

public StateMachineBuilder<S,E,T,C,M> withTransition(S from,
                                                     T on,
                                                     S to,
                                                     Guard<E,C> guard)

Define a new transition guarded by a Guard.

Parameters:

from - The state from which this transition originates.

on - The event on which this transition is eligible.

to - The state this transition leads to.

guard - The guard that has to be passed before this transition can be considered eligible.

Returns:

The builder with that transition added.

Since:

1.0.0

withListener

public StateMachineBuilder<S,E,T,C,M> withListener(StateMachineListener<S,E,T,C> listener)

Define a new listener.

Parameters:

listener - The listener.

Returns:

The builder with that listener added.

Since:

1.0.0

build

public M build()

Builds a new state machine of target type M from this builder.

Returns:

The new state machine of target type M.

Since:

1.0.0

withInitialState

@Generated(value="lombok")
public StateMachineBuilder<S,E,T,C,M> withInitialState(S initialState)

withEventTypeClassifier

@Generated(value="lombok")
public StateMachineBuilder<S,E,T,C,M> withEventTypeClassifier(EventTypeClassifier<E,T> eventTypeClassifier)