io.hektor.fsm.builder.impl

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

java.lang.Object

io.hektor.fsm.builder.impl.StateBuilderImpl<S,C,D>

All Implemented Interfaces:

StateBuilder<S,C,D>

public class StateBuilderImpl<S extends Enum<S>,C extends Context,D extends Data>
extends Object
implements StateBuilder<S,C,D>

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
StateBuilderImpl(S state)
StateBuilderImpl(S state, boolean isTransient)

Method Summary

Modifier and Type	Method and Description
State	build()
S	getState()
boolean	isFinal()
StateBuilderImpl<S,C,D>	isFinal(boolean value)
boolean	isInital()
StateBuilderImpl<S,C,D>	isInital(boolean value)
EventBuildStep<S,C,D>	transitionTo(S state)
EventBuildStep<S,C,D>	transitionToSelf()
StateBuilderImpl<S,C,D>	withEnterAction(BiConsumer<C,D> action) Register an action that will be executed upon entering this state.
StateBuilderImpl<S,C,D>	withExitAction(BiConsumer<C,D> action) Register an action that will be executed upon exiting this state.
StateBuilderImpl<S,C,D>	withStateTimeout() Set the maximum time we allow to stay in this state.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateBuilderImpl

public StateBuilderImpl(S state)

StateBuilderImpl

public StateBuilderImpl(S state,
                        boolean isTransient)

Method Detail

getState

public S getState()

Specified by:

getState in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

withEnterAction

public StateBuilderImpl<S,C,D> withEnterAction(BiConsumer<C,D> action)

Register an action that will be executed upon entering this state.

Specified by:

withEnterAction in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

Returns:

withExitAction

public StateBuilderImpl<S,C,D> withExitAction(BiConsumer<C,D> action)

Register an action that will be executed upon exiting this state.

Specified by:

withExitAction in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

Returns:

withStateTimeout

public StateBuilderImpl<S,C,D> withStateTimeout()

Set the maximum time we allow to stay in this state. When this duration has passed and we are still in this state, the event StateTimeoutEvent will be fired and given to the state machine. If there are no registered transitions associated with that event for this state, then TODO - yeah, what do we want to happen. Perhaps just call the onUnhandledEvent or something? so that there is no difference between this one and everything else.

Specified by:

withStateTimeout in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

Returns:

transitionToSelf

public EventBuildStep<S,C,D> transitionToSelf()

Specified by:

transitionToSelf in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

transitionTo

public EventBuildStep<S,C,D> transitionTo(S state)

Specified by:

transitionTo in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

build

public State build()

Specified by:

build in interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

isInital

public StateBuilderImpl<S,C,D> isInital(boolean value)

isInital

public boolean isInital()

isFinal

public StateBuilderImpl<S,C,D> isFinal(boolean value)

isFinal

public boolean isFinal()