io.hektor.fsm.builder

Interface StateBuilder<S extends Enum<S>,C extends Context,D extends Data>

All Known Implementing Classes:

StateBuilderImpl

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

Method Summary

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

Method Detail

getState

Enum<S> getState()

withEnterAction

StateBuilder<S,C,D> withEnterAction(BiConsumer<C,D> action)

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

withExitAction

StateBuilder<S,C,D> withExitAction(BiConsumer<C,D> action)

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

withStateTimeout

StateBuilder<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.

Returns:

transitionToSelf

EventBuildStep<S,C,D> transitionToSelf()

transitionTo

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

build

State build()