Interface Model<S extends Enum<S>>

Type Parameters:

S - the type of state of the FiniteStateMachine

All Known Implementing Classes:

AnnotationDrivenModel, SimpleModel

public interface Model<S extends Enum<S>>

A Model represents the definition of a FiniteStateMachine, the set of known states, Transitions between said states and StateEntryActions / StateExitActions to be performed when said states are changed.

Since:

Coherence 12.2.1

Author:

Brian Oliver

Method Summary

Modifier and Type	Method	Description
Class<S>	getStateClass()	Obtains the Class of the state of the Model.
Map<S, StateEntryAction<S>>	getStateEntryActions()	Obtains the StateEntryActions defined for the states in the Model.
Map<S, StateExitAction<S>>	getStateExitActions()	Obtains the StateExitActions defined for the states in the Model.
S[]	getStates()	Obtains the valid states defined by the Model.
Iterable<Transition<S>>	getTransitions()	Obtains the Transitions defined by the Model.

Method Details

getTransitions

Iterable<Transition<S>> getTransitions()

Obtains the Transitions defined by the Model.

Returns:

the Transitions defined by the Model

getStateClass

Class<S> getStateClass()

Obtains the Class of the state of the Model.

Returns:

the Class of the state

getStates

S[] getStates()

Obtains the valid states defined by the Model.

Returns:

the valid states of the Model

getStateEntryActions

Map<S, StateEntryAction<S>> getStateEntryActions()

Obtains the StateEntryActions defined for the states in the Model.

Returns:

the defined StateEntryActions defined for the states in the Model

getStateExitActions

Map<S, StateExitAction<S>> getStateExitActions()

Obtains the StateExitActions defined for the states in the Model.

Returns:

the defined StateExitActions defined for the states in the Model