commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r348310 - in /jakarta/commons/proper/resources/trunk: ./ conf/ src/java/org/apache/commons/resources/ src/java/org/apache/commons/resources/impl/
Date Wed, 23 Nov 2005 00:11:54 GMT
Author: niallp
Date: Tue Nov 22 16:11:27 2005
New Revision: 348310

URL: http://svn.apache.org/viewcvs?rev=348310&view=rev
Log:
Checkstyle updates only - no code changes:

* Add checkstyle xml file & license template
* Change CVS "Header" to SVN "Id" keyword
* Make license conform to checkstyle
* Remove unused import
* Add missing JavaDoc elements
* de-tab files

Added:
    jakarta/commons/proper/resources/trunk/conf/
    jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt   (with props)
    jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml   (with props)
Modified:
    jakarta/commons/proper/resources/trunk/project.properties
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Message.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/MessageList.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Messages.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Resources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesException.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesFactory.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesKeyException.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessage.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessageList.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/CollectionResourcesBase.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/DatabaseBasicMessage.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResourcesFactory.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResourcesFactory.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesBase.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesFactoryBase.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java   (contents, props changed)
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResourcesFactory.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResources.java
    jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResourcesFactory.java

Added: jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt?rev=348310&view=auto
==============================================================================
--- jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt (added)
+++ jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt Tue Nov 22 16:11:27 2005
@@ -0,0 +1,22 @@
+/*
+ * $Id$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ *  Copyright 2003-2004 The Apache Software Foundation
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */

Propchange: jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jakarta/commons/proper/resources/trunk/conf/LicenseCheckStyle.txt
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Added: jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml?rev=348310&view=auto
==============================================================================
--- jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml (added)
+++ jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml Tue Nov 22 16:11:27 2005
@@ -0,0 +1,134 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+    "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
+    "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
+
+
+<!--
+  
+  These checks still need to be Voted on for Resources, but
+  at least serve to cut down on some of the noise. 
+
+
+  A Checkstyle configuration that checks against the recommendations
+  in Joshua Bloch, Effective Java (highliy recommended read!)
+
+  This file does NOT duplicate the checks for whitespace settings,
+  placement of curly braces, etc.  Only the rules that are explicitly
+  mentioned in the book are enforced.
+
+  Currently the amount of rules that can be automatically checked by
+  Checkstyle is not very large, but adding more checks of this quality
+  is a high priority goal for the development team.
+
+-->
+
+<module name="Checker">
+
+   <module name="TreeWalker">
+
+    <!-- Item 4 - Avoid creating duplicate objects -->
+    <module name="IllegalInstantiation">
+      <property name="classes" value="java.lang.Boolean, java.lang.String"/>
+    </module>
+
+    <!-- Item 6 - Avoid finalizers -->
+    <!-- this will not find violations that contain linebreaks -->
+    <module name="GenericIllegalRegexp">
+      <property name="format"
+                value="((public)|(protected))\s+void\s+finalize\(\s*\)"/>
+    </module>
+
+    <!-- Item 8 - Always override hashCode when you override equals -->
+    <module name="EqualsHashCode"/>
+
+    <!-- Item 12 - Make all fields private -->
+    <module name="VisibilityModifier"/>
+
+    <!-- Item 15 - Design and document for inheritance or else prohibit it -->
+    <!-- the module actually implements a very strict rule, it would be
+         interesting to know whether Joshua meant what checkstyle implements.
+         We feel this implementation is well suited as a warning,
+         i.e. if you get error messages from this check you should be
+         able to name a good reason to implement your code the way you do it,
+         especially if you are designing a library and not an application. -->
+
+    <!-- Commenting this out - produces alot of noise (niallp)
+    <module name="DesignForExtension">
+      <property name="severity" value="warning"/>
+    </module>
+    -->
+
+    <!-- Item 17 - Use interfaces only to define types -->
+    <module name="InterfaceIsType"/>
+
+    <!-- Item 25 - Design method signatures carefully -->
+    <!-- Avoid long parameter lists -->
+    <module name="ParameterNumber">
+      <property name="max" value="4"/>
+    </module>
+
+    <!-- Item 26 - Use overloading judiciously -->
+    <!-- rfe #659735 -->
+
+    <!-- Item 27 - Return zero-length array, not nulls -->
+    <!-- no rfe yet -->
+
+    <!-- Item 28 - Write doc comments for all exposed API elements -->
+    <module name="JavadocType">
+      <property name="scope" value="protected"/>
+    </module>
+    <module name="JavadocMethod"> <!-- also covers Item 44 -->
+      <property name="scope" value="protected"/>
+    </module>
+    <module name="JavadocVariable">
+      <property name="scope" value="protected"/>
+    </module>
+
+    <!-- Item 29 - Minimize the scope of local variables -->
+    <!-- no rfe yet -->
+
+
+    <!-- Item 38 - Adhere to generally accepted naming conventions -->
+    <module name="PackageName">
+      <!-- no uppercase letters, between 2 and 10 characters -->
+      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,9})*$"/>
+    </module>
+    <module name="TypeName"/>
+    <module name="ConstantName"/>
+    <module name="LocalFinalVariableName"/>
+    <module name="LocalVariableName"/>
+    <module name="MemberName"/>
+    <module name="MethodName"/>
+    <module name="ParameterName"/>
+    <module name="StaticVariableName"/>
+
+    <!-- Item 47 - Don't ignore exceptions -->
+    <module name="EmptyBlock">
+      <property name="tokens" value="LITERAL_CATCH"/>
+      <!-- require a comment, change to stmt to require a statement -->
+      <property name="option" value="text"/>
+    </module>
+
+    <!-- Item 50 - Never invoke wait outside a loop -->
+    <!-- rfe #712798 -->
+
+    <!-- Item 57 - Provide a readResolve method when necessary -->
+    <!-- no rfe yet -->
+    
+    <!-- don't allow tabs -->
+    <module name="TabCharacter"/>
+
+    <!-- enforce License Header -->
+    <module name="Header">
+       <property name="headerFile" value="conf/LicenseCheckStyle.txt"/>
+       <!-- Skip over SVN header variables & Copyright dates. -->
+       <property name="ignoreLines" value="2,3,4,8"/>
+    </module>
+
+  </module>
+
+  <!-- enforce package documentation -->
+  <module name="PackageHtml"/>
+  
+</module>

