com.ervacon.springframework.web.servlet.mvc.webflow
Class NavigationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.springframework.core.NestedRuntimeException
                  com.ervacon.springframework.web.servlet.mvc.webflow.WebFlowException
                      com.ervacon.springframework.web.servlet.mvc.webflow.NavigationException

All Implemented Interfaces:

java.io.Serializable

public class NavigationException

extends WebFlowException

Exception that is generated when a web flow encounters navigation problems, for instance when a state or transition cannot be found. This is typically caused by a user using the browser Back button.

This exception tracks some flow state information that might be used trying to resolve the problem. Note that this information is optional, so it can be null!

Author:

Erwin Vervaet

See Also:

Serialized Form

Constructor Summary

NavigationException(java.lang.String msg, java.lang.String state, java.lang.String event, WebFlowMementoStack mementos)
Create a new navigation exception.

Method Summary

java.lang.String	getEvent() Get the event being processed when the exception was generated.
WebFlowMementoStack	getMementos() Get the flow memento stack at the time the exception was generated.
java.lang.String	getState() Get the target state of the flow when the exception was generated.
void	setEvent(java.lang.String event) Set the event being processed when the exception was generated.
void	setMementos(WebFlowMementoStack mementos) Set the flow memento stack at the time the exception was generated.
void	setState(java.lang.String state) Set the target state of the flow when the exception was generated.

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getCause, getMessage, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationException

public NavigationException(java.lang.String msg,
                           java.lang.String state,
                           java.lang.String event,
                           WebFlowMementoStack mementos)

Create a new navigation exception.

Parameters:

msg - the detail message

state - the target state of the flow when the exception was generated, can be null

event - the event being processed when the exception was generated, can be null

mementos - the flow memento stack at the time the exception was generated, can be null

Method Detail

getState

public java.lang.String getState()

Get the target state of the flow when the exception was generated. This property is optional so the value can be null.

setState

public void setState(java.lang.String state)

Set the target state of the flow when the exception was generated. This property is optional so the value can be null.

getEvent

public java.lang.String getEvent()

Get the event being processed when the exception was generated. This property is optional so the value can be null.

setEvent

public void setEvent(java.lang.String event)

Set the event being processed when the exception was generated. This property is optional so the value can be null.

getMementos

public WebFlowMementoStack getMementos()

Get the flow memento stack at the time the exception was generated. This property is optional so the value can be null.

setMementos

public void setMementos(WebFlowMementoStack mementos)

Set the flow memento stack at the time the exception was generated. This property is optional so the value can be null.