svn commit: r1089034 - /commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/tools/PropertiesHolder.java

[simonetripodi]

Author: simonetripodi
Date: Tue Apr  5 13:35:47 2011
New Revision: 1089034

URL: http://svn.apache.org/viewvc?rev=1089034&view=rev
Log:
added missing javadoc

Modified:
    
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/tools/PropertiesHolder.java

Modified: 
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/tools/PropertiesHolder.java
URL: 
http://svn.apache.org/viewvc/commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/tools/PropertiesHolder.java?rev=1089034&r1=1089033&r2=1089034&view=diff
==============================================================================
--- 
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/tools/PropertiesHolder.java
 (original)
+++ 
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/tools/PropertiesHolder.java
 Tue Apr  5 13:35:47 2011
@@ -31,24 +31,38 @@ public class PropertiesHolder {
     private Properties   properties;
     private final String propertiesFileName;
 
+    /**
+     * Creates a new {@code PropertiesHolder} instance given an
+     * already load {@code Properties} set.
+     *
+     * @param properties The already load {@code Properties} set
+     */
     public PropertiesHolder(Properties properties) {
         this.properties = properties;
         this.propertiesFileName = null;
     }
 
+    /**
+     * Creates a new {@code PropertiesHolder} instance given a
+     * property file name.
+     *
+     * @param propertiesFileName The property file name
+     */
     public PropertiesHolder(String propertiesFileName) {
         this.properties = null;
         this.propertiesFileName = propertiesFileName;
     }
 
     /**
+     * Returns the {@code Properties} instance, loaded if necessary from 
{@code propertiesFileName}.
+     *
      * @param spi Optional SPI (may be null).
      *            If provided, an attempt is made to load the
      *            property file as-per Class.getResource().
      *
      * @param loaders Used only if properties need to be loaded.
      * 
-     * @return Properties.  Load the properties if necessary.
+     * @return The {@code Properties}, loaded if necessary.
      */
     public Properties getProperties(SPInterface<?> spi, ClassLoaders loaders) {
         if (properties == null) {
@@ -57,6 +71,11 @@ public class PropertiesHolder {
         return properties;
     }
 
+    /**
+     * Returns the property file name
+     *
+     * @return The property file name
+     */
     public String getPropertiesFileName() {
         return propertiesFileName;
     }