org.springframework.statemachine.config.model

Class StateData<S,E>

java.lang.Object

org.springframework.statemachine.config.model.StateData<S,E>

Type Parameters:

S - the type of state

E - the type of event

public class StateData<S,E>
extends java.lang.Object

StateData is a data representation of a State used as an abstraction between a StateMachineFactory and a state machine configuration.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
StateData(java.lang.Object parent, java.lang.Object region, S state, boolean initial) Instantiates a new state data.
StateData(java.lang.Object parent, java.lang.Object region, S state, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions) Instantiates a new state data.
StateData(java.lang.Object parent, java.lang.Object region, S state, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions, boolean initial) Instantiates a new state data.
StateData(java.lang.Object parent, java.lang.Object region, S state, java.util.Collection<E> deferred, java.util.Collection<? extends Action<S,E>> entryActions, java.util.Collection<? extends Action<S,E>> exitActions, boolean initial, Action<S,E> initialAction) Instantiates a new state data.
StateData(S state) Instantiates a new state data.
StateData(S state, boolean initial) Instantiates a new state data.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<E>	getDeferred() Gets the deferred.
java.util.Collection<? extends Action<S,E>>	getEntryActions() Gets the entry actions.
java.util.Collection<? extends Action<S,E>>	getExitActions() Gets the exit actions.
Action<S,E>	getInitialAction()
java.lang.Object	getParent() Gets the parent.
PseudoStateKind	getPseudoStateKind() Gets the pseudo state kind.
java.lang.Object	getRegion() Gets the region.
S	getState() Gets the state.
java.util.Collection<? extends Action<S,E>>	getStateActions() Gets the state actions.
StateMachine<S,E>	getSubmachine() Gets the submachine.
StateMachineFactory<S,E>	getSubmachineFactory() Gets the submachine factory.
java.util.Collection<StateData<S,E>>	getSubmachineStateData() Gets the submachine state data.
boolean	isEnd() Checks if is end.
boolean	isInitial() Checks if is initial.
void	setDeferred(java.util.Collection<E> deferred) Sets the deferred.
void	setEnd(boolean end) Sets the end.
void	setEntryActions(java.util.Collection<? extends Action<S,E>> entryActions) Sets the entry actions.
void	setExitActions(java.util.Collection<? extends Action<S,E>> exitActions) Sets the exit actions.
void	setInitial(boolean initial) Sets the initial.
void	setInitialAction(Action<S,E> action) Sets the initial action.
void	setParent(java.lang.Object parent) Sets the parent.
void	setPseudoStateKind(PseudoStateKind pseudoStateKind) Sets the pseudo state kind.
void	setRegion(java.lang.Object region) Sets the region.
void	setStateActions(java.util.Collection<? extends Action<S,E>> stateActions) Sets the state actions.
void	setSubmachine(StateMachine<S,E> submachine) Sets the submachine.
void	setSubmachine(StateMachineFactory<S,E> submachineFactory) Sets the submachine factory.
void	setSubmachineFactory(StateMachineFactory<S,E> submachineFactory) Sets the submachine factory.
void	setSubmachineStateData(java.util.Collection<StateData<S,E>> submachineStateData) Sets the submachine state data.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StateData

public StateData(S state)

Instantiates a new state data.

Parameters:

state - the state

StateData

public StateData(S state,
                 boolean initial)

Instantiates a new state data.

Parameters:

state - the state

initial - the initial

StateData

public StateData(java.lang.Object parent,
                 java.lang.Object region,
                 S state,
                 boolean initial)

Instantiates a new state data.

Parameters:

parent - the parent

region - the region

state - the state

initial - the initial

StateData

public StateData(java.lang.Object parent,
                 java.lang.Object region,
                 S state,
                 java.util.Collection<E> deferred,
                 java.util.Collection<? extends Action<S,E>> entryActions,
                 java.util.Collection<? extends Action<S,E>> exitActions)

Instantiates a new state data.

Parameters:

parent - the parent

region - the region

state - the state

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

StateData

public StateData(java.lang.Object parent,
                 java.lang.Object region,
                 S state,
                 java.util.Collection<E> deferred,
                 java.util.Collection<? extends Action<S,E>> entryActions,
                 java.util.Collection<? extends Action<S,E>> exitActions,
                 boolean initial)

