de.scravy.machina

Interface SimpleStateMachine<S,E,T>

Type Parameters:

S - State

E - Event

T - Event Type

All Superinterfaces:

StateMachine<S,E,T>

All Known Subinterfaces:

GenericStateMachine

public interface SimpleStateMachine<S,E,T>
extends StateMachine<S,E,T>

A state machine.

Since:

1.0.0

Author:

Julian Fleischer

Method Summary

Modifier and Type	Method and Description
S	run(Iterable<? extends E> events) Executes the state machine with a series of Events.
S	run(S current, E event) Executes the state machine for a single event, starting in the specified state.
SimpleStatefulStateMachine<S,E,T>	withState()
SimpleStatefulStateMachine<S,E,T>	withState(S current)

Methods inherited from interface de.scravy.machina.StateMachine

getEventClass, getEventTypeClass, getInitialState, getStateClass, getTransitions

Method Detail

run

S run(Iterable<? extends E> events)
throws StateMachineException

Executes the state machine with a series of Events. The state machine will start in the initial state.

Parameters:

events - The series of events as an Iterable.

Returns:

The state the state machine ends up in.

Throws:

DeadEndException - If the state machine is stuck due to no transition being eligible.

EventTypeClassifierException - If the EventTypeClassifier associated with this state machine fails during execution. The original exception will be the cause for this exception.

StateHandlerException - If one of the encompassed states implements StateWithEnterHandler or StateWithExitHandler and throws an error during execution of its handler method.

StateMachineException - If an internal error happens, for example a GuardEvaluationException.

Since:

1.0.0

run

S run(S current,
      E event)
throws StateMachineException

Executes the state machine for a single event, starting in the specified state.

Parameters:

current - The state to start in.

event - The event to execute the state machine for.

Returns:

The state the state machine end up in.

Throws:

DeadEndException - If the state machine is stuck due to no transition being eligible.

EventTypeClassifierException - If the EventTypeClassifier associated with this state machine fails during execution. The original exception will be the cause for this exception.

StateHandlerException - If one of the encompassed states implements StateWithEnterHandler or StateWithExitHandler and throws an error during execution of its handler method.

StateMachineException - If an internal error happens, for example a GuardEvaluationException.

Since:

1.0.0

withState

SimpleStatefulStateMachine<S,E,T> withState()

withState

SimpleStatefulStateMachine<S,E,T> withState(S current)