|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface STM
An implementation of a state transition machine. This would allow the caller to proceed from one state to the other. The implementation is designed to support two types of states:
The STM also supports the notion of an initial state
Field Summary | |
---|---|
static java.lang.String |
FAILURE
|
static java.lang.String |
SUCCESS
|
Method Summary | |
---|---|
State |
proceed(java.lang.Object flowContext)
This method allows the user to specify no starting state and feed it to the STM. |
State |
proceed(State startingState,
java.lang.Object flowContext)
This method allows the user to specify a starting state and feed it to the STM. |
State |
proceed(State startingState,
java.lang.String startingEventId,
java.lang.Object flowContext)
This method allows the user to specify a starting state and feed it to the STM. |
void |
setFlowConfigurator(FlowConfigurator flowConfigurator)
Initialization method. |
Field Detail |
---|
static final java.lang.String SUCCESS
static final java.lang.String FAILURE
Method Detail |
---|
State proceed(java.lang.Object flowContext) throws java.lang.Exception
The new state is either an end state or a manual state (i.e. a state that requires a user triggered action to determine the transitioning event)
This proceed() method supports the following kinds of behavior:
flowContext
- - the context for the flow.
java.lang.Exception
State proceed(State startingState, java.lang.Object flowContext) throws java.lang.Exception
The new state is either an end state or a manual state (i.e. a state that requires a user triggered action to determine the transitioning event)
This proceed() method supports the following kinds of behavior:
startingState
- - the specified state in the specified flowflowContext
- - the context for the flow.
java.lang.Exception
State proceed(State startingState, java.lang.String startingEventId, java.lang.Object flowContext) throws java.lang.Exception
The new state is either an end state or a view state (i.e. a state that requires a user triggered action to determine the transitioning event)
This proceed() method uses the specified state in the specified flow.
startingState
- - the state you start the flow instartingEventId
- - the event that needs to start the flow. This would have been most probably obtained by the user.flowContext
- - the context for the flow.
java.lang.Exception
void setFlowConfigurator(FlowConfigurator flowConfigurator)
flowConfigurator
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |