commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r411876 - in /jakarta/commons/proper/chain/trunk: ./ src/java/org/apache/commons/chain/ src/java/org/apache/commons/chain/config/ src/java/org/apache/commons/chain/generic/ src/java/org/apache/commons/chain/impl/ src/java/org/apache/commons...
Date Mon, 05 Jun 2006 18:02:21 GMT
Author: niallp
Date: Mon Jun  5 11:02:19 2006
New Revision: 411876

URL: http://svn.apache.org/viewvc?rev=411876&view=rev
Log:
Fix Checkstyle and Javadoc warnings

- LookupCommand's catalogFactory variable reverted to private (as it was in Chain 1.0)
- DisptachCommand's method, methods and methodKey variables changed to private (not yet released)
- add @since tags for Chain 1.1

Modified:
    jakarta/commons/proper/chain/trunk/checkstyle.xml
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/CatalogFactory.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/Command.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/config/ConfigRuleSet.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchLookupCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/LookupCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogBase.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogFactoryBase.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ChainBase.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ContextBase.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractGetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractSetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainListener.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainResources.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainServlet.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/WebContext.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesGetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesSetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesWebContext.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletGetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletSetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletWebContext.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ChainProcessor.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/PathInfoMapper.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/RequestParameterMapper.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletGetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletPathMapper.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletSetLocaleCommand.java
    jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletWebContext.java

Modified: jakarta/commons/proper/chain/trunk/checkstyle.xml
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/checkstyle.xml?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/checkstyle.xml (original)
+++ jakarta/commons/proper/chain/trunk/checkstyle.xml Mon Jun  5 11:02:19 2006
@@ -117,14 +117,16 @@
           <!-- Checks for blocks. You know, those {}'s         -->
           <!-- See http://checkstyle.sf.net/config_blocks.html -->
           <module name="AvoidNestedBlocks"/>
-          <module name="EmptyBlock"/>
+          <module name="EmptyBlock">
+             <property name="option" value="text"/>
+          </module>
           
           <module name="NeedBraces"/>
   
   
           <!-- Checks for common coding problems               -->
           <!-- See http://checkstyle.sf.net/config_coding.html -->
-          <module name="AvoidInlineConditionals"/>
+          <!-- module name="AvoidInlineConditionals"/ -->
           <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
           <module name="EmptyStatement"/>
           <module name="EqualsHashCode"/>

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/CatalogFactory.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/CatalogFactory.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/CatalogFactory.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/CatalogFactory.java Mon Jun  5 11:02:19 2006
@@ -124,6 +124,8 @@
      *  if either the command name or the catalog name cannot be resolved
      * @throws IllegalArgumentException if the commandID contains more than
      *  one DELIMITER
+     *
+     * @since Chain 1.1
      */
     public Command getCommand(String commandID) {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/Command.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/Command.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/Command.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/Command.java Mon Jun  5 11:02:19 2006
@@ -81,7 +81,9 @@
     /**
      * <p>Commands should return <code>CONTINUE_PROCESSING</code> if the processing
      *  of the given {@link Context} should be delegated to a subsequent
-     *  {@link Command} in an enclosing {@link Chain}</p>
+     *  {@link Command} in an enclosing {@link Chain}.</p>
+     *
+     * @since Chain 1.1
      */
     public static final boolean CONTINUE_PROCESSING = false;
 
@@ -89,6 +91,8 @@
      * <p>Commands should return <code>PROCESSING_COMPLETE</code>
      * if the processing of the given {@link Context}
      *  has been completed.</p>
+     *
+     * @since Chain 1.1
      */
     public static final boolean PROCESSING_COMPLETE = true;
     /**

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/config/ConfigRuleSet.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/config/ConfigRuleSet.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/config/ConfigRuleSet.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/config/ConfigRuleSet.java Mon Jun  5 11:02:19 2006
@@ -23,44 +23,50 @@
 /**
  * <p>Digester <code>RuleSet</code> for configuring <em>Chain of
  * Responsibility</em> command chains, and adding them to an appropriate
- * {@link Catalog}.  The following properties may be configured prior to
- * executing the <code>addRuleInstance()</code> method in order to influence
- * the rules that get added, with default values in square brackets:</p>
+ * {@link org.apache.commons.chain.Catalog}.  The following properties
+ * may be configured prior to executing the <code>addRuleInstance()</code>
+ * method in order to influence the rules that get added, with default
+ * values in square brackets:</p>
  * <ul>
  * <li><strong>catalogClass</strong> -- Fully qualified name of the
- *     implementation class used to create new {@link Catalog} instances.
+ *     implementation class used to create new
+ *     {@link org.apache.commons.chain.Catalog} instances.
  *     If not specified, the default value is
  *     <code>org.apache.commons.chain.impl.CatalogBsae</code>.</li>
  * <li><strong>catalogElement</strong> -- Name of the XML element representing
- *     the addition of a {@link Catalog}.  Any such catalog that is created
- *     will be registered with the {@link CatalogFactory} instance for our
+ *     the addition of a {@link org.apache.commons.chain.Catalog}.
+ *     Any such catalog that is created will be registered with the
+ *     {@link org.apache.commons.chain.CatalogFactory} instance for our
  *     application, under the name specified by the <code>nameAttribute</code>
- *     attribute (if present), or as the default {@link Catalog}.  If not
- *     specified, the default value is <code>catalog</code>.</li>
+ *     attribute (if present), or as the default {@link org.apache.commons.chain.Catalog}.
+ *     If not specified, the default value is <code>catalog</code>.</li>
  * <li><strong>chainClass</strong> -- Fully qualified name of the implementation
- *     class used to create new {@link Chain} instances.  If not specified, the
- *     default value is <code>org.apache.commons.chain.impl.ChainBase</code>.
+ *     class used to create new {@link org.apache.commons.chain.Chain} instances.
+ *     If not specified, the default value is
+ *     <code>org.apache.commons.chain.impl.ChainBase</code>.
  *     </li>
  * <li><strong>chainElement</strong> -- Name of the XML element representing
- *     the addition of a {@link Chain}.  A chain element has the same
- *     functionality as a command element, except that it defaults the
- *     implementation class to
+ *     the addition of a {@link org.apache.commons.chain.Chain}.  A chain
+ *     element has the same functionality as a command element, except that
+ *     it defaults the implementation class to
  *     <code>org.apache.commons.chain.impl.ChainBase</code>.  [chain]</li>
  * <li><strong>classAttribute</strong> -- Attribute on a chain (optional) or
  *     command (required) element that specifies the fully qualified class
  *     name of the implementation class that should be instantiated.
  *     [className]</li>
  * <li><strong>commandElement</strong> -- Name of the XML element
- *     representing the addition of a {@link Command}.  An implementation
- *     class name must be provided on the attribute named by the
+ *     representing the addition of a {@link org.apache.commons.chain.Command}.
+ *     An implementation class name must be provided on the attribute named by the
  *     <code>classAttribute</code> property.  [command]</li>
  * <li><strong>defineElement</strong> -- Name of the XML element
  *     that associates the element specified by the <code>nameAttribute</code>
- *     attributes with a {@link Command} or {@link Chain} implementation class
+ *     attributes with a {@link org.apache.commons.chain.Command} or
+ *     {@link org.apache.commons.chain.Chain} implementation class
  *     named by the <code>classAttribute</code> attribute.  [define]</li>
  * <li><strong>nameAttribute</strong> -- Attribute on an outermost chain or
  *     command element that will be used to register this command with the
- *     associated {@link Catalog} instance on the stack.  [name]</li>
+ *     associated {@link org.apache.commons.chain.Catalog} instance on the stack.
+ *     [name]</li>
  * <li><strong>namespaceURI</strong> -- The XML namespace URI with which these
  *     rules will be associated, or <code>null</code> for no namespace.
  *     [null]</li>
@@ -90,7 +96,8 @@
 
 
     /**
-     * <p>Return the fully qualified {@link Catalog} implementation class.</p>
+     * <p>Return the fully qualified {@link org.apache.commons.chain.Catalog}
+     *  implementation class.</p>
      * @return The Catalog's class name.
      */
     public String getCatalogClass() {
@@ -99,9 +106,11 @@
 
 
     /**
-     * <p>Set the fully qualified {@link Catalog} implementation class.</p>
+     * <p>Set the fully qualified {@link org.apache.commons.chain.Catalog}
+     * implementation class.</p>
      *
-     * @param catalogClass The new {@link Catalog} implementation class
+     * @param catalogClass The new {@link org.apache.commons.chain.Catalog}
+     *  implementation class
      */
     public void setCatalogClass(String catalogClass) {
         this.catalogClass = catalogClass;
@@ -128,7 +137,8 @@
 
 
     /**
-     * <p>Return the fully qualified {@link Chain} implementation class.</p>
+     * <p>Return the fully qualified {@link org.apache.commons.chain.Chain}
+     * implementation class.</p>
      * @return The Chain's class name.
      */
     public String getChainClass() {
@@ -137,9 +147,11 @@
 
 
     /**
-     * <p>Set the fully qualified {@link Chain} implementation class.</p>
+     * <p>Set the fully qualified {@link org.apache.commons.chain.Chain}
+     * implementation class.</p>
      *
-     * @param chainClass The new {@link Chain} implementation class
+     * @param chainClass The new {@link org.apache.commons.chain.Chain}
+     * implementation class
      */
     public void setChainClass(String chainClass) {
         this.chainClass = chainClass;

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchCommand.java Mon Jun  5 11:02:19 2006
@@ -20,23 +20,26 @@
 
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.util.Map;
 import java.util.WeakHashMap;
 
 /**
  * An abstract base command which uses introspection to look up a method to execute.
  * For use by developers who prefer to group related functionality into a single class
  * rather than an inheritance family.
+ *
+ * @since Chain 1.1
  */
 public abstract class DispatchCommand implements Command {
 
     /** Cache of methods */
-    protected WeakHashMap methods = new WeakHashMap();
+    private Map methods = new WeakHashMap();
 
     /** Method name */
-    protected String method = null;
+    private String method = null;
 
     /** Method key */
-    protected String methodKey = null;
+    private String methodKey = null;
 
     /**
      * The base implementation expects dispatch methods to take a <code>Context</code>
@@ -48,17 +51,13 @@
     /**
      * Look up the method specified by either "method" or "methodKey" and invoke it,
      * returning a boolean value as interpreted by <code>evaluateResult</code>.
-     * @param context
-     * @return
+     * @param context The Context to be processed by this Command.
+     * @return the result of method being dispatched to.
      * @throws IllegalStateException if neither 'method' nor 'methodKey' properties are defined
      * @throws Exception if any is thrown by the invocation.  Note that if invoking the method
      * results in an InvocationTargetException, the cause of that exception is thrown instead of
      * the exception itself, unless the cause is an <code>Error</code> or other <code>Throwable</code>
      * which is not an <code>Exception</code>.
-     *
-     * @param context The Context to be processed by this Command.
-     *
-     * @return the result of method being dispatched to.
      */
     public boolean execute(Context context) throws Exception {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchLookupCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchLookupCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchLookupCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/DispatchLookupCommand.java Mon Jun  5 11:02:19 2006
@@ -26,7 +26,8 @@
 /**
  * <p>This command combines elements of the {@link LookupCommand} with the
  * {@link DispatchCommand}.  Look up a specified {@link Command} (which could
- * also be a {@link Chain}) in a {@link Catalog}, and delegate execution to
+ * also be a {@link org.apache.commons.chain.Chain}) in a
+ * {@link org.apache.commons.chain.Catalog}, and delegate execution to
  * it.  Introspection is used to lookup the appropriate method to delegate
  * execution to.  If the delegated-to {@link Command} is also a
  * {@link Filter}, its <code>postprocess()</code> method will also be invoked
@@ -47,6 +48,7 @@
  *
  * @author Sean Schofield
  * @version $Revision$
+ * @since Chain 1.1
  */
 
 public class DispatchLookupCommand extends LookupCommand implements Filter {

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/LookupCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/LookupCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/LookupCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/generic/LookupCommand.java Mon Jun  5 11:02:19 2006
@@ -24,7 +24,8 @@
 
 
 /**
- * <p>Look up a specified {@link Command} (which could also be a {@link Chain})
+ * <p>Look up a specified {@link Command} (which could also be a
+ * {@link org.apache.commons.chain.Chain})
  * in a {@link Catalog}, and delegate execution to it.  If the delegated-to
  * {@link Command} is also a {@link Filter}, its <code>postprocess()</code>
  * method will also be invoked at the appropriate time.</p>
@@ -50,6 +51,8 @@
     /**
      * Create an instance, setting its <code>catalogFactory</code> property to the
      * value of <code>CatalogFactory.getInstance()</code>.
+     *
+     * @since Chain 1.1
      */
     public LookupCommand() {
         this(CatalogFactory.getInstance());
@@ -60,6 +63,8 @@
      * to given <code>factory</code>/
      *
      * @param factory The Catalog Factory.
+     *
+     * @since Chain 1.1
      */
     public LookupCommand(CatalogFactory factory) {
         this.catalogFactory = factory;
@@ -68,13 +73,15 @@
 
     // -------------------------------------------------------------- Properties
 
-    protected CatalogFactory catalogFactory = null;
+    private CatalogFactory catalogFactory = null;
 
     /**
      * <p>Set the {@link CatalogFactory} from which lookups will be
      * performed.</p>
      *
      * @param catalogFactory The Catalog Factory.
+     *
+     * @since Chain 1.1
      */
     public void setCatalogFactory(CatalogFactory catalogFactory) {
         this.catalogFactory = catalogFactory;
@@ -83,6 +90,8 @@
     /**
      * Return the {@link CatalogFactory} from which lookups will be performed.
      * @return The Catalog factory.
+     *
+     * @since Chain 1.1
      */
     public CatalogFactory getCatalogFactory() {
 
@@ -209,6 +218,8 @@
      * command.</p>
      * @return <code>true</code> if result of the looked up Command
      * should be ignored.
+     *
+     * @since Chain 1.1
      */
     public boolean isIgnoreExecuteResult() {
         return ignoreExecuteResult;
@@ -223,6 +234,8 @@
      * value should be set to <code>true</code></p>
      * @param ignoreReturn <code>true</code> if result of the
      * looked up Command should be ignored.
+     *
+     * @since Chain 1.1
      */
     public void setIgnoreExecuteResult(boolean ignoreReturn) {
         this.ignoreExecuteResult = ignoreReturn;
@@ -239,6 +252,8 @@
      * Filter.</p>
      * @return <code>true</code> if result of the looked up Filter's
      * <code>postprocess()</code> method should be ignored.
+     *
+     * @since Chain 1.1
      */
     public boolean isIgnorePostprocessResult() {
         return ignorePostprocessResult;
@@ -253,6 +268,8 @@
      * value should be set to <code>true</code></p>
      * @param ignorePostprocessResult <code>true</code> if result of the
      * looked up Filter's <code>postprocess()</code> method should be ignored.
+     *
+     * @since Chain 1.1
      */
     public void setIgnorePostprocessResult(boolean ignorePostprocessResult) {
         this.ignorePostprocessResult = ignorePostprocessResult;

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogBase.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogBase.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogBase.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogBase.java Mon Jun  5 11:02:19 2006
@@ -49,29 +49,49 @@
 
     // --------------------------------------------------------- Constructors
 
+    /**
+     * Create an empty catalog.
+     */
     public CatalogBase() { }
 
     /**
      * <p>Create a catalog whose commands are those specified in the given <code>Map</code>.
      * All Map keys should be <code>String</code> and all values should be <code>Command</code>.</p>
-     *  
-     * @param commands
+     *
+     * @param commands Map of Commands.
+     *
+     * @since Chain 1.1
      */
     public CatalogBase( Map commands ) {
         this.commands = Collections.synchronizedMap(commands);
     }
-    
+
     // --------------------------------------------------------- Public Methods
 
 
-    // Documented in Catalog interface
+    /**
+     * <p>Add a new name and associated {@link Command}
+     * to the set of named commands known to this {@link Catalog},
+     * replacing any previous command for that name.
+     *
+     * @param name Name of the new command
+     * @param command {@link Command} to be returned
+     *  for later lookups on this name
+     */
     public void addCommand(String name, Command command) {
 
         commands.put(name, command);
 
     }
 
-    // Documented in Catalog interface
+    /**
+     * <p>Return the {@link Command} associated with the
+     * specified name, if any; otherwise, return <code>null</code>.</p>
+     *
+     * @param name Name for which a {@link Command}
+     *  should be retrieved
+     * @return The Command associated with the specified name.
+     */
     public Command getCommand(String name) {
 
         return ((Command) commands.get(name));
@@ -79,7 +99,12 @@
     }
 
 
-    // Documented in Catalog interface
+    /**
+     * <p>Return an <code>Iterator</code> over the set of named commands
+     * known to this {@link Catalog}.  If there are no known commands,
+     * an empty Iterator is returned.</p>
+     * @return An iterator of the names in this Catalog.
+     */
     public Iterator getNames() {
 
         return (commands.keySet().iterator());

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogFactoryBase.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogFactoryBase.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogFactoryBase.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/CatalogFactoryBase.java Mon Jun  5 11:02:19 2006
@@ -60,7 +60,12 @@
     // --------------------------------------------------------- Public Methods
 
 
-    // Documented in CatalogFactory interface
+    /**
+     * <p>Gets the default instance of Catalog associated with the factory
+     * (if any); otherwise, return <code>null</code>.</p>
+     *
+     * @return the default Catalog instance
+     */
     public Catalog getCatalog() {
 
         return catalog;
@@ -68,7 +73,11 @@
     }
 
 
-    // Documented in CatalogFactory interface
+    /**
+     * <p>Sets the default instance of Catalog associated with the factory.</p>
+     *
+     * @param catalog the default Catalog instance
+     */
     public void setCatalog(Catalog catalog) {
 
         this.catalog = catalog;
@@ -76,7 +85,13 @@
     }
 
 
-    // Documented in CatalogFactory interface
+    /**
+     * <p>Retrieves a Catalog instance by name (if any); otherwise
+     * return <code>null</code>.</p>
+     *
+     * @param name the name of the Catalog to retrieve
+     * @return the specified Catalog
+     */
     public Catalog getCatalog(String name) {
 
         synchronized (catalogs) {
@@ -86,7 +101,13 @@
     }
 
 
-    // Documented in CatalogFactory interface
+    /**
+     * <p>Adds a named instance of Catalog to the factory (for subsequent
+     * retrieval later).</p>
+     *
+     * @param name the name of the Catalog to add
+     * @param catalog the Catalog to add
+     */
     public void addCatalog(String name, Catalog catalog) {
 
         synchronized (catalogs) {
@@ -96,7 +117,12 @@
     }
 
 
-    // Documented in CatalogFactory interface
+    /**
+     * <p>Return an <code>Iterator</code> over the set of named
+     * {@link Catalog}s known to this {@link CatalogFactory}.
+     * If there are no known catalogs, an empty Iterator is returned.</p>
+     * @return An Iterator of the names of the Catalogs known by this factory.
+     */
     public Iterator getNames() {
 
         synchronized (catalogs) {

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ChainBase.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ChainBase.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ChainBase.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ChainBase.java Mon Jun  5 11:02:19 2006
@@ -127,7 +127,15 @@
     // ---------------------------------------------------------- Chain Methods
 
 
-    // Documented in Chain interface
+    /**
+     * See the {@link Chain} JavaDoc.
+     *
+     * @param command The {@link Command} to be added
+     *
+     * @exception IllegalArgumentException if <code>command</code>
+     *  is <code>null</code>
+     * @exception IllegalStateException if no further configuration is allowed
+     */
     public void addCommand(Command command) {
 
         if (command == null) {
@@ -144,7 +152,23 @@
     }
 
 
-    // Documented in Chain interface
+    /**
+     * See the {@link Chain} JavaDoc.
+     *
+     * @param context The {@link Context} to be processed by this
+     *  {@link Chain}
+     *
+     * @throws Exception if thrown by one of the {@link Command}s
+     *  in this {@link Chain} but not handled by a <code>postprocess()</code>
+     *  method of a {@link Filter}
+     * @throws IllegalArgumentException if <code>context</code>
+     *  is <code>null</code>
+     *
+     * @return <code>true</code> if the processing of this {@link Context}
+     *  has been completed, or <code>false</code> if the processing
+     *  of this {@link Context} should be delegated to a subsequent
+     *  {@link Command} in an enclosing {@link Chain}
+     */
     public boolean execute(Context context) throws Exception {
 
         // Verify our parameters
@@ -160,7 +184,7 @@
         boolean saveResult = false;
         Exception saveException = null;
         int i = 0;
-        int n = commands.length;;
+        int n = commands.length;
         for (i = 0; i < n; i++) {
             try {
                 saveResult = commands[i].execute(context);
@@ -189,7 +213,7 @@
                         handled = true;
                     }
                 } catch (Exception e) {
-                    ; // Silently ignore
+                      // Silently ignore
                 }
             }
         }

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ContextBase.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ContextBase.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ContextBase.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/impl/ContextBase.java Mon Jun  5 11:02:19 2006
@@ -165,6 +165,9 @@
      * <code>true</code> if the specified value is present in either the
      * underlying <code>Map</code> or one of the local property values.</p>
      *
+     * @param value the value look for in the context.
+     * @return <code>true</code> if found in this context otherwise
+     *  <code>false</code>.
      * @exception IllegalArgumentException if a property getter
      *  throws an exception
      */
@@ -204,6 +207,8 @@
      * for attempts to remove the key for a property of the {@link Context}
      * implementation class, which will throw
      * <code>UnsupportedOperationException</code>.</p>
+     *
+     * @return Set of entries in the Context.
      */
     public Set entrySet() {
 
@@ -223,6 +228,7 @@
      * the contracts of the <code>Map</code> interface.</p>
      *
      * @param key Key of the value to be returned
+     * @return The value for the specified key.
      *
      * @exception IllegalArgumentException if an exception is thrown
      *  reading this local property value
@@ -259,6 +265,9 @@
      * <p>Override the default <code>Map</code> behavior to return
      * <code>true</code> if the underlying <code>Map</code> only contains
      * key-value pairs for local properties (if any).</p>
+     *
+     * @return <code>true</code> if this Context is empty, otherwise
+     *  <code>false</code>.
      */
     public boolean isEmpty() {
 
@@ -279,6 +288,8 @@
      * for attempts to remove the key for a property of the {@link Context}
      * implementation class, which will throw
      * <code>UnsupportedOperationException</code>.</p>
+     *
+     * @return The set of keys for objects in this Context.
      */
     public Set keySet() {
 
@@ -295,6 +306,7 @@
      *
      * @param key Key of the value to be stored or replaced
      * @param value New value to be stored
+     * @return The value added to the Context.
      *
      * @exception IllegalArgumentException if an exception is thrown
      *  reading or wrting this local property value
@@ -358,6 +370,7 @@
      * remove a key that is the name of a local property.</p>
      *
      * @param key Key to be removed
+     * @return The value removed from the Context.
      *
      * @exception UnsupportedOperationException if the specified
      *  <code>key</code> matches the name of a local property
@@ -391,6 +404,8 @@
      * for attempts to remove the key for a property of the {@link Context}
      * implementation class, which will throw
      * <code>UnsupportedOperationException</code>.</p>
+     *
+     * @return The collection of values in this Context.
      */
     public Collection values() {
 
@@ -583,7 +598,7 @@
                     ("Property '" + descriptor.getName()
                      + "' is not writeable");
             }
-            method.invoke(this, new Object[] { value });
+            method.invoke(this, new Object[] {value});
         } catch (Exception e) {
             throw new UnsupportedOperationException
                 ("Exception writing property '" + descriptor.getName()
@@ -648,7 +663,7 @@
      */
     private class EntrySetIterator implements Iterator {
 
-        Map.Entry entry = null;
+        private Map.Entry entry = null;
         private Iterator keys = ContextBase.this.keySet().iterator();
 
         public boolean hasNext() {
@@ -775,7 +790,7 @@
      */
     private class ValuesIterator implements Iterator {
 
-        Map.Entry entry = null;
+        private Map.Entry entry = null;
         private Iterator keys = ContextBase.this.keySet().iterator();
 
         public boolean hasNext() {

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractGetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractGetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractGetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractGetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -45,6 +45,8 @@
     /**
      * <p>Return the context attribute key under which we will store
      * the request <code>Locale</code>.</p>
+     *
+     * @return The context attribute key of the request <code>Locale</code>.
      */
     public String getLocaleKey() {
 
@@ -76,6 +78,7 @@
      * @param context The {@link Context} we are operating on
      *
      * @return <code>false</code> so that processng will continue
+     * @throws Exception If an error occurs during execution.
      */
     public boolean execute(Context context) throws Exception {
 
@@ -90,6 +93,8 @@
 
     /**
      * <p>Retrieve and return the <code>Locale</code> for this request.</p>
+     * @param context The {@link Context} we are operating on.
+     * @return The Locale for the request.
      */
     protected abstract Locale getLocale(Context context);
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractSetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractSetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractSetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/AbstractSetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -46,6 +46,8 @@
     /**
      * <p>Return the context attribute key under which we will retrieve
      * the response <code>Locale</code>.</p>
+     *
+     * @return The context attribute key of the request <code>Locale</code>.
      */
     public String getLocaleKey() {
 
@@ -77,6 +79,7 @@
      * @param context The {@link Context} we are operating on
      *
      * @return <code>false</code> so that processng will continue
+     * @throws Exception If an error occurs during execution.
      */
     public boolean execute(Context context) throws Exception {
 
@@ -92,6 +95,9 @@
 
     /**
      * <p>Establish the specified <code>Locale</code> for this response.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @param locale The Locale for the request.
      */
     protected abstract void setLocale(Context context, Locale locale);
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainListener.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainListener.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainListener.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainListener.java Mon Jun  5 11:02:19 2006
@@ -274,7 +274,7 @@
                 try {
                     is = resourceURL.openStream();
                 } catch (Exception e) {
-                    ; // means there is no such resource
+                      // means there is no such resource
                 }
                 if (is == null) {
                     continue;
@@ -332,7 +332,7 @@
                 try {
                     is = resourceURL.openStream();
                 } catch (Exception e) {
-                    ; // means there is no such resource
+                      // means there is no such resource
                 }
                 if (is == null) {
                     continue;

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainResources.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainResources.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainResources.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainResources.java Mon Jun  5 11:02:19 2006
@@ -224,6 +224,8 @@
      *                  <code>null</code>).
      *
      * @return An array of non-empty paths. The array itself may be empty.
+     *
+     * @since Chain 1.1
      */
     static String[] getResourcePaths(String resources) {
         List paths = new ArrayList();
@@ -246,7 +248,7 @@
         }
 
         return (String[]) paths.toArray(new String[0]);
-    }        
+    }
 
 
 }

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainServlet.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainServlet.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainServlet.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/ChainServlet.java Mon Jun  5 11:02:19 2006
@@ -243,7 +243,7 @@
                         HttpServletResponse response)
         throws ServletException, IOException {
 
-        ; // do nothing
+          // do nothing
 
     }
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/WebContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/WebContext.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/WebContext.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/WebContext.java Mon Jun  5 11:02:19 2006
@@ -21,9 +21,9 @@
 
 
 /**
- * <p>Abstract base implementation of {@link Context} that provides web
- * based applications that use it a "generic" view of HTTP related requests
- * and responses, without tying the application to a particular underlying
+ * <p>Abstract base implementation of {@link org.apache.commons.chain.Context} that
+ * provides web based applications that use it a "generic" view of HTTP related
+ * requests and responses, without tying the application to a particular underlying
  * Java API (such as servlets).  It is expected that a concrete subclass
  * of {@link WebContext} for each API (such as
  * {@link org.apache.commons.chain.web.servlet.ServletWebContext})
@@ -47,6 +47,8 @@
     /**
      * <p>Return a mutable <code>Map</code> that maps application scope
      * attribute names to their values.</p>
+     *
+     * @return Application scope Map.
      */
     public abstract Map getApplicationScope();
 
@@ -55,6 +57,8 @@
      * <p>Return an immutable <code>Map</code> that maps header names to
      * the first (or only) header value (as a String).  Header names must
      * be matched in a case-insensitive manner.</p>
+     *
+     * @return Header values Map.
      */
     public abstract Map getHeader();
 
@@ -63,6 +67,8 @@
      * <p>Return an immutable <code>Map</code> that maps header names to
      * the set of all values specified in the request (as a String array).
      * Header names must be matched in a case-insensitive manner.</p>
+     *
+     * @return Header values Map.
      */
     public abstract Map getHeaderValues();
 
@@ -70,6 +76,8 @@
     /**
      * <p>Return an immutable <code>Map</code> that maps context application
      * initialization parameters to their values.</p>
+     *
+     * @return Initialization parameter Map.
      */
     public abstract Map getInitParam();
 
@@ -77,6 +85,8 @@
     /**
      * <p>Return an immutable <code>Map</code> that maps request parameter
      * names to the first (or only) value (as a String).</p>
+     *
+     * @return Request parameter Map.
      */
     public abstract Map getParam();
 
@@ -84,6 +94,8 @@
     /**
      * <p>Return an immutable <code>Map</code> that maps request parameter
      * names to the set of all values (as a String array).</p>
+     *
+     * @return Request parameter Map.
      */
     public abstract Map getParamValues();
 
@@ -91,6 +103,8 @@
     /**
      * <p>Return a mutable <code>Map</code> that maps request scope
      * attribute names to their values.</p>
+     *
+     * @return Request scope Map.
      */
     public abstract Map getRequestScope();
 
@@ -98,6 +112,8 @@
     /**
      * <p>Return a mutable <code>Map</code> that maps session scope
      * attribute names to their values.</p>
+     *
+     * @return Session scope Map.
      */
     public abstract Map getSessionScope();
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesGetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesGetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesGetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesGetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -35,6 +35,9 @@
 
     /**
      * <p>Retrieve and return the <code>Locale</code> for this request.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @return The Locale for the request.
      */
     protected Locale getLocale(Context context) {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesSetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesSetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesSetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesSetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -33,6 +33,12 @@
     // ------------------------------------------------------- Protected Methods
 
 
+    /**
+     * <p>Establish the specified <code>Locale</code> for this response.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @param locale The Locale for the request.
+     */
     protected void setLocale(Context context, Locale locale) {
 
     FacesContext fcontext = (FacesContext)

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesWebContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesWebContext.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesWebContext.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/faces/FacesWebContext.java Mon Jun  5 11:02:19 2006
@@ -41,9 +41,6 @@
      * <p>Construct an uninitialized {@link FacesWebContext} instance.</p>
      */
     public FacesWebContext() {
-
-        ;
-
     }
 
 
@@ -76,6 +73,8 @@
     /**
      * <p>Return the <code>FacesContext</code> instance for the request
      * associated with this {@link FacesWebContext}.</p>
+     *
+     * @return The <code>FacesContext</code> for this request
      */
     public FacesContext getContext() {
 
@@ -114,6 +113,11 @@
     // ------------------------------------------------------ WebContext Methods
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Application scope Map.
+     */
     public Map getApplicationScope() {
 
     return (context.getExternalContext().getApplicationMap());
@@ -121,6 +125,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Header values Map.
+     */
     public Map getHeader() {
 
     return (context.getExternalContext().getRequestHeaderMap());
@@ -128,6 +137,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Header values Map.
+     */
     public Map getHeaderValues() {
 
     return (context.getExternalContext().getRequestHeaderValuesMap());
@@ -135,6 +149,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Initialization parameter Map.
+     */
     public Map getInitParam() {
 
     return (context.getExternalContext().getInitParameterMap());
@@ -142,6 +161,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request parameter Map.
+     */
     public Map getParam() {
 
     return (context.getExternalContext().getRequestParameterMap());
@@ -149,6 +173,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request parameter Map.
+     */
     public Map getParamValues() {
 
     return (context.getExternalContext().getRequestParameterValuesMap());
@@ -156,6 +185,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request scope Map.
+     */
     public Map getRequestScope() {
 
     return (context.getExternalContext().getRequestMap());
@@ -163,6 +197,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Session scope Map.
+     */
     public Map getSessionScope() {
 
     return (context.getExternalContext().getSessionMap());

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletGetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletGetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletGetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletGetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -35,6 +35,9 @@
 
     /**
      * <p>Retrieve and return the <code>Locale</code> for this request.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @return The Locale for the request.
      */
     protected Locale getLocale(Context context) {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletSetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletSetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletSetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletSetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -33,6 +33,12 @@
     // ------------------------------------------------------- Protected Methods
 
 
+    /**
+     * <p>Establish the specified <code>Locale</code> for this response.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @param locale The Locale for the request.
+     */
     protected void setLocale(Context context, Locale locale) {
 
     PortletResponse response = (PortletResponse)

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletWebContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletWebContext.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletWebContext.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/portlet/PortletWebContext.java Mon Jun  5 11:02:19 2006
@@ -44,9 +44,6 @@
      * <p>Construct an uninitialized {@link PortletWebContext} instance.</p>
      */
     public PortletWebContext() {
-
-        ;
-
     }
 
 
@@ -149,6 +146,8 @@
 
     /**
      * <p>Return the {@link PortletContext} for this context.</p>
+     *
+     * @return The <code>PortletContext</code> for this request
      */
     public PortletContext getContext() {
 
@@ -159,6 +158,8 @@
 
     /**
      * <p>Return the {@link PortletRequest} for this context.</p>
+     *
+     * @return The <code>PortletRequest</code> for this context.
      */
     public PortletRequest getRequest() {
 
@@ -169,6 +170,8 @@
 
     /**
      * <p>Return the {@link PortletResponse} for this context.</p>
+     *
+     * @return The <code>PortletResponse</code> for this context.
      */
     public PortletResponse getResponse() {
 
@@ -229,6 +232,11 @@
     // ------------------------------------------------------ WebContext Methods
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Application scope Map.
+     */
     public Map getApplicationScope() {
 
         if ((applicationScope == null) && (context != null)) {
@@ -239,6 +247,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Header values Map.
+     */
     public Map getHeader() {
 
         if ((header == null) && (request != null)) {
@@ -250,6 +263,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Header values Map.
+     */
     public Map getHeaderValues() {
 
         if ((headerValues == null) && (request != null)) {
@@ -261,6 +279,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Initialization parameter Map.
+     */
     public Map getInitParam() {
 
         if ((initParam == null) && (context != null)) {
@@ -271,6 +294,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request parameter Map.
+     */
     public Map getParam() {
 
         if ((param == null) && (request != null)) {
@@ -281,6 +309,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request parameter Map.
+     */
     public Map getParamValues() {
 
         if ((paramValues == null) && (request != null)) {
@@ -291,6 +324,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request scope Map.
+     */
     public Map getRequestScope() {
 
         if ((requestScope == null) && (request != null)) {
@@ -301,6 +339,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Session scope Map.
+     */
     public Map getSessionScope() {
 
         if ((sessionScope == null) && (request != null)) {

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ChainProcessor.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ChainProcessor.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ChainProcessor.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ChainProcessor.java Mon Jun  5 11:02:19 2006
@@ -45,7 +45,8 @@
  * </ul>
  *
  * <p>Also, the <code>org.apache.commons.chain.CONFIG_ATTR</code>
- * init parameter is also used to identify the {@link Context} attribute under
+ * init parameter is also used to identify the
+ * {@link org.apache.commons.chain.Context} attribute under
  * which our configured {@link Catalog} will be made available to
  * {@link Command}s processing our requests, in addition to its definition
  * of the <code>ServletContext</code> attribute key under which the

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/PathInfoMapper.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/PathInfoMapper.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/PathInfoMapper.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/PathInfoMapper.java Mon Jun  5 11:02:19 2006
@@ -49,6 +49,8 @@
     /**
      * <p>Return the context key under which our {@link Catalog} has been
      * stored.</p>
+     *
+     * @return The context key for the Catalog.
      */
     public String getCatalogKey() {
 
@@ -78,6 +80,9 @@
      * select an appropriate {@link Command} to be executed.
      *
      * @param context Context for the current request
+     * @return The result of executing the Command for the request URI.
+     * @throws Exception if there is a problem executing the Command for
+     *  the request URI.
      */
     public boolean execute(Context context) throws Exception {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/RequestParameterMapper.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/RequestParameterMapper.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/RequestParameterMapper.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/RequestParameterMapper.java Mon Jun  5 11:02:19 2006
@@ -51,6 +51,8 @@
     /**
      * <p>Return the context key under which our {@link Catalog} has been
      * stored.</p>
+     *
+     * @return The context key for the Catalog.
      */
     public String getCatalogKey() {
 
@@ -75,6 +77,8 @@
     /**
      * <p>Return the name of the request parameter to use for
      * selecting the {@link Command} to be executed.</p>
+     *
+     * @return The name of the request parameter.
      */
     public String getParameter() {
 
@@ -104,6 +108,9 @@
      * to select an appropriate {@link Command} to be executed.
      *
      * @param context Context for the current request
+     * @return The result of executing the Command for the request parameter.
+     * @throws Exception if there is a problem executing the Command for
+     *  the request parameter.
      */
     public boolean execute(Context context) throws Exception {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletGetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletGetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletGetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletGetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -35,6 +35,9 @@
 
     /**
      * <p>Retrieve and return the <code>Locale</code> for this request.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @return The Locale for the request.
      */
     protected Locale getLocale(Context context) {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletPathMapper.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletPathMapper.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletPathMapper.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletPathMapper.java Mon Jun  5 11:02:19 2006
@@ -49,6 +49,8 @@
     /**
      * <p>Return the context key under which our {@link Catalog} has been
      * stored.</p>
+     *
+     * @return The context key for the Catalog.
      */
     public String getCatalogKey() {
 
@@ -78,6 +80,9 @@
      * select an appropriate {@link Command} to be executed.
      *
      * @param context Context for the current request
+     * @return The result of executing the Command for the servlet path.
+     * @throws Exception if there is a problem executing the Command for
+     *  the servlet path.
      */
     public boolean execute(Context context) throws Exception {
 

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletSetLocaleCommand.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletSetLocaleCommand.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletSetLocaleCommand.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletSetLocaleCommand.java Mon Jun  5 11:02:19 2006
@@ -33,6 +33,12 @@
     // ------------------------------------------------------- Protected Methods
 
 
+    /**
+     * <p>Establish the specified <code>Locale</code> for this response.</p>
+     *
+     * @param context The {@link Context} we are operating on.
+     * @param locale The Locale for the request.
+     */
     protected void setLocale(Context context, Locale locale) {
 
     HttpServletResponse response = (HttpServletResponse)

Modified: jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletWebContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletWebContext.java?rev=411876&r1=411875&r2=411876&view=diff
==============================================================================
--- jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletWebContext.java (original)
+++ jakarta/commons/proper/chain/trunk/src/java/org/apache/commons/chain/web/servlet/ServletWebContext.java Mon Jun  5 11:02:19 2006
@@ -43,9 +43,6 @@
      * <p>Construct an uninitialized {@link ServletWebContext} instance.</p>
      */
     public ServletWebContext() {
-
-        ;
-
     }
 
 
@@ -148,6 +145,8 @@
 
     /**
      * <p>Return the {@link ServletContext} for this context.</p>
+     *
+     * @return The <code>ServletContext</code> for this context.
      */
     public ServletContext getContext() {
 
@@ -158,6 +157,8 @@
 
     /**
      * <p>Return the {@link HttpServletRequest} for this context.</p>
+     *
+     * @return The <code>HttpServletRequest</code> for this context.
      */
     public HttpServletRequest getRequest() {
 
@@ -168,6 +169,8 @@
 
     /**
      * <p>Return the {@link HttpServletResponse} for this context.</p>
+     *
+     * @return The <code>HttpServletResponse</code> for this context.
      */
     public HttpServletResponse getResponse() {
 
@@ -228,6 +231,11 @@
     // ------------------------------------------------------ WebContext Methods
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Application scope Map.
+     */
     public Map getApplicationScope() {
 
         if ((applicationScope == null) && (context != null)) {
@@ -238,6 +246,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Header values Map.
+     */
     public Map getHeader() {
 
         if ((header == null) && (request != null)) {
@@ -248,6 +261,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Header values Map.
+     */
     public Map getHeaderValues() {
 
         if ((headerValues == null) && (request != null)) {
@@ -258,6 +276,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Initialization parameter Map.
+     */
     public Map getInitParam() {
 
         if ((initParam == null) && (context != null)) {
@@ -268,6 +291,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request parameter Map.
+     */
     public Map getParam() {
 
         if ((param == null) && (request != null)) {
@@ -278,6 +306,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request parameter Map.
+     */
     public Map getParamValues() {
 
         if ((paramValues == null) && (request != null)) {
@@ -288,6 +321,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Request scope Map.
+     */
     public Map getRequestScope() {
 
         if ((requestScope == null) && (request != null)) {
@@ -298,6 +336,11 @@
     }
 
 
+    /**
+     * See the {@link WebContext}'s Javadoc.
+     *
+     * @return Session scope Map.
+     */
     public Map getSessionScope() {
 
         if ((sessionScope == null) && (request != null)) {



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


Mime
View raw message