husted 2002/06/24 11:53:01
Modified: src/share/org/apache/struts/action RequestProcessor.java
PlugIn.java ActionServlet.java ActionMessages.java
ActionMessage.java ActionMapping.java
ActionForward.java ActionError.java Action.java
Log:
Add JavaDoc tags for Struts 1.1 classes and methods.
Revision Changes Path
1.9 +7 -7
jakarta-struts/src/share/org/apache/struts/action/RequestProcessor.java
Index: RequestProcessor.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/RequestProcessor.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- RequestProcessor.java 16 Mar 2002 02:07:11 -0000 1.8
+++ RequestProcessor.java 24 Jun 2002 18:53:01 -0000 1.9
@@ -141,7 +141,7 @@
*/
protected Log log = LogFactory.getLog(this.getClass());
-
+
/**
* The controller servlet we are associated with.
*/
@@ -955,7 +955,7 @@
* @param uri Uri or Definition name to forward
* @param request Current page request
* @param response Current page response
- * @since 1.1
+ * @since Struts 1.1
* @author Cedric Dumoulin
*/
protected void doForward(String uri, HttpServletRequest request,
@@ -979,7 +979,7 @@
* @param uri Uri of page to include
* @param request Current page request
* @param response Current page response
- * @since 1.1
+ * @since Struts 1.1
* @author Cedric Dumoulin
*/
protected void doInclude(String uri, HttpServletRequest request,
1.3 +5 -4 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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PlugIn.java 22 Mar 2002 23:47:18 -0000 1.2
+++ PlugIn.java 24 Jun 2002 18:53:01 -0000 1.3
@@ -84,6 +84,7 @@
*
* @author Craig R. McClanahan
* @version $Revision$ $Date$
+ * @since Struts 1.1
*/
public interface PlugIn {
1.107 +48 -21
jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java
Index: ActionServlet.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java,v
retrieving revision 1.106
retrieving revision 1.107
diff -u -r1.106 -r1.107
--- ActionServlet.java 23 Jun 2002 04:05:21 -0000 1.106
+++ ActionServlet.java 24 Jun 2002 18:53:01 -0000 1.107
@@ -130,7 +130,7 @@
* <li>Forms and hyperlinks in the user interface that require business logic
* to be executed will be submitted to a request URI that is mapped to the
* controller servlet.</li>
- * <li>There will be one instance of this servlet class,
+ * <li>There will be <b>one</b> instance of this servlet class,
* which receives and processes all requests that change the state of
* a user's interaction with the application. This component represents
* the "controller" component of an MVC architecture.</li>
@@ -162,7 +162,7 @@
* an instance of that class and cache it for future use.</li>
* <li>Optionally populate the properties of an <code>ActionForm</code> bean
* associated with this mapping.</li>
- * <li>Call the <code>perform()</code> method of this action class, passing
+ * <li>Call the <code>execute</code> method of this action class, passing
* on a reference to the mapping that was used (thereby providing access
* to the underlying ActionServlet and ServletContext, as well as any
* specialized properties of the mapping itself), and the request and
@@ -174,28 +174,17 @@
* on the following servlet initialization parameters, which you will specify
* in the web application deployment descriptor (<code>/WEB-INF/web.xml</code>)
* for your application. Subclasses that specialize this servlet are free to
- * define additional initialization parameters.</p>
+ * define additional initialization parameters. Several of these were
+ * deprecated between the 1.0 and 1.1 releases. The deprecated parameters
+ * are listed after the nominal parameters.</p>
* <ul>
- * <li><strong>application</strong> - Java class name of the application
- * resources bundle base class. [NONE]
- * <em>DEPRECATED - Configure this using the "parameter" attribute
- * of the <message-resources> element.</em></li>
- * <li><strong>bufferSize</strong> - The size of the input buffer used when
- * processing file uploads. [4096]
- * <em>DEPRECATED - Configure this using the "bufferSize" attribute
- * of the <controller> element.</em></li>
* <li><strong>config</strong> - Context-relative path to the XML resource
* containing the configuration information for the default application.
- * [/WEB-INF/struts-config.xml]</li>
+ * [/WEB-INF/struts-config.xml].</li>
* <li><strong>config/foo</strong> - Context-relative path to the XML resource
* containing the configuration information for the sub-application that
* will be at prefix "/foo". This can be repeated as many times as
* required for multiple sub-applications.</li>
- * <li><strong>content</strong> - Default content type and character encoding
- * to be set on each response; may be overridden by a forwarded-to
- * servlet or JSP page. [text/html]
- * <em>DEPRECATED - Configure this using the "contentType" attribute
- * of the <controller> element.</em></li>
* <li><strong>convertHack</strong> - Set to <code>true</code> to force form
* bean population of bean properties that are of Java wrapper class types
* (such as java.lang.Integer) to set the property to <code>null</code>,
@@ -207,6 +196,23 @@
* <li><strong>detail</strong> - The debugging detail level for the Digester
* we utilize to process the application configuration files. Accepts
* values 0 (off) and 1 (least serious) through 6 (most serious). [0]</li>
+ * </ul>
+ * <p>The following parameters may still be used with the Struts 1.1 release but
+ * are <b>deprecated</b>.
+ * <ul>
+ * <li><strong>application</strong> - Java class name of the application
+ * resources bundle base class. [NONE]
+ * <em>DEPRECATED - Configure this using the "parameter" attribute
+ * of the <message-resources> element.</em></li>
+ * <li><strong>bufferSize</strong> - The size of the input buffer used when
+ * processing file uploads. [4096]
+ * <em>DEPRECATED - Configure this using the "bufferSize" attribute
+ * of the <controller> element.</em></li>
+ * <li><strong>content</strong> - Default content type and character encoding
+ * to be set on each response; may be overridden by a forwarded-to
+ * servlet or JSP page. [text/html]
+ * <em>DEPRECATED - Configure this using the "contentType" attribute
+ * of the <controller> element.</em></li>
* <li><strong>factory</strong> - The Java class name of the
* <code>MessageResourcesFactory</code> used to create the application
* <code>MessageResources</code> object.
@@ -305,6 +311,7 @@
/**
* The Digester used to produce ApplicationConfig objects from a
* Struts configuration file.
+ * @since Struts 1.1
*/
protected Digester configDigester = null;
@@ -312,6 +319,7 @@
/**
* The flag to request backwards-compatible conversions for form bean
* properties of the Java wrapper class types.
+ * @since Struts 1.1
*/
protected boolean convertHack = false;
@@ -344,12 +352,14 @@
/**
* The Java base name of our internal resources.
+ * @since Struts 1.1
*/
protected String internalName = "org.apache.struts.action.ActionResources";
/**
* Commons Logging instance.
+ * @since Struts 1.1
*/
protected Log log = LogFactory.getLog(this.getClass());
@@ -357,6 +367,7 @@
/**
* The <code>RequestProcessor</code> instance we will use to process
* all incoming requests.
+ * @since Struts 1.1
*/
protected RequestProcessor processor = null;
@@ -605,6 +616,7 @@
/**
* Return the <code>MessageResources</code> instance containing our
* internal message strings.
+ * @since Struts 1.1
*/
public MessageResources getInternal() {
@@ -652,6 +664,7 @@
/**
* Gracefully terminate use of any sub-applications associated with this
* application (if any).
+ * @since Struts 1.1
*/
protected void destroyApplications() {
@@ -688,6 +701,7 @@
/**
* Gracefully release any configDigester instance that we have created.
+ * @since Struts 1.1
*/
protected void destroyConfigDigester() {
@@ -742,6 +756,7 @@
* sub-application.
*
* @param request The servlet request we are processing
+ * @since Struts 1.1
*/
protected ApplicationConfig getApplicationConfig
(HttpServletRequest request) {
@@ -766,6 +781,7 @@
*
* @exception ServletException if we cannot instantiate a RequestProcessor
* instance
+ * @since Struts 1.1
*/
protected synchronized RequestProcessor
getRequestProcessor(ApplicationConfig config) throws ServletException {
@@ -799,6 +815,7 @@
* configuration resource
*
* @exception ServletException if initialization cannot be performed
+ * @since Struts 1.1
*/
protected ApplicationConfig initApplicationConfig
(String prefix, String path) throws ServletException {
@@ -866,6 +883,7 @@
* @param config ApplicationConfig information for this application
*
* @exception ServletException if initialization cannot be performed
+ * @since Struts 1.1
*/
protected void initApplicationDataSources
(ApplicationConfig config) throws ServletException {
@@ -923,6 +941,7 @@
* @param config ApplicationConfig information for this application
*
* @exception ServletException if initialization cannot be performed
+ * @since Struts 1.1
*/
protected void initApplicationPlugIns
(ApplicationConfig config) throws ServletException {
@@ -962,6 +981,7 @@
* @param config ApplicationConfig information for this application
*
* @exception ServletException if initialization cannot be performed
+ * @since Struts 1.1
*/
protected void initApplicationMessageResources
(ApplicationConfig config) throws ServletException {
@@ -1006,6 +1026,8 @@
* initialized to process Struts application configuraiton files and
* configure a corresponding ApplicationConfig object (which must be
* pushed on to the evaluation stack before parsing begins).</p>
+ *
+ * @since Struts 1.1
*/
protected Digester initConfigDigester() {
@@ -1208,6 +1230,7 @@
*
* @param config The ApplicationConfig object for the default app
*
+ * @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
*/
private void defaultControllerConfig(ApplicationConfig config) {
@@ -1261,6 +1284,7 @@
*
* @param config The ApplicationConfig object for the default app
*
+ * @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
*/
private void defaultFormBeansConfig(ApplicationConfig config) {
@@ -1285,6 +1309,7 @@
*
* @param config The ApplicationConfig object for the default app
*
+ * @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
*/
private void defaultForwardsConfig(ApplicationConfig config) {
@@ -1309,6 +1334,7 @@
*
* @param config The ApplicationConfig object for the default app
*
+ * @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
*/
private void defaultMappingsConfig(ApplicationConfig config) {
@@ -1333,6 +1359,7 @@
*
* @param config The ApplicationConfig object for the default app
*
+ * @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
*/
private void defaultMessageResourcesConfig(ApplicationConfig config) {
1.4 +5 -5
jakarta-struts/src/share/org/apache/struts/action/ActionMessages.java
Index: ActionMessages.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionMessages.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ActionMessages.java 17 Sep 2001 19:58:57 -0000 1.3
+++ ActionMessages.java 24 Jun 2002 18:53:01 -0000 1.4
@@ -86,11 +86,11 @@
* Therefore, no synchronization is required for access to internal
* collections.</p>
*
- * @since 1.1
* @author David Geary
* @author Craig R. McClanahan
* @author David Winterfeldt
- * @revision $Revision$ $Date$
+ * @version $Revision$ $Date$
+ * @since Struts 1.1
*/
public class ActionMessages implements Serializable {
1.5 +5 -5
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.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ActionMessage.java 28 Jan 2002 06:03:31 -0000 1.4
+++ ActionMessage.java 24 Jun 2002 18:53:01 -0000 1.5
@@ -73,10 +73,10 @@
* message resources database) plus up to four placeholder objects that can
* be used for parametric replacement in the message text.</p>
*
- * @since 1.1
* @author Craig R. McClanahan
* @author David Winterfeldt
* @version $Revision$ $Date$
+ * @since Struts 1.1
*/
public class ActionMessage implements Serializable {
1.24 +7 -4
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.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- ActionMapping.java 23 Jan 2002 21:21:09 -0000 1.23
+++ ActionMapping.java 24 Jun 2002 18:53:01 -0000 1.24
@@ -77,6 +77,8 @@
* on to that Action, thereby providing access to any custom configuration
* information included with the ActionMapping object.</p>
*
+ * <p>Since Struts 1.1 this class extends <code>ActionConfig</code>.
+ *
* <p><strong>NOTE</strong> - This class would have been deprecated and
* replaced by <code>org.apache.struts.config.ActionConfig</code> except
* for the fact that it is part of the public API that existing applications
@@ -98,6 +100,7 @@
* configuration can be found, return <code>null</code>.</p>
*
* @param type Exception class for which to find a handler
+ * @since Struts 1.1
*/
public ExceptionConfig findException(Class type) {
1.6 +13 -10
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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ActionForward.java 13 Jan 2002 00:25:35 -0000 1.5
+++ ActionForward.java 24 Jun 2002 18:53:01 -0000 1.6
@@ -93,6 +93,9 @@
* on the associated path; otherwise <code>false</code>. [false]</li>
* </ul>
*
+ * <p>Since Struts 1.1 this class extends <code>ForwardConfig</code>
+ * and inherits the <code>contextRelative</code> property.
+ *
* <p><strong>NOTE</strong> - This class would have been deprecated and
* replaced by <code>org.apache.struts.config.ForwardConfig</code> except
* for the fact that it is part of the public API that existing applications
@@ -110,7 +113,7 @@
*/
public ActionForward() {
- this(null, false);
+ this(null, false);
}
@@ -122,7 +125,7 @@
*/
public ActionForward(String path) {
- this(path, false);
+ this(path, false);
}
@@ -135,10 +138,10 @@
*/
public ActionForward(String path, boolean redirect) {
- super();
- setName(null);
- setPath(path);
- setRedirect(redirect);
+ super();
+ setName(null);
+ setPath(path);
+ setRedirect(redirect);
}
1.8 +6 -4
jakarta-struts/src/share/org/apache/struts/action/ActionError.java
Index: ActionError.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionError.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ActionError.java 28 Jan 2002 06:03:31 -0000 1.7
+++ ActionError.java 24 Jun 2002 18:53:01 -0000 1.8
@@ -76,6 +76,8 @@
* syntax used by the JDK <code>MessageFormat</code> class. Thus, the first
* placeholder is '{0}', the second is '{1}', etc.</p>
*
+ * <p>Since Struts 1.1 <code>ActionError</code> extends <code>ActionMessage</code>.
+ *
* @author Craig R. McClanahan
* @version $Revision$ $Date$
*/
1.40 +5 -4 jakarta-struts/src/share/org/apache/struts/action/Action.java
Index: Action.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/Action.java,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -r1.39 -r1.40
--- Action.java 24 Jun 2002 16:56:31 -0000 1.39
+++ Action.java 24 Jun 2002 18:53:01 -0000 1.40
@@ -528,6 +528,7 @@
* Return the message resources for the current sub-application.
*
* @param request The servlet request we are processing
+ * @since Struts 1.1
*/
protected MessageResources getResources(HttpServletRequest request) {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
