| java.lang.Object
 org.springframework.webflow.engine.AnnotatedObject
org.springframework.webflow.engine.State
All known Subclasses: org.springframework.webflow.engine.EndState, org.springframework.webflow.engine.TransitionableState,
| Field Summary | |
| final protected Log | logger
Logger, for use in subclasses. |
| Constructor Summary | |
| protected | State(Flow flow, String id)
Creates a state for the provided flow identified by the
provided id. |
| logger | | final protected Log logger(Code) | | Logger, for use in subclasses.
|
| appendToString | | protected void appendToString(ToStringCreator creator)(Code) | | Subclasses may override this hook method to stringify their internal
state. This default implementation does nothing.
Parameters:
creator - the toString creator, to stringify properties |
| doEnter | | abstract protected ViewSelection doEnter(RequestControlContext context) throws FlowExecutionException(Code) | | Hook method to execute custom behaviour as a result of entering this
state. By implementing this method subclasses specialize the behaviour of
the state.
Parameters:
context - the control context for the currently executing flow, usedby this state to manipulate the flow execution a view selection containing model and view information needed torender the results of the state processing
throws:
FlowExecutionException - if an exception occurs in this state |
| enter | | final public ViewSelection enter(RequestControlContext context) throws FlowExecutionException(Code) | | Enter this state in the provided flow control context. This
implementation just calls the
State.doEnter(RequestControlContext) hook method, which should
be implemented by subclasses, after executing the entry actions.
Parameters:
context - the control context for the currently executing flow, usedby this state to manipulate the flow execution a view selection containing model and view information needed torender the results of the state processing
throws:
FlowExecutionException - if an exception occurs in this state |
| getEntryActionList | | public ActionList getEntryActionList()(Code) | | Returns the list of actions executed by this state when it is entered.
The returned list is mutable.
the state entry action list |
| getExceptionHandlerSet | | public FlowExecutionExceptionHandlerSet getExceptionHandlerSet()(Code) | | Returns a mutable set of exception handlers, allowing manipulation of how
exceptions are handled when thrown within this state.
Exception handlers are invoked when an exception occurs when this state
is entered, and can execute custom exception handling logic as well as
select an error view to display.
the state exception handler set |
| getFlow | | public Flow getFlow()(Code) | | Returns the owning flow.
|
| handleException | | public ViewSelection handleException(FlowExecutionException exception, RequestControlContext context)(Code) | | Handle an exception that occured in this state during the context of the
current flow execution request.
Parameters:
exception - the exception that occured
Parameters:
context - the flow execution control context the selected error view, or null if no handlermatched or returned a non-null view selection |
| hashCode | | public int hashCode()(Code) | | |
| isStartState | | public boolean isStartState()(Code) | | Returns a flag indicating if this state is the start state of its owning
flow.
true if the flow is the start state, false otherwise |
|
|