husted 2003/12/20 04:54:10
Modified: src/share/org/apache/struts/action SessionActionMapping.java
RequestActionMapping.java
RedirectingActionForward.java PlugIn.java
ForwardingActionForward.java ExceptionHandler.java
DynaActionFormClass.java DynaActionForm.java
ActionServletWrapper.java
Log:
Javadoc tweaks only. No functional changes.
Revision Changes Path
1.7 +10 -10
jakarta-struts/src/share/org/apache/struts/action/SessionActionMapping.java
Index: SessionActionMapping.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/SessionActionMapping.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SessionActionMapping.java 29 Sep 2003 04:35:27 -0000 1.6
+++ SessionActionMapping.java 20 Dec 2003 12:54:10 -0000 1.7
@@ -64,8 +64,8 @@
/**
- * Subclass of <code>ActionMapping</code> that defaults the form bean
- * scope to <code>session</code>.
+ * <p>Subclass of <code>ActionMapping</code> that defaults the form bean
+ * scope to <code>session</code>.</p>
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
@@ -75,13 +75,13 @@
/**
- * Construct a new instance of this class with the desired default
- * form bean scope.
+ * <p>Construct a new instance of this class with the desired default
+ * form bean scope.</p>
*/
public SessionActionMapping() {
- super();
- setScope("session");
+ super();
+ setScope("session");
}
1.7 +10 -10
jakarta-struts/src/share/org/apache/struts/action/RequestActionMapping.java
Index: RequestActionMapping.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/RequestActionMapping.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- RequestActionMapping.java 29 Sep 2003 04:35:27 -0000 1.6
+++ RequestActionMapping.java 20 Dec 2003 12:54:10 -0000 1.7
@@ -64,8 +64,8 @@
/**
- * Subclass of <code>ActionMapping</code> that defaults the form bean
- * scope to <code>request</code>.
+ * <p>Subclass of <code>ActionMapping</code> that defaults the form bean
+ * scope to <code>request</code>.</p>
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
@@ -75,13 +75,13 @@
/**
- * Construct a new instance of this class with the desired default
- * form bean scope.
+ * <p>Construct a new instance of this class with the desired default
+ * form bean scope.</p>
*/
public RequestActionMapping() {
- super();
- setScope("request");
+ super();
+ setScope("request");
}
1.6 +13 -13
jakarta-struts/src/share/org/apache/struts/action/RedirectingActionForward.java
Index: RedirectingActionForward.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/RedirectingActionForward.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RedirectingActionForward.java 29 Sep 2003 04:35:27 -0000 1.5
+++ RedirectingActionForward.java 20 Dec 2003 12:54:10 -0000 1.6
@@ -64,8 +64,8 @@
/**
- * A subclass of <strong>ActionForward</strong> that defaults the
- * <code>redirect</code> attribute to <code>true</code>.
+ * <p>A subclass of <strong>ActionForward</strong> that defaults the
+ * <code>redirect</code> attribute to <code>true</code>.</p>
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
@@ -78,26 +78,26 @@
/**
- * Construct a new instance with default values.
+ * <p>Construct a new instance with default values.</p>
*/
public RedirectingActionForward() {
- this(null);
+ this(null);
}
/**
- * Construct a new instance with the specified path.
+ * <p>Construct a new instance with the specified path.</p>
*
* @param path Path for this instance
*/
public RedirectingActionForward(String path) {
- super();
- setName(null);
- setPath(path);
- setRedirect(true);
+ super();
+ setName(null);
+ setPath(path);
+ setRedirect(true);
}
1.13 +9 -7 jakarta-struts/src/share/org/apache/struts/action/PlugIn.java
Index: PlugIn.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/PlugIn.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- PlugIn.java 29 Sep 2003 04:35:27 -0000 1.12
+++ PlugIn.java 20 Dec 2003 12:54:10 -0000 1.13
@@ -71,16 +71,18 @@
* <p>A <strong>PlugIn</strong> is a configuration wrapper for a
* module-specific resource or service that needs to be notified about
* application startup and application shutdown events (corresponding to when
- * the container calls <code>init()</code> and <code>destroy()</code> on the
- * corresponding [EMAIL PROTECTED] ActionServlet} instance). PlugIn Actions can be
+ * the container calls <code>init</code> and <code>destroy</code> on the
+ * corresponding [EMAIL PROTECTED] ActionServlet} instance). <code>PlugIn</code>
objects can be
* configured in the <code>struts-config.xml</code> file, without the need
* to subclass [EMAIL PROTECTED] ActionServlet} simply to perform application
lifecycle
* activities.</p>
*
* <p>Implementations of this interface must supply a zero-argument constructor
- * for use by [EMAIL PROTECTED] ActionServlet}. Configuration can be accomplished
by
+ * for use by [EMAIL PROTECTED] ActionServlet}. Configuration can be accomplished by
* providing standard JavaBeans property setter methods, which will all have
* been called before the <code>init()</code> method is invoked.</p>
+ *
+ * <p>This interface can be applied to any class, including an Action subclass</p>
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
1.6 +13 -13
jakarta-struts/src/share/org/apache/struts/action/ForwardingActionForward.java
Index: ForwardingActionForward.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ForwardingActionForward.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ForwardingActionForward.java 29 Sep 2003 04:35:27 -0000 1.5
+++ ForwardingActionForward.java 20 Dec 2003 12:54:10 -0000 1.6
@@ -64,8 +64,8 @@
/**
- * A subclass of <strong>ActionForward</strong> that defaults the
- * <code>redirect</code> attribute to <code>false</code>.
+ * <p>A subclass of <code>ActionForward</code> that defaults the
+ * <code>redirect</code> attribute to <code>false</code>.</p>
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
@@ -78,26 +78,26 @@
/**
- * Construct a new instance with default values.
+ * <p>Construct a new instance with default values.</p>
*/
public ForwardingActionForward() {
- this(null);
+ this(null);
}
/**
- * Construct a new instance with the specified path.
+ * <P>Construct a new instance with the specified path.</p>
*
* @param path Path for this instance
*/
public ForwardingActionForward(String path) {
- super();
- setName(null);
- setPath(path);
- setRedirect(false);
+ super();
+ setName(null);
+ setPath(path);
+ setRedirect(false);
}
1.24 +44 -32
jakarta-struts/src/share/org/apache/struts/action/ExceptionHandler.java
Index: ExceptionHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ExceptionHandler.java,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- ExceptionHandler.java 5 Oct 2003 17:45:14 -0000 1.23
+++ ExceptionHandler.java 20 Dec 2003 12:54:10 -0000 1.24
@@ -73,27 +73,31 @@
import org.apache.struts.util.ModuleException;
/**
- * An ExceptionHandler is configured in the Struts configuration file to handle a
- * specific type of exception thrown by an Action's execute method.
+ * <p>An <strong>ExceptionHandler</strong> is configured in the Struts
+ * configuration file to handle a specific type of exception thrown
+ * by an <code>Action.execute</code> method.</p>
*
* @since Struts 1.1
*/
public class ExceptionHandler {
+
/**
- * Commons logging instance.
+ * <p>Commons logging instance.</p>
*/
private static final Log log = LogFactory.getLog(ExceptionHandler.class);
+
/**
- * The message resources for this package.
+ * <p>The message resources for this package.</p>
*/
private static MessageResources messages =
MessageResources.getMessageResources(
"org.apache.struts.action.LocalStrings");
+
/**
- * Handle the exception.
+ * <p>Handle the <code>Exception</code>.
* Return the <code>ActionForward</code> instance (if any) returned by
* the called <code>ExceptionHandler</code>.
*
@@ -145,32 +149,37 @@
this.storeException(request, property, error, forward, ae.getScope());
return forward;
+
}
-
+
+
/**
- * Logs the exception using commons-logging.
+ * <p>Logs the <code>Exception</code> using commons-logging.</p>
* @param e The Exception to log.
* @since Struts 1.2
*/
protected void logException(Exception e){
+
log.debug(messages.getMessage("exception.log"), e);
+
}
+
/**
- * Default implementation for handling an <b>ActionError</b> generated
- * from an Exception during <b>Action</b> delegation. The default
+ * <p>Default implementation for handling an <code>ActionError</code> generated
+ * from an <code>Exception</code> during <code>Action</code> delegation. The
default
* implementation is to set an attribute of the request or session, as
- * defined by the scope provided (the scope from the exception mapping). An
- * <b>ActionErrors</b> instance is created, the error is added to the collection
- * and the collection is set under the Globals.ERROR_KEY.
+ * defined by the scope provided (the scope from the exception mapping). An
+ * <code>ActionErrors</code> instance is created, the error is added to the
collection
+ * and the collection is set under the <code>Globals.ERROR_KEY</code>.</p>
*
- * @param request - The request we are handling
- * @param property - The property name to use for this error
- * @param error - The error generated from the exception mapping
- * @param forward - The forward generated from the input path (from the form or
exception mapping)
- * @param scope - The scope of the exception mapping.
+ * @param request The request we are handling
+ * @param property The property name to use for this error
+ * @param error The error generated from the exception mapping
+ * @param forward The forward generated from the input path (from the form or
exception mapping)
+ * @param scope The scope of the exception mapping.
* @deprecated Use storeException(HttpServletRequest, String, ActionMessage,
ActionForward, String)
- * instead. This will be removed after Struts 1.2.
+ * instead. This will be removed after Struts 1.2.
*/
protected void storeException(
HttpServletRequest request,
@@ -180,21 +189,24 @@
String scope) {
this.storeException(request, property, error, forward, scope);
+ // :TODO: Remove after Struts 1.2
+
}
-
+
+
/**
- * Default implementation for handling an <b>ActionMessage</b> generated
- * from an Exception during <b>Action</b> delegation. The default
+ * <p>Default implementation for handling an <code>ActionMessage</code>
generated
+ * from an <code>Exception</code> during <code>Action</code> delegation. The
default
* implementation is to set an attribute of the request or session, as
- * defined by the scope provided (the scope from the exception mapping). An
- * <b>ActionMessages</b> instance is created, the error is added to the
- * collection and the collection is set under the Globals.ERROR_KEY.
+ * defined by the scope provided (the scope from the exception mapping). An
+ * <code>ActionMessages</code> instance is created, the error is added to the
+ * collection and the collection is set under the
<code>Globals.ERROR_KEY</code>.</p>
*
- * @param request - The request we are handling
- * @param property - The property name to use for this error
- * @param error - The error generated from the exception mapping
- * @param forward - The forward generated from the input path (from the form or
exception mapping)
- * @param scope - The scope of the exception mapping.
+ * @param request The request we are handling
+ * @param property The property name to use for this error
+ * @param error The error generated from the exception mapping
+ * @param forward The forward generated from the input path (from the form or
exception mapping)
+ * @param scope The scope of the exception mapping.
* @since Struts 1.2
*/
protected void storeException(
1.14 +39 -38
jakarta-struts/src/share/org/apache/struts/action/DynaActionFormClass.java
Index: DynaActionFormClass.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/DynaActionFormClass.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- DynaActionFormClass.java 29 Sep 2003 04:35:27 -0000 1.13
+++ DynaActionFormClass.java 20 Dec 2003 12:54:10 -0000 1.14
@@ -80,7 +80,7 @@
* <code>DynaActionForm</code> classes that allow developers to define
* ActionForms without having to individually code all of the classes.
* <strong>NOTE</strong> - This class is only used in the internal
- * implementation of dynamic action form beans. Applications never need
+ * implementation of dynamic action form beans. Applications never need
* to consult this documentation.</p>
*
* @author Craig McClanahan
@@ -95,10 +95,10 @@
/**
- * Construct a new DynaActionFormClass for the specified form bean
- * configuration. This constructor is private; DynaActionFormClass
- * instances will be created as needed via calls to the
- * static <code>createDynaActionFormClass()</code> method.
+ * <p>Construct a new <code>DynaActionFormClass</code? for the specified
+ * form bean configuration. This constructor is private;
+ * <code>DynaActionFormClass</code> instances will be created as needed via
+ * calls to the static <code>createDynaActionFormClass()</code> method.</p>
*
* @param config The FormBeanConfig instance describing the properties
* of the bean to be created
@@ -118,34 +118,35 @@
/**
- * The <code>DynaActionForm</code> implementation <code>Class</code> which
- * we will use to create new bean instances.
+ * <p>The <code>DynaActionForm</code> implementation <code>Class</code>
+ * which we will use to create new bean instances.</p>
*/
protected transient Class beanClass = null;
/**
- * The form bean configuration information for this class.
+ * <p>The form bean configuration information for this class.</p>
*/
protected FormBeanConfig config = null;
/**
- * The "dynamic class name" for this <code>DynaClass</code>.
+ * <p>The "dynamic class name" for this <code>DynaClass</code>.</p>
*/
protected String name = null;
/**
- * The set of dynamic properties that are part of this DynaClass.
+ * <p>The set of dynamic properties that are part of this DynaClass.</p>
*/
protected DynaProperty properties[] = null;
/**
- * The set of dynamic properties that are part of this DynaClass,
- * keyed by the property name. Individual descriptor instances will
- * be the same instances as those in the <code>properties</code> list.
+ * <p>The set of dynamic properties that are part of this
+ * <code>DynaClass</code>, keyed by the property name. Individual
+ * descriptor instances will be the same instances as those in the
+ * <code>properties</code> list.
*/
protected HashMap propertiesMap = new HashMap();
@@ -154,15 +155,15 @@
/**
- * The set of <code>DynaActionFormClass</code> instances that have
- * ever been created, keyed by the form bean name.
+ * <p>The set of <code>DynaActionFormClass</code> instances that have
+ * ever been created, keyed by the form bean name.</p>
*/
protected transient static HashMap dynaClasses = new HashMap();
/**
- * The lockable object we can synchronize on, even if dynaClasses
- * is null,
+ * <p>The lockable object we can synchronize on, even if dynaClasses
+ * is null.</p>
*/
protected static String lock = "";
@@ -171,7 +172,7 @@
/**
- * Return the name of this DynaClass (analogous to the
+ * <p>Return the name of this <code>DynaClass</code> (analogous to the
* <code>getName()</code> method of <code>java.lang.Class</code), which
* allows the same <code>DynaClass</code> implementation class to support
* different dynamic classes, with different sets of properties.
@@ -184,8 +185,8 @@
/**
- * Return a property descriptor for the specified property, if it exists;
- * otherwise, return <code>null</code>.
+ * <p>Return a property descriptor for the specified property, if it exists;
+ * otherwise, return <code>null</code>.</p>
*
* @param name Name of the dynamic property for which a descriptor
* is requested
@@ -205,16 +206,15 @@
/**
* <p>Return an array of <code>DynaProperty</code>s for the properties
- * currently defined in this DynaClass. If no properties are defined, a
- * zero-length array will be returned.</p>
- *
- * <p><strong>FIXME</strong> - Should we really be implementing
- * <code>getBeanInfo()</code> instead, which returns property descriptors
- * and a bunch of other stuff?</p>
+ * currently defined in this <code>DynaClass</code>. If no properties are
+ * defined, a zero-length array will be returned.</p>
*/
public DynaProperty[] getDynaProperties() {
return (properties);
+ // :FIXME: Should we really be implementing
+ // getBeanInfo instead, which returns property descriptors
+ // and a bunch of other stuff?
}
@@ -251,7 +251,7 @@
/**
- * Render a String representation of this object.
+ * <p>Render a <code>String</code> representation of this object.</p>
*/
public String toString() {
@@ -277,7 +277,7 @@
/**
- * Clear our cache of DynaActionFormClass instances.
+ * <p>Clear our cache of <code>DynaActionFormClass</code> instances.</p>
*/
public static void clear() {
@@ -292,8 +292,9 @@
/**
- * Create (if necessary) and return a new <code>DynaActionFormClass</code>
- * instance for the specified form bean configuration instance.
+ * <p>Create (if necessary) and return a new
+ * <code>DynaActionFormClass</code> instance for the specified form bean
+ * configuration instance.</p>
*
* @param config The FormBeanConfig instance describing the properties
* of the bean to be created
@@ -330,10 +331,10 @@
/**
- * Return the implementation class we are using to construct new
+ * <p>Return the implementation class we are using to construct new
* instances, re-introspecting our [EMAIL PROTECTED] FormBeanConfig} if
necessary
* (that is, after being deserialized, since <code>beanClass</code> is
- * marked transient.
+ * marked transient).</p>
*/
protected Class getBeanClass() {
@@ -346,8 +347,8 @@
/**
- * Introspect our form bean configuration to identify the supported
- * properties.
+ * <p>Introspect our form bean configuration to identify the supported
+ * properties.</p>
*
* @param config The FormBeanConfig instance describing the properties
* of the bean to be created
1.11 +63 -48
jakarta-struts/src/share/org/apache/struts/action/DynaActionForm.java
Index: DynaActionForm.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/DynaActionForm.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- DynaActionForm.java 29 Sep 2003 04:35:27 -0000 1.10
+++ DynaActionForm.java 20 Dec 2003 12:54:10 -0000 1.11
@@ -84,11 +84,11 @@
* developer to create a Java class for each type of form bean.</p>
*
* <p><strong>USAGE NOTE</strong> - Since Struts 1.1, the
- * <code>reset()</code> method no longer initializes property values to those
+ * <code>reset</code> method no longer initializes property values to those
* specified in <code><form-property></code> elements in the Struts
* module configuration file. If you wish to utilize that behavior, the
* simplest solution is to subclass <code>DynaActionForm</code> and call
- * the <code>initialize()</code> method inside it.</p>
+ * the <code>initialize</code> method inside it.</p>
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
@@ -101,14 +101,15 @@
/**
- * The DynaActionFormClass with which we are associated.
+ * <p>The <code>DynaActionFormClass</code> with which we are associated.
+ * </p>
*/
protected DynaActionFormClass dynaClass = null;
/**
- * The set of property values for this DynaActionForm, keyed by
- * property name.
+ * <p>The set of property values for this <code>DynaActionForm</code>,
+ * keyed by property name.</p>
*/
protected HashMap dynaValues = new HashMap();
@@ -122,8 +123,6 @@
* definition of this <code>DynaActionForm</code>.</p>
*
* @param mapping The mapping used to select this instance
- *
- * @since Struts 1.1
*/
public void initialize(ActionMapping mapping) {
@@ -144,11 +143,13 @@
}
+ // :FIXME: Is there any point in retaining these reset methods
+ // since they now simply replicate the superclass behavior?
/**
- * <p>Reset all bean properties to their default state. This method is
- * called before the properties are repopulated by the controller
- * servlet.</p>
+ * <p>Reset bean properties to their default state, as needed.
+ * This method is called before the properties are repopulated by
+ * the controller.</p>
*
* <p>The default implementation attempts to forward to the HTTP
* version of this method.</p>
@@ -168,16 +169,15 @@
/**
- * <p>Reset all bean properties to their default state. This method is
- * called before the properties are repopulated by the controller servlet.
- * </p>
+ * <p>Reset bean properties to their default state, as needed. This method is
+ * called before the properties are repopulated by the controller.</p>
*
* <p>The default implementation (since Struts 1.1) does nothing.
* Subclasses may override this method to reset bean properties to
- * default values, or the <code>initialize()</code> method may be used to
+ * default values, or the <code>initialize</code> method may be used to
* initialize property values to those provided in the form property
- * configuration information (which was the previous behavior of
- * this method).</p>
+ * configuration information (which was the behavior of
+ * this method in some release candidates).</p>
*
* @param mapping The mapping used to select this instance
* @param request The servlet request we are processing
@@ -193,8 +193,8 @@
/**
- * Indicates if the specified mapped property contain a value for the specified
- * key value.
+ * <p>Indicates if the specified mapped property contain a value for the
+ * specified key value.</p>
*
* @param name Name of the property to check
* @param key Name of the key to check
@@ -219,7 +219,7 @@
/**
- * Return the value of a simple property with the specified name.
+ * <p>Return the value of a simple property with the specified name.</p>
*
* @param name Name of the property whose value is to be retrieved
*
@@ -254,13 +254,13 @@
} else if (type == Character.TYPE) {
return (new Character((char) 0));
} else if (type == Double.TYPE) {
- return (new Double((double) 0.0));
+ return (new Double(0.0));
} else if (type == Float.TYPE) {
return (new Float((float) 0.0));
} else if (type == Integer.TYPE) {
- return (new Integer((int) 0));
+ return (new Integer(0));
} else if (type == Long.TYPE) {
- return (new Long((int) 0));
+ return (new Long(0));
} else if (type == Short.TYPE) {
return (new Short((short) 0));
} else {
@@ -271,7 +271,8 @@
/**
- * Return the value of an indexed property with the specified name.
+ * <p>Return the value of an indexed property with the specified name.
+ * </p>
*
* @param name Name of the property whose value is to be retrieved
* @param index Index of the value to be retrieved
@@ -304,8 +305,9 @@
/**
- * Return the value of a mapped property with the specified name,
+ * <p>Return the value of a mapped property with the specified name,
* or <code>null</code> if there is no value for the specified key.
+ * </p>
*
* @param name Name of the property whose value is to be retrieved
* @param key Key of the value to be retrieved
@@ -329,10 +331,12 @@
}
}
-
+
+
/**
- * Return the value of a String property with the specified name.
- * This is equivalent to calling <code>(String) dynaForm.get(name)</code>.
+ * <p>Return the value of a <code>String</code> property with the specified
+ * name. This is equivalent to calling
+ * <code>(String) dynaForm.get(name)</code>.</p>
*
* @param name Name of the property whose value is to be retrieved
*
@@ -344,12 +348,16 @@
* @since Struts 1.2
*/
public String getString(String name) {
+
return (String) this.get(name);
+
}
+
/**
- * Return the value of a String[] property with the specified name.
- * This is equivalent to calling <code>(String[]) dynaForm.get(name)</code>.
+ * <p>Return the value of a <code>String[]</code> property with the
+ * specified name. This is equivalent to calling
+ * <code>(String[]) dynaForm.get(name)</code>.</p>
*
* @param name Name of the property whose value is to be retrieved
*
@@ -361,12 +369,15 @@
* @since Struts 1.2
*/
public String[] getStrings(String name) {
+
return (String[]) this.get(name);
+
}
+
/**
- * Return the <code>DynaClass</code> instance that describes the set of
- * properties available for this DynaBean.
+ * <p>Return the <code>DynaClass</code> instance that describes the set
+ * of properties available for this <code>DynaBean</code>.</p>
*/
public DynaClass getDynaClass() {
@@ -374,13 +385,14 @@
}
+
/**
- * Returns the <code>Map</code> containing the property values. This is
+ * <p>Returns the <code>Map</code> containing the property values. This is
* done mostly to facilitate accessing the <code>DynaActionForm</code>
* through JavaBeans accessors, in order to use the JavaServer Pages
- * Standard Tag Library.
- *<p>
- * For instance, the normal JSTL EL syntax for accessing an
+ * Standard Tag Library (JSTL).</p>
+ *
+ * <p>For instance, the normal JSTL EL syntax for accessing an
* <code>ActionForm</code> would be something like this:
* <pre>
* ${formbean.prop}</pre>
@@ -389,6 +401,7 @@
* <code>getMap()</code> method):
* <pre>
* ${dynabean.map.prop}</pre>
+ * </p>
*/
public Map getMap() {
@@ -398,8 +411,8 @@
/**
- * Remove any existing value for the specified key on the
- * specified mapped property.
+ * <p>Remove any existing value for the specified key on the
+ * specified mapped property.</p>
*
* @param name Name of the property for which a value is to
* be removed
@@ -425,7 +438,7 @@
/**
- * Set the value of a simple property with the specified name.
+ * <p>Set the value of a simple property with the specified name.</p>
*
* @param name Name of the property whose value is to be set
* @param value Value to which this property is to be set
@@ -464,7 +477,7 @@
/**
- * Set the value of an indexed property with the specified name.
+ * <p>Set the value of an indexed property with the specified name.</p>
*
* @param name Name of the property whose value is to be set
* @param index Index of the property to be set
@@ -502,7 +515,7 @@
/**
- * Set the value of a mapped property with the specified name.
+ * <p>Set the value of a mapped property with the specified name.</p>
*
* @param name Name of the property whose value is to be set
* @param key Key of the property to be set
@@ -535,7 +548,7 @@
/**
- * Render a String representation of this object.
+ * <p>Render a String representation of this object.</p>
*/
public String toString() {
@@ -601,7 +614,8 @@
/**
- * Set the DynaActionFormClass instance that we are associated with.
+ * <p>Set the <code>DynaActionFormClass</code> instance with which we are
+ * associated.</p>
*
* @param dynaClass The DynaActionFormClass instance for this bean
*/
@@ -616,7 +630,7 @@
/**
- * Return the property descriptor for the specified property name.
+ * <p>Return the property descriptor for the specified property name.</p>
*
* @param name Name of the property for which to retrieve the descriptor
*
@@ -636,7 +650,8 @@
/**
- * Indicates if an object of the source class is assignable to the destination
class.
+ * <p>Indicates if an object of the source class is assignable to the
+ * destination class.</p>
*
* @param dest Destination class
* @param source Source class
1.11 +20 -13
jakarta-struts/src/share/org/apache/struts/action/ActionServletWrapper.java
Index: ActionServletWrapper.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionServletWrapper.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- ActionServletWrapper.java 29 Sep 2003 04:35:27 -0000 1.10
+++ ActionServletWrapper.java 20 Dec 2003 12:54:10 -0000 1.11
@@ -66,11 +66,12 @@
/**
- * Provide a wrapper around an ActionServlet to expose only
+ * <p>Provide a wrapper around an @link(ActionServlet) to expose only
* those methods needed by other objects. When used with an
- * ActionForm, subclasses must be careful that they do
+ * @link(ActionForm), subclasses must be careful that they do
* not return an object with public getters and setters that
- * could be exploited by automatic population of properties.
+ * could be exploited by automatic population of properties.</p>
+ *
* @author Craig R. McClanahan
* @author Ted Husted
* @version $Revision$ $Date$
@@ -79,29 +80,35 @@
public class ActionServletWrapper {
/**
- * The controller servlet instance to which we are attached.
+ * <p>The servlet instance to which we are attached.</p>
*/
protected transient ActionServlet servlet = null;
/**
- * Set servlet to a MultipartRequestHandler.
+ * <p>Set servlet to a <code>MultipartRequestHandler</code>.</p>
+ *
* @param object The MultipartRequestHandler
- * :FIXME: Should this be based on an "setServlet"
- * interface or introspection for a setServlet method?
- * Or, is it safer to just add the types we want as we want them?
*/
public void setServletFor(MultipartRequestHandler object) {
+
object.setServlet(this.servlet);
+ // :FIXME: Should this be based on an "setServlet"
+ // interface or introspection for a setServlet method?
+ // Or, is it safer to just add the types we want as we want them?
+
}
/**
- * Create object and set servlet property.
+ * <p>Create object and set <code>servlet</code> property.</p>
+ *
* @param servlet <code>ActionServlet</code> to wrap
*/
public ActionServletWrapper(ActionServlet servlet) {
+
super();
this.servlet = servlet;
+
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
