|
Spring Web Flow | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.webflow.core.AnnotatedObject org.springframework.webflow.engine.State org.springframework.webflow.engine.TransitionableState
public abstract class TransitionableState
Abstract superclass for states that can execute a transition in response to an event.
Transition
,
TransitionCriteria
Field Summary |
---|
Fields inherited from class org.springframework.webflow.engine.State |
---|
logger |
Fields inherited from class org.springframework.webflow.core.AnnotatedObject |
---|
CAPTION_PROPERTY, DESCRIPTION_PROPERTY |
Constructor Summary | |
---|---|
protected |
TransitionableState(Flow flow,
java.lang.String id)
Create a new transitionable state. |
Method Summary | |
---|---|
protected void |
appendToString(org.springframework.core.style.ToStringCreator creator)
Subclasses may override this hook method to print their internal state to a string. |
void |
exit(RequestControlContext context)
Exit this state. |
ActionList |
getExitActionList()
Returns the list of actions executed by this state when it is exited. |
Transition |
getRequiredTransition(RequestContext context)
Get a transition in this state for given flow execution request context. |
TransitionDefinition |
getTransition(java.lang.String eventId)
Returns the transition that matches the event with the provided id. |
TransitionDefinition[] |
getTransitions()
Returns the available transitions out of this state. |
TransitionSet |
getTransitionSet()
Returns the set of transitions. |
boolean |
handleEvent(RequestControlContext context)
Inform this state definition that an event was signaled in it. |
Methods inherited from class org.springframework.webflow.engine.State |
---|
doEnter, doPreEntryActions, enter, equals, getEntryActionList, getExceptionHandlerSet, getFlow, getId, getOwner, handleException, hashCode, isStartState, isViewState, toString |
Methods inherited from class org.springframework.webflow.core.AnnotatedObject |
---|
getAttributes, getCaption, getDescription, setCaption, setDescription |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.springframework.webflow.definition.StateDefinition |
---|
getId, getOwner, isViewState |
Methods inherited from interface org.springframework.webflow.core.Annotated |
---|
getAttributes, getCaption, getDescription |
Constructor Detail |
---|
protected TransitionableState(Flow flow, java.lang.String id) throws java.lang.IllegalArgumentException
flow
- the owning flowid
- the state identifier (must be unique to the flow)
java.lang.IllegalArgumentException
- when this state cannot be added to given flow, for instance when the id is not
uniqueState.State(Flow, String)
,
getTransitionSet()
Method Detail |
---|
public TransitionDefinition[] getTransitions()
TransitionableStateDefinition
getTransitions
in interface TransitionableStateDefinition
public TransitionDefinition getTransition(java.lang.String eventId)
TransitionableStateDefinition
getTransition
in interface TransitionableStateDefinition
eventId
- the event id
public TransitionSet getTransitionSet()
public Transition getRequiredTransition(RequestContext context) throws NoMatchingTransitionException
NoMatchingTransitionException
- when a matching transition cannot be foundpublic ActionList getExitActionList()
public boolean handleEvent(RequestControlContext context) throws NoMatchingTransitionException
RequestContext.getCurrentEvent()
).
context
- the flow execution control context
NoMatchingTransitionException
- when a matching transition cannot be foundpublic void exit(RequestControlContext context)
context
- the flow control contextprotected void appendToString(org.springframework.core.style.ToStringCreator creator)
State
appendToString
in class State
creator
- the toString creator, to print properties to stringState.toString()
|
Spring Web Flow | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |