ch.bbv.fsm

Interface StateMachine<TState extends Enum<?>,TEvent extends Enum<?>>

Type Parameters:

TState - the enumeration type of the states.

TEvent - the enumeration type of the events.

public interface StateMachine<TState extends Enum<?>,TEvent extends Enum<?>>

Defines the interface of a state machine.

Author:

Ueli Kurmann (bbv Software Services AG)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventHandler(StateMachineEventHandler<TState,TEvent> handler) Adds an event handler
void	defineHierarchyOn(TState superStateId, TState initialSubStateId, HistoryType historyType, TState... subStateIds) Defines a state hierarchy.
void	fire(TEvent eventId, Object... eventArguments) Fires the specified event.
void	firePriority(TEvent eventId, Object... eventArguments) Fires the specified priority event.
EntryActionSyntax<TState,TEvent>	in(TState state)
void	initialize(TState initialState) Initializes the state machine to the specified initial state.
boolean	isExecuting() Returns true if the state machine is executing events.
boolean	isRunning() Gets a value indicating whether this instance is running.
int	numberOfQueuedEvents() Returns the number of queued events.
void	removeEventHandler(StateMachineEventHandler<TState,TEvent> handler) Removes the given event handler.
String	report() Returns a report of this state machine with all states and transitions.
void	start() Starts the state machine.
void	stop() Stops the state machine.

Method Detail

addEventHandler

void addEventHandler(StateMachineEventHandler<TState,TEvent> handler)

Adds an event handler

Parameters:

handler - the event handler

defineHierarchyOn

void defineHierarchyOn(TState superStateId,
                     TState initialSubStateId,
                     HistoryType historyType,
                     TState... subStateIds)

Defines a state hierarchy.

Parameters:

superStateId - the super state id.

initialSubStateId - the initial sub state id.

historyType - type of history.

subStateIds - the sub state id's.

fire

void fire(TEvent eventId,
        Object... eventArguments)

Fires the specified event.

Parameters:

eventId - the event

eventArguments - the event arguments

firePriority

void firePriority(TEvent eventId,
                Object... eventArguments)

Fires the specified priority event. The event will be handled before any already queued event.

Parameters:

eventId - the event.

eventArguments - the event arguments.

in

EntryActionSyntax<TState,TEvent> in(TState state)

Parameters:

state -

Returns:

initialize

void initialize(TState initialState)

Initializes the state machine to the specified initial state.

Parameters:

initialState - The state to which the state machine is initialized.

isExecuting

boolean isExecuting()

Returns true if the state machine is executing events.

Returns:

true if the state machine is executing events.

isRunning

boolean isRunning()

Gets a value indicating whether this instance is running. The state machine is running if if was started and not yet stopped.

Returns:

true if this instance is running.

numberOfQueuedEvents

int numberOfQueuedEvents()

Returns the number of queued events.

Returns:

the number of queued events.

removeEventHandler

void removeEventHandler(StateMachineEventHandler<TState,TEvent> handler)

Removes the given event handler.

Parameters:

handler - the event handler to be removed.

report

String report()

Returns a report of this state machine with all states and transitions.

start

void start()

Starts the state machine. Events will be processed. If the state machine is not started then the events will be queued until the state machine is started. Already queued events are processed.

stop

void stop()

Stops the state machine. Events will be queued until the state machine is started.