Propchange: jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jakarta/commons/proper/resources/trunk/conf/ResourcesCheckStyle.xml
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Modified: jakarta/commons/proper/resources/trunk/project.properties
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/project.properties?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/project.properties (original)
+++ jakarta/commons/proper/resources/trunk/project.properties Tue Nov 22 16:11:27 2005
@@ -1,4 +1,4 @@
-#   Copyright 2003-2004 The Apache Software Foundation
+#   Copyright 2003-2005 The Apache Software Foundation
 #
 #   Licensed under the Apache License, Version 2.0 (the "License");
 #   you may not use this file except in compliance with the License.
@@ -33,21 +33,7 @@
 
 maven.jarResources.basedir=${basedir}/src/java
 
-# use Sun coding standards
-
-maven.checkstyle.lcurly.type = eol
-maven.checkstyle.lcurly.method = eol
-maven.checkstyle.lcurly.other = eol
-#maven.checkstyle.header.file = src/conf/checkstyle-LICENSE.txt
-maven.checkstyle.header.ignore.line = 1,2,3,4,5,6
-maven.checkstyle.const.pattern = ^[a-z][a-zA-Z0-9]*$
-
-# disable these non-critical errors to highlight
-# more important ones line missing javadoc
-
-maven.checkstyle.max.line.len = 100
-maven.checkstyle.ignore.whitespace = true
-maven.checkstyle.ignore.public.in.interface = true
+maven.checkstyle.properties = conf/ResourcesCheckStyle.xml
 
 maven.linkcheck.enable=false
 
@@ -56,6 +42,6 @@
                       http://jakarta.apache.org/commons/beanutils/api/,\
                       http://jakarta.apache.org/commons/lang/api/,\
                       http://jakarta.apache.org/commons/discovery/api/,\
-                      http://jakarta.apache.org/commons/logging/api/
+                      http://jakarta.apache.org/commons/logging/apidocs/
 
 resources.repository=scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-commons/resources/

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Message.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Message.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Message.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Message.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/Message.java,v 1.7 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
- * 
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/MessageList.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/MessageList.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/MessageList.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/MessageList.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/MessageList.java,v 1.10 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -23,8 +23,6 @@
 
 package org.apache.commons.resources;
 
-import org.apache.commons.resources.Message;
-
 import java.util.Iterator;
 
 /**
@@ -120,6 +118,8 @@
      * Return the set of all recorded messages, without distinction
      * by which property the messages are associated with.  If there are
      * no messages recorded, an empty enumeration is returned.
+     *
+     * @return All messages.
      */
     public Iterator get();
 
@@ -128,6 +128,7 @@
      * If there are no such messages, an empty enumeration is returned.
      *
      * @param property Property name
+     * @return Messages related to a specific property.
      */
     public Iterator get(String property);
 
@@ -137,6 +138,8 @@
      * If you have recorded global messages, the String value of
      * <code>MessageList.GLOBAL_MESSAGE</code> will be one of the returned
      * property names.
+     *
+     * @return The property names.
      */
     public Iterator properties();
 
@@ -145,6 +148,8 @@
      * global messages).  <strong>NOTE</strong> - it is more efficient to call
      * <code>isEmpty()</code> if all you care about is whether or not there are
      * any messages at all.
+     *
+     * @return The number of messages.
      */
     public int size();
 
