commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ohe...@apache.org
Subject svn commit: r442690 - in /jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration: AbstractConfiguration.java PropertyConverter.java
Date Tue, 12 Sep 2006 20:03:19 GMT
Author: oheger
Date: Tue Sep 12 13:03:18 2006
New Revision: 442690

URL: http://svn.apache.org/viewvc?view=rev&rev=442690
Log:
JavaDoc enhancement related to CONFIGURATION-226

Modified:
    jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/AbstractConfiguration.java
    jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertyConverter.java

Modified: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/AbstractConfiguration.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/AbstractConfiguration.java?view=diff&rev=442690&r1=442689&r2=442690
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/AbstractConfiguration.java
(original)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/AbstractConfiguration.java
Tue Sep 12 13:03:18 2006
@@ -472,6 +472,7 @@
 
     /**
      * {@inheritDoc}
+     * @see PropertyConverter#toBoolean(Object)
      */
     public boolean getBoolean(String key)
     {
@@ -488,6 +489,7 @@
 
     /**
      * {@inheritDoc}
+     * @see PropertyConverter#toBoolean(Object)
      */
     public boolean getBoolean(String key, boolean defaultValue)
     {
@@ -495,7 +497,16 @@
     }
 
     /**
-     * {@inheritDoc}
+     * Obtains the value of the specified key and tries to convert it into a
+     * <code>Boolean</code> object. If the property has no value, the passed
+     * in default value will be used.
+     *
+     * @param key the key of the property
+     * @param defaultValue the default value
+     * @return the value of this key converted to a <code>Boolean</code>
+     * @throws ConversionException if the value cannot be converted to a
+     * <code>Boolean</code>
+     * @see PropertyConverter#toBoolean(Object)
      */
     public Boolean getBoolean(String key, Boolean defaultValue)
     {

Modified: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertyConverter.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertyConverter.java?view=diff&rev=442690&r1=442689&r2=442690
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertyConverter.java
(original)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/PropertyConverter.java
Tue Sep 12 13:03:18 2006
@@ -72,7 +72,13 @@
     }
 
     /**
-     * Convert the specified object into a Boolean.
+     * Convert the specified object into a Boolean. Internally the
+     * <code>org.apache.commons.lang.BooleanUtils</code> class from the
+     * <a href="http://jakarta.apache.org/commons/lang/">Commons Lang</a>
+     * project is used to perform this conversion. This class accepts some more
+     * tokens for the boolean value of <b>true</b>, e.g. <code>yes</code>
and
+     * <code>on</code>. Please refer to the documentation of this class for more
+     * details.
      *
      * @param value the value to convert
      * @return the converted value



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