org.springframework.statemachine

Interface StateMachineContext<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Known Implementing Classes:

DefaultStateMachineContext

public interface StateMachineContext<S,E>

StateMachineContext represents a current state of a state machine.

Author:

Janne Valkealahti

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getChildReferences() Gets the child context references if any.
java.util.List<StateMachineContext<S,E>>	getChilds() Gets the child contexts if any.
E	getEvent() Gets the event.
java.util.Map<java.lang.String,java.lang.Object>	getEventHeaders() Gets the event headers.
ExtendedState	getExtendedState() Gets the extended state.
java.util.Map<S,S>	getHistoryStates() Gets the history state mappings
java.lang.String	getId() Gets the machine id.
S	getState() Gets the state.

Method Detail

getId

java.lang.String getId()

Gets the machine id.

Returns:

the machine id

getChilds

java.util.List<StateMachineContext<S,E>> getChilds()

Gets the child contexts if any.

Returns:

the child contexts

getChildReferences

java.util.List<java.lang.String> getChildReferences()

Gets the child context references if any.

Returns:

the child context references

getState

S getState()

Gets the state.

Returns:

the state

getEvent

E getEvent()

Gets the event.

Returns:

the event

getHistoryStates

java.util.Map<S,S> getHistoryStates()

Gets the history state mappings

Returns:

the history state mappings

getEventHeaders

java.util.Map<java.lang.String,java.lang.Object> getEventHeaders()

Gets the event headers.

Returns:

the event headers

getExtendedState

ExtendedState getExtendedState()

Gets the extended state.

Returns:

the extended state