se.fearless.fettle.builder

Class StateMachineBuilder<S,E,C>

java.lang.Object

se.fearless.fettle.builder.StateMachineBuilder<S,E,C>

public class StateMachineBuilder<S,E,C>
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
StateMachine<S,E,C>	build(S initial) Builds a state machine with the transitions and states configured by the builder.
StateMachineTemplate<S,E,C>	buildTransitionModel() Builds a state machine template capable of creating many instances all sharing the same state transitions and actions but all with their own current state.
static <S,E,C> StateMachineBuilder<S,E,C>	create(java.lang.Class<S> stateClass, java.lang.Class<E> eventClass)
StateMachineBuilder<S,E,C>	defaultContext(C defaultContext)
EntryExit<S,E,C>	onEntry(S state)
EntryExit<S,E,C>	onExit(S state)
Transition<S,E,C>	transition()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <S,E,C> StateMachineBuilder<S,E,C> create(java.lang.Class<S> stateClass,
                                                        java.lang.Class<E> eventClass)

transition

public Transition<S,E,C> transition()

onEntry

public EntryExit<S,E,C> onEntry(S state)

onExit

public EntryExit<S,E,C> onExit(S state)

defaultContext

public StateMachineBuilder<S,E,C> defaultContext(C defaultContext)

build

public StateMachine<S,E,C> build(S initial)

Builds a state machine with the transitions and states configured by the builder. Note that consecutive calls to this method will not share transition models and it's therefore inefficient to use this method to create large number of state machines. This method can be considered as a short hand for cases when just one state machine of a certain configuration is needed.

Parameters:

initial - the state the machine will be in when created

Returns:

a new state machine configured with all the transitions and actions specified using this builder

Throws:

java.lang.IllegalArgumentException - if the initial state is null

buildTransitionModel

public StateMachineTemplate<S,E,C> buildTransitionModel()

Builds a state machine template capable of creating many instances all sharing the same state transitions and actions but all with their own current state. This is more memory efficient and is good when you need a large number of identical state machine instances.

Returns:

a state machine template configured with all the transitions and actions specified using this builder