husted 2003/12/18 20:48:44
Modified: src/share/org/apache/struts/action ActionMessage.java
ActionMapping.java ActionForward.java
ActionFormBean.java
Log:
Javadoc tweaks only. No functional changes.
Revision Changes Path
1.10 +17 -16
jakarta-struts/src/share/org/apache/struts/action/ActionMessage.java
Index: ActionMessage.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionMessage.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ActionMessage.java 5 Oct 2003 17:45:14 -0000 1.9
+++ ActionMessage.java 19 Dec 2003 04:48:44 -0000 1.10
@@ -65,7 +65,7 @@
/**
* <p>An encapsulation of an individual message returned by the
- * <code>validate()</code> method of an <code>ActionForm</code>, consisting
+ * <code>validate</code> method of an <code>ActionForm</code>, consisting
* of a message key (to be used to look up message text in an appropriate
* message resources database) plus up to four placeholder objects that can
* be used for parametric replacement in the message text.</p>
@@ -83,7 +83,7 @@
/**
- * Construct an action message with no replacement values.
+ * <p>Construct an action message with no replacement values.</p>
*
* @param key Message key for this message
*/
@@ -93,7 +93,7 @@
/**
- * Construct an action message with the specified replacement values.
+ * <p>Construct an action message with the specified replacement values.</p>
*
* @param key Message key for this message
* @param value0 First replacement value
@@ -104,7 +104,7 @@
/**
- * Construct an action message with the specified replacement values.
+ * <p>Construct an action message with the specified replacement values.</p>
*
* @param key Message key for this message
* @param value0 First replacement value
@@ -116,7 +116,7 @@
/**
- * Construct an action message with the specified replacement values.
+ * <p>Construct an action message with the specified replacement values.</p>
*
* @param key Message key for this message
* @param value0 First replacement value
@@ -131,7 +131,7 @@
/**
- * Construct an action message with the specified replacement values.
+ * <p>Construct an action message with the specified replacement values.</p>
*
* @param key Message key for this message
* @param value0 First replacement value
@@ -147,7 +147,7 @@
/**
- * Construct an action message with the specified replacement values.
+ * <p>Construct an action message with the specified replacement values.</p>
*
* @param key Message key for this message
* @param values Array of replacement values
@@ -164,13 +164,13 @@
/**
- * The message key for this message.
+ * <p>The message key for this message.</p>
*/
protected String key = null;
/**
- * The replacement values for this mesasge.
+ * <p>The replacement values for this mesasge.</p>
*/
protected Object values[] = null;
@@ -179,7 +179,7 @@
/**
- * Get the message key for this message.
+ * <p>Get the message key for this message.</p>
*/
public String getKey() {
@@ -189,7 +189,7 @@
/**
- * Get the replacement values for this message.
+ * <p>Get the replacement values for this message.</p>
*/
public Object[] getValues() {
@@ -198,7 +198,8 @@
}
/**
- * Returns a String in the format: key[value1, value2, etc].
+ * <p>Returns a String in the format: key[value1, value2, etc].</p>
+ *
* @see java.lang.Object#toString()
*/
public String toString() {
1.29 +19 -18
jakarta-struts/src/share/org/apache/struts/action/ActionMapping.java
Index: ActionMapping.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionMapping.java,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- ActionMapping.java 29 Sep 2003 04:26:23 -0000 1.28
+++ ActionMapping.java 19 Dec 2003 04:48:44 -0000 1.29
@@ -71,11 +71,12 @@
/**
* <p>An <strong>ActionMapping</strong> represents the information that the
- * controller servlet, <code>ActionServlet</code>, knows about the mapping
- * of a particular request to an instance of a particular action class.
- * The ActionMapping instance used to select a particular Action is passed
- * on to that Action, thereby providing access to any custom configuration
- * information included with the ActionMapping object.</p>
+ * controller, <code>RequestProcessor</code>, knows about the mapping
+ * of a particular request to an instance of a particular <code>Action</code> class.
+ * The <code>ActionMapping</code> instance used to select a particular
+ * <code>Action</code> is passed on to that <code>Action</code>, thereby providing
+ * access to any custom configuration information included with the
+ * <code>ActionMapping</code> object.</p>
*
* <p>Since Struts 1.1 this class extends <code>ActionConfig</code>.
*
@@ -93,10 +94,10 @@
/**
* <p>Find and return the <code>ExceptionConfig</code> instance defining
- * how exceptions of the specified type should be handled. This is
- * performed by checking local and then global configurations for the
- * specified exception's class, and then looking up the superclass chain
- * (again checking local and then global configurations). If no handler
+ * how <code>Exceptions</code> of the specified type should be handled.
+ * This is performed by checking local and then global configurations for
+ * the specified exception's class, and then looking up the superclass chain
+ * (again checking local and then global configurations). If no handler
* configuration can be found, return <code>null</code>.</p>
*
* @param type Exception class for which to find a handler
@@ -135,9 +136,9 @@
/**
* <p>Find and return the <code>ForwardConfig</code> instance defining
- * how forwarding to the specified logical name should be handled. This is
+ * how forwarding to the specified logical name should be handled. This is
* performed by checking local and then global configurations for the
- * specified forwarding configuration. If no forwarding configuration
+ * specified forwarding configuration. If no forwarding configuration
* can be found, return <code>null</code>.</p>
*
* @param name Logical name of the forwarding instance to be returned
@@ -155,8 +156,8 @@
/**
* <p>Return the logical names of all locally defined forwards for this
- * mapping. If there are no such forwards, a zero-length array
- * is returned.
+ * mapping. If there are no such forwards, a zero-length array
+ * is returned.</p>
*/
public String[] findForwards() {
@@ -172,7 +173,7 @@
/**
* <p>Create (if necessary) and return an [EMAIL PROTECTED] ActionForward} that
- * corresponds to the <code>input</code> property of this Action.
+ * corresponds to the <code>input</code> property of this Action.</p>
*
* @since Struts 1.1
*/
1.12 +20 -18
jakarta-struts/src/share/org/apache/struts/action/ActionForward.java
Index: ActionForward.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionForward.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ActionForward.java 29 Sep 2003 04:26:23 -0000 1.11
+++ ActionForward.java 19 Dec 2003 04:48:44 -0000 1.12
@@ -67,17 +67,17 @@
/**
- * An <strong>ActionForward</strong> represents a destination to which the
- * controller servlet, <code>ActionServlet</code>, might be directed to
- * perform a <code>RequestDispatcher.forward()</code> or
- * <code>HttpServletResponse.sendRedirect()</code> to, as a result of
- * processing activities of an <code>Action</code> class. Instances of this
+ * <p>An <strong>ActionForward</strong> represents a destination to which the
+ * controller, <code>RequestProcessor</code>, might be directed to
+ * perform a <code>RequestDispatcher.forward</code> or
+ * <code>HttpServletResponse.sendRedirect</code> to, as a result of
+ * processing activities of an <code>Action</code> class. Instances of this
* class may be created dynamically as necessary, or configured in association
* with an <code>ActionMapping</code> instance for named lookup of potentially
- * multiple destinations for a particular mapping instance.
- * <p>
- * An <code>ActionForward</code> has the following minimal set of properties.
- * Additional properties can be provided as needed by subclassses.
+ * multiple destinations for a particular mapping instance.</p>
+ *
+ * <p>An <code>ActionForward</code> has the following minimal set of properties.
+ * Additional properties can be provided as needed by subclassses.</p>
* <ul>
* <li><strong>contextRelative</strong> - Should the <code>path</code>
* value be interpreted as context-relative (instead of
@@ -109,7 +109,7 @@
/**
- * Construct a new instance with default values.
+ * <p>Construct a new instance with default values.</p>
*/
public ActionForward() {
@@ -119,7 +119,7 @@
/**
- * Construct a new instance with the specified path.
+ * <p>Construct a new instance with the specified path.</p>
*
* @param path Path for this instance
*/
@@ -131,7 +131,8 @@
/**
- * Construct a new instance with the specified path and redirect flag.
+ * <p>Construct a new instance with the specified
+ * <code>path</code> and <code>redirect</code> flag.</p>
*
* @param path Path for this instance
* @param redirect Redirect flag for this instance
@@ -147,7 +148,8 @@
/**
- * Construct a new instance with the specified path and redirect flag.
+ * <p>Construct a new instance with the specified <code>name</code>,
+ * <code>path</code> and <code>redirect</code> flag.</p>
*
* @param name Name of this instance
* @param path Path for this instance
@@ -164,7 +166,7 @@
/**
- * Construct a new instance with the specified values.
+ * <p>Construct a new instance with the specified values.</p>
*
* @param name Name of this instance
* @param path Path for this instance
1.10 +12 -13
jakarta-struts/src/share/org/apache/struts/action/ActionFormBean.java
Index: ActionFormBean.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionFormBean.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ActionFormBean.java 29 Sep 2003 04:26:23 -0000 1.9
+++ ActionFormBean.java 19 Dec 2003 04:48:44 -0000 1.10
@@ -67,27 +67,26 @@
/**
- * An <strong>ActionFormBean</strong> is the definition of a form bean that
+ * <p>An <strong>ActionFormBean</strong> is the definition of a form bean that
* is loaded from a <code><form-bean></code> element in the Struts
- * configuration file. It can be subclassed as necessary to add additional
- * properties.
+ * configuration file. It can be subclassed as necessary to add additional
+ * properties.</p>
*
- * @author Craig R. McClanahan
- * @version $Revision$ $Date$
- *
- * Since Struts 1.1 <code>ActionFormBean</code> extends <code>FormBeanConfig</code>.
+ * <p>Since Struts 1.1 <code>ActionFormBean</code> extends
<code>FormBeanConfig</code>.</p>
*
* <p><strong>NOTE</strong> - This class would have been deprecated and
* replaced by <code>org.apache.struts.config.FormBeanConfig</code> except
* for the fact that it is part of the public API that existing applications
* are using.</p>
+ *
+ * @author Craig R. McClanahan
+ * @version $Revision$ $Date$
*/
-
public class ActionFormBean extends FormBeanConfig {
/**
- * Construct an instance with default vaslues.
+ * <p>Construct an instance with default vaslues.</p>
*/
public ActionFormBean() {
@@ -97,7 +96,7 @@
/**
- * Construct an instance with the specified values.
+ * <p>Construct an instance with the specified values.</p>
*
* @param name Form bean name
* @param type Fully qualified class name
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
