svn commit: r230536 - in /struts/core/trunk/src/share/org/apache/struts/chain/contexts: ActionContext.java WebActionContext.java

[ge...@apache.org]

Author: germuska
Date: Sat Aug  6 01:07:53 2005
New Revision: 230536

URL: http://svn.apache.org/viewcvs?rev=230536&view=rev
Log:
attempt to clarify javadoc for getParam() and getParamValues()

Modified:
    struts/core/trunk/src/share/org/apache/struts/chain/contexts/ActionContext.java
    struts/core/trunk/src/share/org/apache/struts/chain/contexts/WebActionContext.java

Modified: struts/core/trunk/src/share/org/apache/struts/chain/contexts/ActionContext.java
URL: http://svn.apache.org/viewcvs/struts/core/trunk/src/share/org/apache/struts/chain/contexts/ActionContext.java?rev=230536&r1=230535&r2=230536&view=diff
==============================================================================
--- struts/core/trunk/src/share/org/apache/struts/chain/contexts/ActionContext.java (original)
+++ struts/core/trunk/src/share/org/apache/struts/chain/contexts/ActionContext.java Sat Aug  6 01:07:53 2005
@@ -106,7 +106,8 @@
 
     /**
      * <p>Return a <code>Map</code> of parameters submitted by the user
-     * as part of this request.</p>
+     * as part of this request.  The keys to this map will be request parameter
+     * names (of type <code>String</code>), and the values will be <code>String[]</code>.</p>
      *
      * <p>This is implemented in analogy with the Request parameters of
      * the Servlet API, but it seems reasonable to expect that any

Modified: struts/core/trunk/src/share/org/apache/struts/chain/contexts/WebActionContext.java
URL: http://svn.apache.org/viewcvs/struts/core/trunk/src/share/org/apache/struts/chain/contexts/WebActionContext.java?rev=230536&r1=230535&r2=230536&view=diff
==============================================================================
--- struts/core/trunk/src/share/org/apache/struts/chain/contexts/WebActionContext.java (original)
+++ struts/core/trunk/src/share/org/apache/struts/chain/contexts/WebActionContext.java Sat Aug  6 01:07:53 2005
@@ -19,10 +19,10 @@
 
 
 import java.util.Map;
-import org.apache.struts.config.ModuleConfig;
-import org.apache.struts.Globals;
-import org.apache.struts.util.MessageResources;
+
 import org.apache.commons.chain.web.WebContext;
+import org.apache.struts.Globals;
+import org.apache.struts.config.ModuleConfig;
 
 /**
  * Subclass of ActionContextBase which is understood to be wrapping
@@ -58,10 +58,21 @@
         return wcontext().getInitParam();
     }
 
+    /**
+     * Return a map whose keys are <code>String</code> request parameter names and whose values
+     * are <code>String</code> values.  For parameters which were submitted with more than one value,
+     * only one value will be returned, as if one called <code>ServletRequest.getParameter(String)</code>
+     * @return
+     */
     public Map getParam() {
         return wcontext().getParam();
     }
 
+    /**
+     * Return a map whose keys are <code>String</code> request parameter names and whose values
+     * are <code>String[]</code> values.
+     * @return
+     */
     public Map getParamValues() {
         return wcontext().getParamValues();
     }



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org