de.scravy.machina

Interface StateMachineWithContext<S,E,T,C>

Type Parameters:

C - Context

S - State

E - Event

T - Event Type

All Superinterfaces:

StateMachine<S,E,T>

public interface StateMachineWithContext<S,E,T,C>
extends StateMachine<S,E,T>

A SimpleStateMachine with a computational context.

Since:

1.0.0

Author:

Julian Fleischer

Method Summary

Modifier and Type	Method and Description
Class<C>	getContextClass() Get the class that implements the context of this state machine.
RunResult<S,C>	run(Iterable<? extends E> events, C context) Executes the state machine with a series of Events and a Context.
RunResult<S,C>	run(S current, E event, C context) Executes the state machine for a single event, starting in the specified state.
StatefulStateMachineWithContext<S,E,T,C>	withState(C context)
StatefulStateMachineWithContext<S,E,T,C>	withState(C context, S current)

Methods inherited from interface de.scravy.machina.StateMachine

getEventClass, getEventTypeClass, getInitialState, getStateClass, getTransitions

Method Detail

run

RunResult<S,C> run(Iterable<? extends E> events,
                   C context)
            throws StateMachineException

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

Parameters:

events - The series of Events as an Iterable.

Returns:

A pair of the state the state machine ends up in and the (possibly) altered context.

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

RunResult<S,C> run(S current,
                   E event,
                   C context)
            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.

context - A context object.

Returns:

A pair of the state the state machine ends up in and the (possibly) altered context.

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

getContextClass

Class<C> getContextClass()

Get the class that implements the context of this state machine.

Returns:

The class that implements the context of this state machine.

Since:

1.0.0

withState

StatefulStateMachineWithContext<S,E,T,C> withState(C context)

withState

StatefulStateMachineWithContext<S,E,T,C> withState(C context,
                                                   S current)