Instantiates a new state data.

Parameters:

parent - the parent

region - the region

state - the state

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

initial - the initial

StateData

public StateData(java.lang.Object parent,
                 java.lang.Object region,
                 S state,
                 java.util.Collection<E> deferred,
                 java.util.Collection<? extends Action<S,E>> entryActions,
                 java.util.Collection<? extends Action<S,E>> exitActions,
                 boolean initial,
                 Action<S,E> initialAction)

Instantiates a new state data.

Parameters:

parent - the parent

region - the region

state - the state

deferred - the deferred

entryActions - the entry actions

exitActions - the exit actions

initial - the initial

initialAction - the initial action

Method Detail

getState

public S getState()

Gets the state.

Returns:

the state

getSubmachineStateData

public java.util.Collection<StateData<S,E>> getSubmachineStateData()

Gets the submachine state data.

Returns:

the submachine state data

setSubmachineStateData

public void setSubmachineStateData(java.util.Collection<StateData<S,E>> submachineStateData)

Sets the submachine state data.

Parameters:

submachineStateData - the submachine state data

getSubmachine

public StateMachine<S,E> getSubmachine()

Gets the submachine.

Returns:

the submachine

setSubmachine

public void setSubmachine(StateMachine<S,E> submachine)

Sets the submachine.

Parameters:

submachine - the submachine

getSubmachineFactory

public StateMachineFactory<S,E> getSubmachineFactory()

Gets the submachine factory.

Returns:

the submachine factory

setSubmachineFactory

public void setSubmachineFactory(StateMachineFactory<S,E> submachineFactory)

Sets the submachine factory.

Parameters:

submachineFactory - the submachine factory

setSubmachine

public void setSubmachine(StateMachineFactory<S,E> submachineFactory)

Sets the submachine factory.

Parameters:

submachineFactory - the submachine factory

getDeferred

public java.util.Collection<E> getDeferred()

Gets the deferred.

Returns:

the deferred

setDeferred

public void setDeferred(java.util.Collection<E> deferred)

Sets the deferred.

Parameters:

deferred - the new deferred

getEntryActions

public java.util.Collection<? extends Action<S,E>> getEntryActions()

Gets the entry actions.

Returns:

the entry actions

setEntryActions

public void setEntryActions(java.util.Collection<? extends Action<S,E>> entryActions)

Sets the entry actions.

Parameters:

entryActions - the entry actions

getExitActions

public java.util.Collection<? extends Action<S,E>> getExitActions()

Gets the exit actions.

Returns:

the exit actions

setExitActions

public void setExitActions(java.util.Collection<? extends Action<S,E>> exitActions)

Sets the exit actions.

Parameters:

exitActions - the exit actions

getStateActions

public java.util.Collection<? extends Action<S,E>> getStateActions()

Gets the state actions.

Returns:

the state actions

setStateActions

public void setStateActions(java.util.Collection<? extends Action<S,E>> stateActions)

Sets the state actions.

Parameters:

stateActions - the state actions

getParent

public java.lang.Object getParent()

Gets the parent.

Returns:

the parent

setParent

public void setParent(java.lang.Object parent)

Sets the parent.

Parameters:

parent - the new parent

getRegion

public java.lang.Object getRegion()

Gets the region.

Returns:

the region

setRegion

public void setRegion(java.lang.Object region)

Sets the region.

Parameters:

region - the new region

isInitial

public boolean isInitial()

Checks if is initial.

Returns:

true, if is initial

setInitial

public void setInitial(boolean initial)

Sets the initial.

Parameters:

initial - the new initial

setInitialAction

public void setInitialAction(Action<S,E> action)

Sets the initial action.

Parameters:

action - the action

getInitialAction

public Action<S,E> getInitialAction()

isEnd

public boolean isEnd()

Checks if is end.

Returns:

true, if is end

setEnd

public void setEnd(boolean end)

Sets the end.

Parameters:

end - the new end

getPseudoStateKind

public PseudoStateKind getPseudoStateKind()

Gets the pseudo state kind.

Returns:

the pseudo state kind

setPseudoStateKind

public void setPseudoStateKind(PseudoStateKind pseudoStateKind)

Sets the pseudo state kind.

Parameters:

pseudoStateKind - the new pseudo state kind

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object