svn commit: r566983 - in /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider: RequestParameterProvider.java RequestParameterServletFilter.java

[sk...@apache.org]

Author: skitching
Date: Fri Aug 17 02:39:29 2007
New Revision: 566983

URL: http://svn.apache.org/viewvc?view=rev&rev=566983
Log:
Add javadoc only.

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterProvider.java
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterServletFilter.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterProvider.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterProvider.java?view=diff&rev=566983&r1=566982&r2=566983
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterProvider.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterProvider.java Fri Aug 17 02:39:29 2007
@@ -20,17 +20,25 @@
 package org.apache.myfaces.orchestra.requestParameterProvider;
 
 /**
- * The interface a provider has to implement to add parameters to the url
+ * The interface a provider has to implement to add parameters to the url.
+ * <p>
+ * Objects which need to append parameters to all urls in the page being generated
+ * should create an implementation of this interface and register an object of that
+ * type with the RequestParameterProviderManager. When the page is generated the
+ * manager will call back to every registered RequestParameterProvider to get the
+ * data it needs to append.  
  */
 public interface RequestParameterProvider
 {
 	/**
-	 * return the fields you would like to add to the url
+	 * Return the names of fields this instance wants to add to the url. Each value in the
+	 * returned array is then used as a parameter to the getFieldValue method.
 	 */
 	public String[] getFields();
 
 	/**
-	 * return the value for the given field
+	 * Return the value for the given field (which should be one of the values returned
+	 * by the getFields method).
 	 */
 	public String getFieldValue(String field);
 }

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterServletFilter.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterServletFilter.java?view=diff&rev=566983&r1=566982&r2=566983
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterServletFilter.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/requestParameterProvider/RequestParameterServletFilter.java Fri Aug 17 02:39:29 2007
@@ -30,7 +30,8 @@
 import java.io.IOException;
 
 /**
- * This filter wraps each {@link HttpServletRequest} in a {@link RequestParameterResponseWrapper}
+ * This filter wraps each {@link HttpServletRequest} in a {@link RequestParameterResponseWrapper},
+ * meaning that every call to response.encodeURL() gets forwarded to the RequestParameterProviderManager.
  */
 public class RequestParameterServletFilter implements Filter
 {