io.hektor.fsm.builder

Class FSMBuilder<S extends Enum<S>,C extends Context,D extends Data>

java.lang.Object

io.hektor.fsm.builder.FSMBuilder<S,C,D>

public class FSMBuilder<S extends Enum<S>,C extends Context,D extends Data>
extends Object

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
FSMBuilder(S[] possibleStates)

Method Summary

Modifier and Type	Method and Description
Definition<S,C,D>	build() Build the definition of the state machine and validate that all is well.
StateBuilderImpl<S,C,D>	withFinalState(S state)
StateBuilderImpl<S,C,D>	withInitialState(S state)
StateBuilderImpl<S,C,D>	withState(S state)
StateBuilder<S,C,D>	withTransientState(S state)

Methods inherited from class java.lang.Object

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

Constructor Detail

FSMBuilder

public FSMBuilder(S[] possibleStates)

Method Detail

withInitialState

public StateBuilderImpl<S,C,D> withInitialState(S state)

withFinalState

public StateBuilderImpl<S,C,D> withFinalState(S state)

withState

public StateBuilderImpl<S,C,D> withState(S state)
                                  throws StateAlreadyDefinedException

Throws:

StateAlreadyDefinedException

withTransientState

public StateBuilder<S,C,D> withTransientState(S state)
                                       throws StateAlreadyDefinedException

Throws:

StateAlreadyDefinedException

build

public Definition<S,C,D> build()
                        throws FSMBuilderException

Build the definition of the state machine and validate that all is well. The following rules will be validate upon building the definition:

• Transitions with transformations can only be going to transient states and anything else is not allowed, hence, we will throw an exception.

Returns:

Throws:

FSMBuilderException - in case any issues with the FSM is detected.