org.squirrelframework.foundation.fsm

Interface TransitionResult<T extends StateMachine<T,S,E,C>,S,E,C>

Type Parameters:

T - state machine type

S - state type

E - event type

C - context type

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

This class will hold all the transition result including result of nested transitions.

Author:

Henry.He

Method Summary

Methods

Modifier and Type	Method and Description
List<TransitionResult<T,S,E,C>>	getAcceptedResults()
TransitionResult<T,S,E,C>	getParentResut()
List<TransitionResult<T,S,E,C>>	getSubResults()
ImmutableState<T,S,E,C>	getTargetState()
boolean	isAccepted() If any transition including all nested transitions is accepted, the parent transition is accepted accordingly.
boolean	isDeclined() If all transitions including all nested transitions is declined, the parent transition is declined accordingly.
TransitionResult<T,S,E,C>	setAccepted(boolean accepted) Set transition accepted or not.
TransitionResult<T,S,E,C>	setParent(TransitionResult<T,S,E,C> result) Set parent transition result
TransitionResult<T,S,E,C>	setTargetState(ImmutableState<T,S,E,C> targetState) Set target state of transition

Method Detail

isAccepted

boolean isAccepted()

If any transition including all nested transitions is accepted, the parent transition is accepted accordingly.

Returns:

true if transition is accepted; false if transition result is declined

isDeclined

boolean isDeclined()

If all transitions including all nested transitions is declined, the parent transition is declined accordingly.

Returns:

false if transition is accepted; true if transition result is declined

setAccepted

TransitionResult<T,S,E,C> setAccepted(boolean accepted)

Set transition accepted or not.

Parameters:

accepted -

Returns:

transition result

getTargetState

ImmutableState<T,S,E,C> getTargetState()

Returns:

target state of transition

setTargetState

TransitionResult<T,S,E,C> setTargetState(ImmutableState<T,S,E,C> targetState)

Set target state of transition

Parameters:

targetState -

Returns:

transition result

getParentResut

TransitionResult<T,S,E,C> getParentResut()

Returns:

parent transition result

setParent

TransitionResult<T,S,E,C> setParent(TransitionResult<T,S,E,C> result)

Set parent transition result

Parameters:

result -

Returns:

transition result

getSubResults

List<TransitionResult<T,S,E,C>> getSubResults()

Returns:

nested transition result of current transition

getAcceptedResults

List<TransitionResult<T,S,E,C>> getAcceptedResults()

Returns:

all the accepted transition result of current transition