Author: steveh
Date: Tue Aug 31 14:13:09 2004
New Revision: 37262
Modified:
incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/FlowController.java
Log:
Fixing the [EMAIL PROTECTED] tags, which were breaking the javadoc build.
Modified:
incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/FlowController.java
==============================================================================
---
incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/FlowController.java
(original)
+++
incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/FlowController.java
Tue Aug 31 14:13:09 2004
@@ -103,7 +103,7 @@
}
/**
- * Stores per-request state, which is <i>only valid during calls to [EMAIL
PROTECTED] #execute} or [EMAIL PROTECTED] #handleException}</i>.
+ * Stores per-request state, which is <i>only valid during calls to [EMAIL
PROTECTED] FlowController#execute} or [EMAIL PROTECTED]
FlowController#handleException}</i>.
*/
private transient PerRequestState _perRequestState;
@@ -163,7 +163,7 @@
* otherwise the session and its data are left intact (except
for authentication
* information used internally by the server). To invalidate
the session in only the
* current webapp, set this parameter to <code>false</code> and
call
- * [EMAIL PROTECTED] #getSession}.invalidate().
+ * [EMAIL PROTECTED] FlowController#getSession}.invalidate().
*/
public void logout( boolean invalidateSessions )
{
@@ -174,7 +174,7 @@
/**
* Send a Page Flow error to the browser.
*
- * @deprecated Use [EMAIL PROTECTED] #sendError(String,
HttpServletRequest, HttpServletResponse)} instead.
+ * @deprecated Use [EMAIL PROTECTED] FlowController#sendError(String,
HttpServletRequest, HttpServletResponse)} instead.
* @param errText the error message to display.
* @param response the current HttpServletResponse.
*/
@@ -244,13 +244,13 @@
/**
* Get the name of the current action being executed. This call is only
valid
- * during [EMAIL PROTECTED] #execute} (where any user action method is
invoked), and during the lifecycle
- * methods [EMAIL PROTECTED] #beforeAction} and [EMAIL PROTECTED]
#afterAction}.
+ * during [EMAIL PROTECTED] FlowController#execute} (where any user action
method is invoked), and during the lifecycle
+ * methods [EMAIL PROTECTED] FlowController#beforeAction} and [EMAIL
PROTECTED] FlowController#afterAction}.
*
* @return the name of the current action being executed.
* @throws IllegalStateException if this method is invoked outside of
action method
- * execution (i.e., outside of the call to [EMAIL PROTECTED]
#execute}, and outside of
- * [EMAIL PROTECTED] #onCreate}, [EMAIL PROTECTED]
#beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * execution (i.e., outside of the call to [EMAIL PROTECTED]
FlowController#execute}, and outside of
+ * [EMAIL PROTECTED] FlowController#onCreate}, [EMAIL
PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*/
protected String getCurrentActionName()
@@ -582,10 +582,10 @@
public abstract String getModulePath();
/**
- * Callback that occurs before any user action method is invoked. [EMAIL
PROTECTED] #getRequest},
- * [EMAIL PROTECTED] #getResponse}, [EMAIL PROTECTED] #getSession}, and
[EMAIL PROTECTED] #getActionMapping} may all be used
+ * Callback that occurs before any user action method is invoked. [EMAIL
PROTECTED] FlowController#getRequest},
+ * [EMAIL PROTECTED] FlowController#getResponse}, [EMAIL PROTECTED]
FlowController#getSession}, and [EMAIL PROTECTED]
FlowController#getActionMapping} may all be used
* during this method. The action to be run can be discovered by calling
- * [EMAIL PROTECTED] ActionMapping#getPath} on the value returned from
[EMAIL PROTECTED] #getActionMapping}.
+ * [EMAIL PROTECTED] ActionMapping#getPath} on the value returned from
[EMAIL PROTECTED] FlowController#getActionMapping}.
*/
protected synchronized void beforeAction()
throws Exception
@@ -593,10 +593,10 @@
}
/**
- * Callback that occurs after any user action method is invoked. [EMAIL
PROTECTED] #getRequest},
- * [EMAIL PROTECTED] #getResponse}, [EMAIL PROTECTED] #getSession}, and
[EMAIL PROTECTED] #getActionMapping} may all be used
+ * Callback that occurs after any user action method is invoked. [EMAIL
PROTECTED] FlowController#getRequest},
+ * [EMAIL PROTECTED] FlowController#getResponse}, [EMAIL PROTECTED]
FlowController#getSession}, and [EMAIL PROTECTED]
FlowController#getActionMapping} may all be used
* during this method. The action that was run can be discovered by
calling
- * [EMAIL PROTECTED] ActionMapping#getPath} on the value returned from
[EMAIL PROTECTED] #getActionMapping}.
+ * [EMAIL PROTECTED] ActionMapping#getPath} on the value returned from
[EMAIL PROTECTED] FlowController#getActionMapping}.
*/
protected synchronized void afterAction()
throws Exception
@@ -604,8 +604,8 @@
}
/**
- * Callback that is invoked when this controller instance is created.
[EMAIL PROTECTED] #getRequest},
- * [EMAIL PROTECTED] #getResponse}, [EMAIL PROTECTED] #getSession} may all
be used during this method.
+ * Callback that is invoked when this controller instance is created.
[EMAIL PROTECTED] FlowController#getRequest},
+ * [EMAIL PROTECTED] FlowController#getResponse}, [EMAIL PROTECTED]
FlowController#getSession} may all be used during this method.
*/
protected void onCreate()
throws Exception
@@ -615,17 +615,17 @@
/**
* Callback that is invoked when this controller instance is "destroyed",
i.e., removed from the
- * user session. [EMAIL PROTECTED] #getRequest}, [EMAIL PROTECTED]
#getResponse}, and [EMAIL PROTECTED] #getActionMapping} may <i>not</i>
+ * user session. [EMAIL PROTECTED] FlowController#getRequest}, [EMAIL
PROTECTED] FlowController#getResponse}, and [EMAIL PROTECTED]
FlowController#getActionMapping} may <i>not</i>
* be used during this method, since it may be called due to session
termination outside of a
- * request. [EMAIL PROTECTED] #getSession} also may not be used, but the
session is passed as an argument
- * to [EMAIL PROTECTED] #onDestroy(javax.servlet.http.HttpSession)}, which
should be used in place of this
+ * request. [EMAIL PROTECTED] FlowController#getSession} also may not be
used, but the session is passed as an argument
+ * to [EMAIL PROTECTED]
FlowController#onDestroy(javax.servlet.http.HttpSession)}, which should be used
in place of this
* method.
* <br>
* Note that this method is <strong>not synchronized</strong>. It is
dangerous to synchronize your override of
* this method because it is invoked during a callback from the Servlet
container. Depending on the container,
* synchronization here can cause deadlocks.
*
- * @deprecated [EMAIL PROTECTED]
#onDestroy(javax.servlet.http.HttpSession)} should be used instead.
+ * @deprecated [EMAIL PROTECTED]
FlowController#onDestroy(javax.servlet.http.HttpSession)} should be used
instead.
*/
protected void onDestroy()
{
@@ -633,9 +633,9 @@
/**
* Callback that is invoked when this controller instance is "destroyed",
i.e., removed from the
- * user session. [EMAIL PROTECTED] #getRequest}, [EMAIL PROTECTED]
#getResponse}, and [EMAIL PROTECTED] #getActionMapping} may <i>not</i>
+ * user session. [EMAIL PROTECTED] FlowController#getRequest}, [EMAIL
PROTECTED] FlowController#getResponse}, and [EMAIL PROTECTED]
FlowController#getActionMapping} may <i>not</i>
* be used during this method, since it may be called due to session
termination outside of a
- * request. [EMAIL PROTECTED] #getSession} also may not be used, but the
session is passed as an argument.
+ * request. [EMAIL PROTECTED] FlowController#getSession} also may not be
used, but the session is passed as an argument.
* <br>
* Note that this method is <strong>not synchronized</strong>. It is
dangerous to synchronize your override of
* this method because it is invoked during a callback from the Servlet
container. Depending on the container,
@@ -853,14 +853,14 @@
}
/**
- * Get the current HttpServletRequest. This call is only valid during
[EMAIL PROTECTED] #execute} (where
- * any user action method is invoked), and during the lifecycle methods
[EMAIL PROTECTED] #onCreate},
- * [EMAIL PROTECTED] #beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * Get the current HttpServletRequest. This call is only valid during
[EMAIL PROTECTED] FlowController#execute} (where
+ * any user action method is invoked), and during the lifecycle methods
[EMAIL PROTECTED] FlowController#onCreate},
+ * [EMAIL PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*
* @return the current HttpServletRequest.
* @throws IllegalStateException if this method is invoked outside of
action method
- * execution (i.e., outside of the call to [EMAIL PROTECTED]
#execute}, and outside of
- * [EMAIL PROTECTED] #onCreate}, [EMAIL PROTECTED]
#beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * execution (i.e., outside of the call to [EMAIL PROTECTED]
FlowController#execute}, and outside of
+ * [EMAIL PROTECTED] FlowController#onCreate}, [EMAIL
PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*/
protected final HttpServletRequest getRequest()
{
@@ -873,14 +873,14 @@
}
/**
- * Get the current HttpServletResponse. This call is only valid during
[EMAIL PROTECTED] #execute} (where
- * any user action method is invoked), and during the lifecycle methods
[EMAIL PROTECTED] #onCreate},
- * [EMAIL PROTECTED] #beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * Get the current HttpServletResponse. This call is only valid during
[EMAIL PROTECTED] FlowController#execute} (where
+ * any user action method is invoked), and during the lifecycle methods
[EMAIL PROTECTED] FlowController#onCreate},
+ * [EMAIL PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*
* @return the current HttpServletResponse.
* @throws IllegalStateException if this method is invoked outside of
action method
- * execution (i.e., outside of the call to [EMAIL PROTECTED]
#execute}, and outside of
- * [EMAIL PROTECTED] #onCreate}, [EMAIL PROTECTED]
#beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * execution (i.e., outside of the call to [EMAIL PROTECTED]
FlowController#execute}, and outside of
+ * [EMAIL PROTECTED] FlowController#onCreate}, [EMAIL
PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*/
protected final HttpServletResponse getResponse()
{
@@ -895,14 +895,14 @@
/**
* Get the current Struts ActionMapping, which is information from the
Struts-XML <action>
* tag that corresponds to the current page flow action being executed.
This call is only valid
- * during [EMAIL PROTECTED] #execute} (where any user action method is
invoked), and during the lifecycle
- * methods [EMAIL PROTECTED] #beforeAction} and [EMAIL PROTECTED]
#afterAction}.
- * @deprecated Use [EMAIL PROTECTED] #getActionMapping} instead.
+ * during [EMAIL PROTECTED] FlowController#execute} (where any user action
method is invoked), and during the lifecycle
+ * methods [EMAIL PROTECTED] FlowController#beforeAction} and [EMAIL
PROTECTED] FlowController#afterAction}.
+ * @deprecated Use [EMAIL PROTECTED] FlowController#getActionMapping}
instead.
*
* @return the current Struts ActionMapping.
* @throws IllegalStateException if this method is invoked outside of
action method
- * execution (i.e., outside of the call to [EMAIL PROTECTED]
#execute}, and outside of
- * [EMAIL PROTECTED] #onCreate}, [EMAIL PROTECTED]
#beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * execution (i.e., outside of the call to [EMAIL PROTECTED]
FlowController#execute}, and outside of
+ * [EMAIL PROTECTED] FlowController#onCreate}, [EMAIL
PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*/
protected final ActionMapping getMapping()
{
@@ -912,13 +912,13 @@
/**
* Get the current Struts ActionMapping, which is information from the
Struts-XML <action>
* tag that corresponds to the current page flow action being executed.
This call is only valid
- * during [EMAIL PROTECTED] #execute} (where any user action method is
invoked), and during the lifecycle
- * methods [EMAIL PROTECTED] #beforeAction} and [EMAIL PROTECTED]
#afterAction}.
+ * during [EMAIL PROTECTED] FlowController#execute} (where any user action
method is invoked), and during the lifecycle
+ * methods [EMAIL PROTECTED] FlowController#beforeAction} and [EMAIL
PROTECTED] FlowController#afterAction}.
*
* @return the current Struts ActionMapping.
* @throws IllegalStateException if this method is invoked outside of
action method
- * execution (i.e., outside of the call to [EMAIL PROTECTED]
#execute}, and outside of
- * [EMAIL PROTECTED] #onCreate}, [EMAIL PROTECTED]
#beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * execution (i.e., outside of the call to [EMAIL PROTECTED]
FlowController#execute}, and outside of
+ * [EMAIL PROTECTED] FlowController#onCreate}, [EMAIL
PROTECTED] FlowController#beforeAction}, [EMAIL PROTECTED]
FlowController#afterAction}.
*/
protected final ActionMapping getActionMapping()
{
@@ -931,14 +931,14 @@
}
/**
- * Get the current user session. This call is only valid during [EMAIL
PROTECTED] #execute} (where
- * any user action method is invoked), and during the lifecycle methods
[EMAIL PROTECTED] #onCreate},
- * [EMAIL PROTECTED] #onDestroy}, [EMAIL PROTECTED] #beforeAction}, [EMAIL
PROTECTED] #afterAction}.
+ * Get the current user session. This call is only valid during [EMAIL
PROTECTED] FlowController#execute} (where
+ * any user action method is invoked), and during the lifecycle methods
[EMAIL PROTECTED] FlowController#onCreate},
+ * [EMAIL PROTECTED] FlowController#onDestroy}, [EMAIL PROTECTED]
FlowController#beforeAction}, [EMAIL PROTECTED] FlowController#afterAction}.
*
* @return the HttpSession for the current user session.
* @throws IllegalStateException if this method is invoked outside of
action method
- * execution (i.e., outside of the call to [EMAIL PROTECTED]
#execute}, and outside of
- * [EMAIL PROTECTED] #onCreate}, [EMAIL PROTECTED]
#onDestroy}, [EMAIL PROTECTED] #beforeAction}, [EMAIL PROTECTED] #afterAction}.
+ * execution (i.e., outside of the call to [EMAIL PROTECTED]
FlowController#execute}, and outside of
+ * [EMAIL PROTECTED] FlowController#onCreate}, [EMAIL
PROTECTED] FlowController#onDestroy}, [EMAIL PROTECTED]
FlowController#beforeAction}, [EMAIL PROTECTED] FlowController#afterAction}.
*/
protected final HttpSession getSession()
{
@@ -1031,7 +1031,7 @@
* Resolve the given action name to a URI. This version assumes that the
ActionServlet
* class should be [EMAIL PROTECTED] PageFlowActionServlet}.
* Note: this method invokes the full action-processing cycle on a [EMAIL
PROTECTED] ScopedRequest}. Use
- * [EMAIL PROTECTED] #resolveAction} to resolve the URI for an
action in the current page flow.
+ * [EMAIL PROTECTED] FlowController#resolveAction} to resolve
the URI for an action in the current page flow.
* @exclude
* @deprecated Use [EMAIL PROTECTED] PageFlowUtils#strutsLookup} instead.
*/
@@ -1045,7 +1045,7 @@
/**
* Resolve the given action name to a URI.
* Note: this method invokes the full action-processing cycle on a [EMAIL
PROTECTED] ScopedRequest}. Use
- * [EMAIL PROTECTED] #resolveAction} to resolve the URI for an
action in the current page flow.
+ * [EMAIL PROTECTED] FlowController#resolveAction} to resolve
the URI for an action in the current page flow.
* @exclude
* @deprecated Use [EMAIL PROTECTED] PageFlowUtils#strutsLookup} instead.
*/
@@ -1097,7 +1097,7 @@
/**
* Call an action and return the result URI.
*
- * @deprecated Use [EMAIL PROTECTED] #resolveAction(String, Object,
HttpServletRequest, HttpServletResponse)} instead.
+ * @deprecated Use [EMAIL PROTECTED] FlowController#resolveAction(String,
Object, HttpServletRequest, HttpServletResponse)} instead.
* @param actionName the name of the action to run.
* @param form the form bean instance to pass to the action, or
<code>null</code> if none should be passed.
* @return the result webapp-relative URI, as a String.
@@ -1154,7 +1154,7 @@
/**
* Get the current Struts ActionServlet.
*
- * @deprecated This method will be removed with no replacement. In most
cases, [EMAIL PROTECTED] #getServletContext()} is
+ * @deprecated This method will be removed with no replacement. In most
cases, [EMAIL PROTECTED] FlowController#getServletContext()} is
* sufficient; for other cases, the ActionServlet itself is in
the ServletContext attribute
* [EMAIL PROTECTED] Globals#ACTION_SERVLET_KEY}.
* @return the ActionServlet.
@@ -1210,7 +1210,7 @@
/**
* Tell whether this is a "singleton" page flow. Once it is invoked, a
singleton page flow is never
- * removed from the session unless [EMAIL PROTECTED] #delete} is called.
Navigating to another page flow hides
+ * removed from the session unless [EMAIL PROTECTED]
FlowController#delete} is called. Navigating to another page flow hides
* the current singleton controller, but does not remove it.
*/
protected boolean isSingleton()