@@ -152,6 +157,7 @@
      * Return the number of messages associated with the specified property.
      *
      * @param property Property name (or MessageList.GLOBAL_MESSAGE_KEY
+     * @return The number of messages for a specific property.
      */
     public int size(String property);
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Messages.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Messages.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Messages.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Messages.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/Messages.java,v 1.11 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -85,6 +85,8 @@
 
     /**
      * <p>Return the {@link Resources} instance that we are wrapping.</p>
+     *
+     * @return The wrapped resources.
      */
     public Resources getResources() {
 
@@ -101,6 +103,7 @@
      * <code>Locale</code>.</p>
      *
      * @param key Message key to retrieve
+     * @return The text message for the specified key.
      */
     public String getMessage(String key) {
 
@@ -115,6 +118,7 @@
      *
      * @param locale <code>Locale</code> for which to retrieve the message
      * @param key Message key to retrieve
+     * @return The text message for the specified key and locale.
      */
     public String getMessage(Locale locale, String key) {
 
@@ -129,10 +133,11 @@
      *
      * @param key Message key to retrieve
      * @param args Array of replacement values
+     * @return The text message with parametric replacement.
      */
-	public String getMessage(String key, Object[] args) {
-		return getMessage(resources, key, args);
-	}
+    public String getMessage(String key, Object[] args) {
+        return getMessage(resources, key, args);
+    }
 
 
     /**
@@ -142,10 +147,11 @@
      * @param locale <code>Locale</code> for which to retrieve the message
      * @param key Message key to retrieve
      * @param args Array of replacement values
+     * @return The text message for a spcified locale with parametric replacement.
      */
-	public String getMessage(Locale locale, String key, Object[] args) {
-		return getMessage(resources, locale, key, args);
-	}
+    public String getMessage(Locale locale, String key, Object[] args) {
+        return getMessage(resources, locale, key, args);
+    }
 
 
     /**
@@ -154,6 +160,7 @@
      *
      * @param key Message key to retrieve
      * @param arg0 Individual parameter replacement value
+     * @return The text message with parametric replacement.
      */
     public String getMessage(String key, Object arg0) {
 
@@ -169,6 +176,7 @@
      * @param locale <code>Locale</code> for which to retrieve the message
      * @param key Message key to retrieve
      * @param arg0 Individual parameter replacement value
+     * @return The text message for a spcified locale with parametric replacement.
      */
     public String getMessage(Locale locale, String key, Object arg0) {
 
@@ -196,6 +204,7 @@
      *
      * @param resources {@link Resources} instance to retrieve the message from
      * @param key Message key to retrieve
+     * @return The text message.
      */
     public static String getMessage(Resources resources, String key) {
 
@@ -211,25 +220,26 @@
      * @param resources {@link Resources} instance to retrieve the message from
      * @param locale <code>Locale</code> for which to retrieve the message
      * @param key Message key to retrieve
+     * @return The text message.
      */
-	public static String getMessage(
-		Resources resources,
-		Locale locale,
-		String key) {
-
-		String message = null;
-		try {
-			message = resources.getString(key, locale, null);
-		} catch (ResourcesException e) {
-			log.debug("Failed retrieving message for key: '" + key + "'.", e);
-		}
-
-		if (message == null && !resources.isReturnNull()) {
-			message = "???" + key + "???";
-		}
+    public static String getMessage(
+        Resources resources,
+        Locale locale,
+        String key) {
+
+        String message = null;
+        try {
+            message = resources.getString(key, locale, null);
+        } catch (ResourcesException e) {
+            log.debug("Failed retrieving message for key: '" + key + "'.", e);
+        }
+
+        if (message == null && !resources.isReturnNull()) {
+            message = "???" + key + "???";
+        }
 
-		return message;
-	}
+        return message;
+    }
 
 
     /**
@@ -239,14 +249,15 @@
      * @param resources {@link Resources} instance to retrieve the message from
      * @param key Message key to retrieve
      * @param args Array of replacement values
+     * @return The text message.
      */
-	public static String getMessage(
-		Resources resources,
-		String key,
-		Object[] args) {
+    public static String getMessage(
+        Resources resources,
+        String key,
+        Object[] args) {
 
-		return getMessage(resources, (Locale) null, key, args);
-	}
+        return getMessage(resources, (Locale) null, key, args);
+    }
 
 
     /**
@@ -257,18 +268,19 @@
      * @param locale <code>Locale</code> for which to retrieve the message
      * @param key Message key to retrieve
      * @param args Array of replacement values
+     * @return The text message.
      */
-	public static String getMessage(
-		Resources resources,
-		Locale locale,
-		String key,
-		Object[] args) {
-
-		// TODO - Cache MessageFormat instances?
-		String message = getMessage(resources, locale, key);
-		MessageFormat format = new MessageFormat(message);
-		return (format.format(args));
-	}
+    public static String getMessage(
+        Resources resources,
+        Locale locale,
+        String key,
+        Object[] args) {
+
+        // TODO - Cache MessageFormat instances?
+        String message = getMessage(resources, locale, key);
+        MessageFormat format = new MessageFormat(message);
+        return (format.format(args));
+    }
 
 
     /**
@@ -278,6 +290,7 @@
      * @param resources {@link Resources} instance to retrieve the message from
      * @param key Message key to retrieve
      * @param arg0 Individual parameter replacement value
+     * @return The text message.
      */
     public static String getMessage(Resources resources,
                                     String key, Object arg0) {
@@ -294,15 +307,16 @@
      * @param locale <code>Locale</code> for which to retrieve the message
      * @param key Message key to retrieve
      * @param arg0 Individual parameter replacement value
+     * @return The text message.
      */
-	public static String getMessage(
-		Resources resources,
-		Locale locale,
-		String key,
-		Object arg0) {
+    public static String getMessage(
+        Resources resources,
+        Locale locale,
+        String key,
+        Object arg0) {
 
-		return getMessage(resources, locale, key, new Object[] { arg0 });
-	}
+        return getMessage(resources, locale, key, new Object[] { arg0 });
+    }
 
     /**
      * <p>Convenience factory method to create a {@link Messages} instance
@@ -316,6 +330,7 @@
      *
      * @param name Package + file name of the properties file for which
      *  local message resources are desired (ie. org.apache.commons.resources.LocalStrings).
+     * @return The text messages.
      */
     public static Messages getMessages(String name) {
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Resources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Resources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Resources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/Resources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/Resources.java,v 1.14 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -93,12 +93,16 @@
     /**
      * <p>Return an <code>Iterator</code> over the defined keys in this
      * {@link Resources} instance.</p>
+     *
+     * @return The keys contained in this resources instance.
      */
     public Iterator getKeys();
 
 
     /**
      * <p>Return the logical name of this {@link Resources} instance.</p>
+     *
+     * @return The name of this resources instance.
      */
     public String getName();
 
@@ -107,6 +111,7 @@
      * <p>Return <code>true</code> if resource getter methods will return
      * <code>null</code> instead of throwing an exception on invalid
      * key values.</p>
+     * @return 'true' if null is returned for invalid key values.
      */
     public boolean isReturnNull();
 
@@ -134,6 +139,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -154,6 +160,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -175,6 +182,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -195,6 +203,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -215,6 +224,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesException.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesException.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesException.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesException.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/ResourcesException.java,v 1.9 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -31,28 +31,52 @@
  */
 public class ResourcesException extends RuntimeException implements Serializable {
 
+    /** Exception message */
     protected String message = "";
 
+    /** Cause of the exception */
     protected Throwable rootCause = null;
 
+    /**
+     * Construct an Exception with the specified message.
+     * @param message The message.
+     */
     public ResourcesException(String message) {
         this(message, null);
     }
 
+    /**
+     * Construct an Exception with the specified cause.
+     * @param rootCause Cause of the exception.
+     */
     public ResourcesException(Throwable rootCause) {
         this.message = rootCause.getMessage();
         this.rootCause = rootCause;
     }
 
+    /**
+     * Construct an Exception with the specified message.
+     * and cause.
+     * @param message The message.
+     * @param rootCause Cause of the exception.
+     */
     public ResourcesException(String message, Throwable rootCause) {
         this.message = message;
         this.rootCause = rootCause;
     }
 
+    /**
+     * Return the message.
+     * @return The message.
+     */
     public String getMessage() {
         return message;
     }
 
+    /**
+     * Return the cause.
+     * @return The cause of the Exception.
+     */
     public Throwable getRootCause() {
         return rootCause;
     }

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/ResourcesFactory.java,v 1.11 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -54,6 +54,7 @@
      * <p>Return the <code>returnNull</code> property value that will be
      * configured on {@link org.apache.commons.resources.Resources} 
      * instances created by this factory.</p>
+     * @return 'true' if null is returned for invalid key values.
      */
     public boolean isReturnNull();
 
@@ -79,6 +80,7 @@
      * @param name Logical name of the 
      * {@link org.apache.commons.resources.Resources} instance to
      *  be returned
+     * @return The resources instance.
      *
      * @exception ResourcesException if a 
      * {@link org.apache.commons.resources.Resources} instance
@@ -100,6 +102,7 @@
      *  is dependent upon the {@link org.apache.commons.resources.ResourcesFactory} 
      * implementation being utilized), or <code>null</code> for the default
      *  configuration
+     * @return The resources.
      *
      * @exception ResourcesException if a 
      * {@link org.apache.commons.resources.Resources} instance

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesKeyException.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesKeyException.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesKeyException.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/ResourcesKeyException.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/ResourcesKeyException.java,v 1.6 2004/03/27 21:34:10 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessage.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessage.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessage.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessage.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/BasicMessage.java,v 1.9 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -44,6 +44,9 @@
      */
     protected Object[] values = null;
 
+    /**
+     * Default Constructor.
+     */
     public BasicMessage() {
         super();
     }
@@ -130,12 +133,16 @@
         this.values = values;
     }
 
-    // See interface for JavaDoc
+    /**
+     * @return Get the message key for this message.
+     */
     public String getKey() {
         return (this.key);
     }
 
-    // See interface for JavaDoc
+    /**
+     * @return Get the replacement values for this message.
+     */
     public Object[] getValues() {
         return (this.values);
     }

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessageList.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessageList.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessageList.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/BasicMessageList.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/BasicMessageList.java,v 1.14 2004/09/07 23:34:46 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -109,7 +109,7 @@
      */
     public BasicMessageList(String globalMessageKey, MessageList messages) {
         super();
-		this.setGlobalMessageKey(globalMessageKey);
+        this.setGlobalMessageKey(globalMessageKey);
         this.add(messages);
     }
 
@@ -119,17 +119,28 @@
      */
     private String globalMessageKey = GLOBAL_MESSAGE_KEY;
 
-    // See interface for JavaDoc
+    /**
+     * @return The default global message key
+     */
     public String getGlobalMessageKey() {
         return this.globalMessageKey;
     }
 
-    // See interface for JavaDoc
+    /**
+     * @param globalMessageKey The new default global message key
+     */
     public void setGlobalMessageKey(String globalMessageKey) {
         this.globalMessageKey = globalMessageKey;
     }
 
-    // See interface for JavaDoc
+    /**
+     * Add a message to the set of messages for the specified property.  An
+     * order of the property/key is maintained based on the initial addition
+     * of the property/key.
+     *
+     * @param property  Property name (or MessageList.GLOBAL_MESSAGE_KEY)
+     * @param message   The message to be added
+     */
     public void add(String property, Message message) {
 
         MessageItem item = (MessageItem) messages.get(property);
@@ -148,14 +159,27 @@
 
     }
 
-
-    // See interface for JavaDoc
+    /**
+     * Add a message to the set of messages for the "global" property.  An
+     * order of the property/key is maintained based on the initial addition
+     * of the property/key.
+     *
+     * @param message   The message to be added
+     */
     public void add(Message message) {
         this.add(getGlobalMessageKey(), message);
     }
 
-
-    // See interface for JavaDoc
+    /**
+     * Adds the messages from the given <code>MessageList</code> object to
+     * this set of messages. The messages are added in the order they are returned from
+     * the properties() method. If a message's property is already in the current
+     * <code>MessageList</code> object it is added to the end of the list for that
+     * property. If a message's property is not in the current list it is added to the end
+     * of the properties.
+     *
+     * @param messageList The <code>MessageList</code> object to be added.
+     */
     public void add(MessageList messageList) {
         // loop over properties
         Iterator props = messageList.properties();
@@ -172,22 +196,39 @@
         }
     }
 
-    // See interface for JavaDoc
+    /**
+     * Clear all messages recorded by this object.
+     */
     public void clear() {
         this.messages.clear();
     }
     
-    // See interface for JavaDoc
+    /**
+     * Determines if the MessageList's messages have been accessed one or more
+     * times.  Returns <code>true</code> if the <code>get()</code> or 
+     * <code>get(String)</code> methods are called.  
+     * @return <code>true</code> if the messages have been accessed one or more
+     * times.
+     */
     public boolean isAccessed() {
         return this.accessed;
     }
 
-    // See interface for JavaDoc
+    /**
+     * @return Return <code>true</code> if there are no messages recorded
+     * in this collection, or <code>false</code> otherwise.
+     */
     public boolean isEmpty() {
         return messages.isEmpty();
     }
 
-    // See interface for JavaDoc
+    /**
+     * Return the set of all recorded messages, without distinction
+     * by which property the messages are associated with.  If there are
+     * no messages recorded, an empty enumeration is returned.
+     *
+     * @return All messages.
+     */
     public Iterator get() {
         this.accessed = true;
         
@@ -217,7 +258,13 @@
         return results.iterator();
     }
 
-    // See interface for JavaDoc
+    /**
+     * Return the set of messages related to a specific property.
+     * If there are no such messages, an empty enumeration is returned.
+     *
+     * @param property Property name
+     * @return Messages related to a specific property.
+     */
     public Iterator get(String property) {
         this.accessed = true;
         
@@ -228,12 +275,27 @@
             : item.getList().iterator();
     }
 
-    // See interface for JavaDoc
+    /**
+     * Return the set of property names for which at least one message has
+     * been recorded.  If there are no messages, an empty Iterator is returned.
+     * If you have recorded global messages, the String value of
+     * <code>MessageList.GLOBAL_MESSAGE</code> will be one of the returned
+     * property names.
+     *
+     * @return The property names.
+     */
     public Iterator properties() {
         return messages.keySet().iterator();
     }
 
-    // See interface for JavaDoc
+    /**
+     * Return the number of messages recorded for all properties (including
+     * global messages).  <strong>NOTE</strong> - it is more efficient to call
+     * <code>isEmpty()</code> if all you care about is whether or not there are
+     * any messages at all.
+     *
+     * @return The number of messages.
+     */
     public int size() {
 
         int total = 0;
@@ -246,7 +308,12 @@
         return total;
     }
 
-    // See interface for JavaDoc
+    /**
+     * Return the number of messages associated with the specified property.
+     *
+     * @param property Property name (or MessageList.GLOBAL_MESSAGE_KEY
+     * @return The number of messages for a specific property.
+     */
     public int size(String property) {
 
         MessageItem ami = (MessageItem) messages.get(property);
@@ -263,7 +330,9 @@
         return this.messages.toString();
     }
 
-    // See interface for JavaDoc
+    /**
+     * Holds messages for a specified property.
+     */    
     protected static class MessageItem implements Serializable {
 
         /**
@@ -276,23 +345,41 @@
          */
         private int order = 0;
 
+        /**
+         * Construct a MessageItem with a list of messages
+         * and specified order.
+         * @param list List of Messages.
+         * @param order Order.
+         */
         public MessageItem(List list, int order) {
             this.list = list;
             this.order = order;
         }
 
+        /**
+         * @return The list of messsages.
+         */
         public List getList() {
             return list;
         }
 
+        /**
+         * @param list The list of messsages.
+         */
         public void setList(List list) {
             this.list = list;
         }
 
+        /**
+         * @return The order.
+         */
         public int getOrder() {
             return order;
         }
 
+        /**
+         * @param order The order.
+         */
         public void setOrder(int order) {
             this.order = order;
         }

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/CollectionResourcesBase.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/CollectionResourcesBase.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/CollectionResourcesBase.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/CollectionResourcesBase.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/CollectionResourcesBase.java,v 1.13 2004/09/07 23:34:46 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -98,7 +98,7 @@
     // ------------------------------------------------------------- Properties
 
 
-    /* (non-Javadoc)
+    /**
      * @see org.apache.commons.resources.impl.ResourcesBase#getKeys()
      */
     public Iterator getKeys() {
@@ -135,6 +135,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return The content for the specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -219,6 +220,7 @@
      * <code>java.util.ResourceBundle</code>.</p>
      *
      * @param locale Locale on which to base the list calculation
+     * @return A List of locales.
      */
     protected List getLocaleList(Locale locale) {
 
@@ -264,6 +266,7 @@
      * occurs only once per <code>Locale</code>.</p>
      *
      * @param locale Locale for which to return a name-value mappings Map
+     * @return A name-value Map for the specified locale.
      */
     protected Map getLocaleMap(Locale locale) {
 
@@ -306,6 +309,7 @@
      * {@link org.apache.commons.resources.Resources} instance
      * @param locale <code>Locale</code> for which name-value mappings
      *  are requested
+     * @return A name-value Map for the specified URL and locale.
      */
     protected abstract Map getLocaleMap(String baseUrl, Locale locale);
 
@@ -320,6 +324,7 @@
      *
      * @param locale <code>Locale</code> for which a suffix string
      *  is requested
+     * @return The locale specific suffix.
      */
     protected String getLocaleSuffix(Locale locale) {
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/DatabaseBasicMessage.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/DatabaseBasicMessage.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/DatabaseBasicMessage.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/DatabaseBasicMessage.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/DatabaseBasicMessage.java,v 1.1 2004/09/07 23:47:48 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -36,15 +36,20 @@
  */
 public class DatabaseBasicMessage extends BasicMessage {
 
+    /**
+     * Default Constructor.
+     */
     public DatabaseBasicMessage() {
         super();
     }
+
     /**
-     * 
-     * @param id  The id (primary key) for this message.
-     * @param locale The locale used to retrieve the value for the specified key
-     * @param key  The key for this message.
-     * @param value The value for this message.
+     * Construct a message for a specified Locale
+     * with the specified replacement values.
+     *
+     * @param locale Locale for this message
+     * @param key Message key for this message
+     * @param values Array of replacement values
      */
     public DatabaseBasicMessage(String locale, String key, Object[] values) {
         super(key, values);
@@ -55,6 +60,8 @@
     private String locale = null;
 
     /**
+     * Return the locale for the message.
+     *
      * @return Returns the locale.
      */
     public String getLocale() {
@@ -62,18 +69,37 @@
     }
 
     /**
+     * Set the locale for the message.
+     *
      * @param locale The locale to set.
      */
     public void setLocale(String locale) {
         this.locale = locale;
     }
     
+    /**
+     * Set the key for the message.
+     *
+     * @param key The key to set.
+     */
     public void setKey(String key) {
         this.key = key;
     }
+
+    /**
+     * Set a replacement value for the message.
+     *
+     * @param value The replacement value.
+     */
     public void setValue(String value) {
         this.values = new String[]{value};
     }
+
+    /**
+     * Return the replacement value for the message.
+     *
+     * @return The replacement value.
+     */
     public String getValue() {
         if (values == null || values.length < 1) {
             throw new IllegalStateException("The retrived value for msg " + 
@@ -81,22 +107,33 @@
         }
         if (values.length > 1) {
             throw new IllegalStateException("There were more than one values " +
-            		"retrived value for msg " + 
+                    "retrived value for msg " + 
                     this.key);
         }
         return (String)getValues()[0];
     }
     
+    /**
+     * Compare this message to another.
+     *
+     * @param obj The message to compare.
+     * @return 'true' if the messages are equal.
+     */
     public boolean equals(Object obj) {
-    	if (obj instanceof DatabaseBasicMessage){
-    		if (((DatabaseBasicMessage)obj).getKey().equals(this.key) && 
-    				((DatabaseBasicMessage)obj).getLocale().equals(this.locale)){
-    			return true;
-    		}
-    	}
+        if (obj instanceof DatabaseBasicMessage){
+            if (((DatabaseBasicMessage)obj).getKey().equals(this.key) && 
+                    ((DatabaseBasicMessage)obj).getLocale().equals(this.locale)){
+                return true;
+            }
+        }
         return false;
     }
 
+    /**
+     * Return the hashcode for the message.
+     *
+     * @return The message's hash code.
+     */
     public int hashCode() {
         return super.hashCode();
     }

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/JDBCResources.java,v 1.2 2004/09/07 23:34:46 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -126,6 +126,7 @@
      * {@link org.apache.commons.resources.Resources} instance
      * @param locale <code>Locale</code> for which name-value mappings
      *  are requested
+     * @return A name-value Map for the specified URL and locale.
      */
     protected Map getLocaleMap(String baseUrl, Locale locale) {
 
@@ -185,10 +186,10 @@
 
         // Return the populated (or empty) properties
         Properties properties = new Properties();
-		try {
-	        properties = loadData(locale, props);
-	        
-		} catch (InstantiationException e) {
+        try {
+            properties = loadData(locale, props);
+
+        } catch (InstantiationException e) {
             log.warn("InstantiationException: locale= '" + locale +
                      "' base= '" + baseUrl + "'", e);
         } catch (IllegalAccessException e) {
@@ -196,7 +197,7 @@
                     "' base= '" + baseUrl + "'", e);
         } catch (ClassNotFoundException e) {
             log.warn("Specified Driver not found, make sure it is on " +
-            		"the classpath: locale= '" + locale +
+                    "the classpath: locale= '" + locale +
                     "' base= '" + baseUrl + "'", e);
         } catch (SQLException e) {
             log.warn("SQLException: locale= '" + locale +
@@ -215,8 +216,8 @@
      * a JDBC connection.
      */
     private Properties loadData(Locale locale, Properties connectionProps) 
-    	throws InstantiationException, IllegalAccessException, 
-    	ClassNotFoundException, SQLException {
+        throws InstantiationException, IllegalAccessException, 
+        ClassNotFoundException, SQLException {
         
         String driver = connectionProps.getProperty("jdbc.connect.driver");
         String url    = connectionProps.getProperty("jdbc.connect.url");
@@ -230,21 +231,24 @@
         Properties pairs = new Properties();
         
             Class.forName(driver).newInstance();
-    		con = DriverManager.getConnection(url, user, pass);
-    		
-    		String query = "SELECT " + keyColumn + ", " + valColumn + 
-    				" FROM " + table + " where " + localeColumn + "= '" + locale + "'";
-    		PreparedStatement stmt = con.prepareStatement(query);
-    		ResultSet rs = stmt.executeQuery();
-    		
-    		while (rs.next()) {
-    		    pairs.put(rs.getString(keyColumn), rs.getString(valColumn));
-    		}
-        
+            con = DriverManager.getConnection(url, user, pass);
+
+            String query = "SELECT " + keyColumn + ", " + valColumn + 
+                    " FROM " + table + " where " + localeColumn + "= '" + locale + "'";
+            PreparedStatement stmt = con.prepareStatement(query);
+            ResultSet rs = stmt.executeQuery();
+
+            while (rs.next()) {
+                pairs.put(rs.getString(keyColumn), rs.getString(valColumn));
+            }
+
         return pairs;
     }
 
-
+    /**
+     * Initialization.
+     * @throws ResourcesException if an error occurs during initializtion.
+     */
     public void init() throws ResourcesException {
         super.init();
     }

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/JDBCResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/JDBCResourcesFactory.java,v 1.1 2004/06/11 02:43:48 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -55,6 +55,7 @@
      * instance to create
      * 
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} 
      * instance of the specified logical name cannot be created.

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/PropertyResources.java,v 1.11 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -95,10 +95,11 @@
      * always attempt to retrieve the specified resource and load it
      * appropriately.</p>
      *
-     * @param base Base URL of the resource files for this 
+     * @param baseUrl Base URL of the resource files for this 
      * {@link org.apache.commons.resources.Resources} instance
      * @param locale <code>Locale</code> for which name-value mappings
      *  are requested
+     * @return A name-value Map for the specified URL and locale.
      */
     protected Map getLocaleMap(String baseUrl, Locale locale) {
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/PropertyResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/PropertyResourcesFactory.java,v 1.10 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -60,6 +60,7 @@
      * instance to create
      * 
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} 
      * instance of the specified logical name cannot be created.

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/ResourceBundleResources.java,v 1.15 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -149,6 +149,7 @@
     /**
      * <p>Return the fully qualified base name of the
      * <code>ResourceBundle</code> instances we are wrapping.</p>
+     * @return The base name of this resources instance.
      */
     public String getBase() {
 
@@ -156,7 +157,12 @@
 
     }
 
-
+    /**
+     * <p>Return an <code>Iterator</code> over the defined keys in this
+     * {@link org.apache.commons.resources.Resources} instance.</p>
+     *
+     * @return The keys contained in this resources instance.
+     */
     public Iterator getKeys() {
 
         synchronized (bundles) {
@@ -197,6 +203,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -222,6 +229,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -247,6 +255,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -281,6 +290,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -305,6 +315,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -362,6 +373,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return The Resource Bundle corresponding to the locale and time zone.
      *
      * @exception MissingResourceException if the requested Resourcebundle
      *  cannot be acquired
@@ -400,10 +412,11 @@
     /**
      * <p>Return the <code>ClassLoader</code> for which we are mapping
      * <code>ResourceBundle</code> instances.</p>
+     * @return The Class Loader for the resource bundle.
      */
     protected ClassLoader getClassLoader() {
 
-		ClassLoader loader = Thread.currentThread().getContextClassLoader();
+        ClassLoader loader = Thread.currentThread().getContextClassLoader();
         
         if (loader == null) {
             loader = this.getClass().getClassLoader();

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.java,v 1.13 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -51,6 +51,7 @@
      *
      * @param name Logical name of the {@link org.apache.commons.resources.Resources} instance to create
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} instance
      *  of the specified logical name cannot be created.

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesBase.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesBase.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesBase.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesBase.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/ResourcesBase.java,v 1.12 2004/09/07 23:34:46 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -132,12 +132,20 @@
     // ------------------------------------------------------------- Properties
 
 
+    /**
+     * <p>Return an <code>Iterator</code> over the defined keys in this
+     * {@link org.apache.commons.resources.Resources} instance.</p>
+     *
+     * @return The keys contained in this resources instance.
+     */
     public abstract Iterator getKeys();
 
 
     /**
      * <p>Return the logical name of this {@link org.apache.commons.resources.Resources} 
      * instance.</p>
+     *
+     * @return The name of this resources instance.
      */
     public String getName() {
 
@@ -150,6 +158,7 @@
      * <p>Return <code>true</code> if resource getter methods will return
      * <code>null</code> instead of throwing an exception on invalid
      * key values.</p>
+     * @return 'true' if null is returned for invalid key values.
      */
     public boolean isReturnNull() {
 
@@ -188,6 +197,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -220,6 +230,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -252,6 +263,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -275,6 +287,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content
@@ -307,6 +320,7 @@
      *  or <code>null</code> for the default Locale
      * @param timeZone TimeZone with which to localize retrieval,
      *  or <code>null</code> for the default TimeZone
+     * @return content for a specified key.
      *
      * @exception ResourcesException if an error occurs retrieving or
      *  returning the requested content

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesFactoryBase.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesFactoryBase.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesFactoryBase.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/ResourcesFactoryBase.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/ResourcesFactoryBase.java,v 1.9 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -63,6 +63,7 @@
     /**
      * <p>Return the <code>returnNull</code> property value that will be
      * configured on {@link Resources} instances created by this factory.</p>
+     * @return 'true' if null is returned for invalid key values.
      */
     public boolean isReturnNull() {
 
@@ -96,6 +97,7 @@
      *
      * @param name Logical name of the {@link Resources} instance to
      *  be returned
+     * @return The resources instance.
      *
      * @exception ResourcesException if a {@link Resources} instance
      *  of the specified logical name cannot be returned.
@@ -119,6 +121,7 @@
      *  is dependent upon the {@link ResourcesFactory} implementation
      *  being utilized), or <code>null</code> for the default
      *  configuration
+     * @return The resources instance.
      *
      * @exception ResourcesException if a {@link Resources} instance
      *  of the specified logical name cannot be returned.
@@ -171,6 +174,7 @@
      *
      * @param name Logical name of the {@link Resources} instance to create
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link Resources} instance
      *  of the specified logical name cannot be created.

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/WebappPropertyResources.java,v 1.10 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -58,8 +58,8 @@
     /**
      * <p>The <code>Log</code> instance for this class.</p>
      */
-	private static final Log log =
-		LogFactory.getLog(WebappPropertyResources.class);
+    private static final Log log =
+        LogFactory.getLog(WebappPropertyResources.class);
 
     // ----------------------------------------------------------- Constructors
 
@@ -113,10 +113,11 @@
      * always attempt to retrieve the specified resource and load it
      * appropriately.</p>
      *
-     * @param base Base URL of the resource files for this {@link org.apache.commons.resources.Resources}
+     * @param baseUrl Base URL of the resource files for this {@link org.apache.commons.resources.Resources}
      *  instance
      * @param locale <code>Locale</code> for which name-value mappings
      *  are requested
+     * @return A name-value Map for the specified URL and locale.
      */
     protected Map getLocaleMap(String baseUrl, Locale locale) {
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.java,v 1.10 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -52,6 +52,7 @@
     /**
      * <p>Return the <code>ServletContext</code> instance for
      * resolving our resources references.</p>
+     * @return The Servlet Context.
      */
     public ServletContext getServletContext() {
 
@@ -63,6 +64,7 @@
     /**
      * <p>Set the <code>ServletContext</code> instance for
      * resolving our resources references.</p>
+     * @param servletContext The Servlet Context.
      */
     public void setServletContext(ServletContext servletContext) {
 
@@ -81,6 +83,7 @@
      *
      * @param name Logical name of the {@link org.apache.commons.resources.Resources} instance to create
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} instance
      *  of the specified logical name cannot be created.

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java Tue Nov 22 16:11:27 2005
@@ -1,50 +1,61 @@
-/*
- * $Id$ 
- *
- * Copyright 2000-2004 The Apache Software Foundation.
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.commons.resources.impl;
-
-import javax.servlet.ServletContext;
-
-public abstract class WebappResourcesFactoryBase extends ResourcesFactoryBase {
-
-    /**
-     * <p>The <code>ServletContext</code> instance for resolving
-     * our resources references.</p>
-     */
-    protected ServletContext servletContext = null;
-
-    /**
-     * <p>Return the <code>ServletContext</code> instance for
-     * resolving our resources references.</p>
-     */
-    public ServletContext getServletContext() {
-    
-        return (this.servletContext);
-    
-    }
-
-    /**
-     * <p>Set the <code>ServletContext</code> instance for
-     * resolving our resources references.</p>
-     */
-    public void setServletContext(ServletContext servletContext) {
-    
-        this.servletContext = servletContext;
-    
-    }
-
-}
+/*
+ * $Id$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */
+package org.apache.commons.resources.impl;
+
+import javax.servlet.ServletContext;
+
+/**
+ * <p>Convenience base class for Web App implementations of 
+ *    {@link org.apache.commons.resources.ResourcesFactory}.</p>
+ */
+public abstract class WebappResourcesFactoryBase extends ResourcesFactoryBase {
+
+    /**
+     * <p>The <code>ServletContext</code> instance for resolving
+     * our resources references.</p>
+     */
+    protected ServletContext servletContext = null;
+
+    /**
+     * <p>Return the <code>ServletContext</code> instance for
+     * resolving our resources references.</p>
+     * @return The Servlet Context.
+     */
+    public ServletContext getServletContext() {
+    
+        return (this.servletContext);
+    
+    }
+
+    /**
+     * <p>Set the <code>ServletContext</code> instance for
+     * resolving our resources references.</p>
+     * @param servletContext The Servlet Context.
+     */
+    public void setServletContext(ServletContext servletContext) {
+    
+        this.servletContext = servletContext;
+    
+    }
+
+}

Propchange: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java
            ('svn:executable' removed)

Propchange: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappResourcesFactoryBase.java
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/WebappXMLResources.java,v 1.11 2004/09/07 23:34:46 jmitchell Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -115,6 +115,7 @@
      *  instance
      * @param locale <code>Locale</code> for which name-value mappings
      *  are requested
+     * @return A name-value Map for the specified URL and locale.
      */
     protected Map getLocaleMap(String baseUrl, Locale locale) {
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/WebappXMLResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/WebappXMLResourcesFactory.java,v 1.10 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -55,6 +55,7 @@
      *
      * @param name Logical name of the {@link org.apache.commons.resources.Resources} instance to create
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} instance
      *  of the specified logical name cannot be created.

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResources.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResources.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResources.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResources.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/XMLResources.java,v 1.10 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -111,6 +111,7 @@
      *  instance
      * @param locale <code>Locale</code> for which name-value mappings
      *  are requested
+     * @return A name-value Map for the specified URL and locale.
      */
     protected Map getLocaleMap(String baseUrl, Locale locale) {
 

Modified: jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResourcesFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResourcesFactory.java?rev=348310&r1=348309&r2=348310&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResourcesFactory.java (original)
+++ jakarta/commons/proper/resources/trunk/src/java/org/apache/commons/resources/impl/XMLResourcesFactory.java Tue Nov 22 16:11:27 2005
@@ -1,12 +1,12 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//resources/src/java/org/apache/commons/resources/impl/XMLResourcesFactory.java,v 1.10 2004/03/27 21:34:09 dgraham Exp $
+ * $Id$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
- *  Copyright 2003-2004 The Apache Software Foundation
- * 
+ *  Copyright 2003-2005 The Apache Software Foundation
+ *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
@@ -52,6 +52,7 @@
      *
      * @param name Logical name of the {@link org.apache.commons.resources.Resources} instance to create
      * @param config Configuration string for this resource (if any)
+     * @return The new Resources instance.
      *
      * @exception ResourcesException if a {@link org.apache.commons.resources.Resources} instance
      *  of the specified logical name cannot be created.



---------------------------------------------------------------------
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