ebourg 2004/10/18 02:52:02
Modified: configuration/src/java/org/apache/commons/configuration
Configuration.java
Log:
Javadoc update
Revision Changes Path
1.11 +32 -2
jakarta-commons/configuration/src/java/org/apache/commons/configuration/Configuration.java
Index: Configuration.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/configuration/src/java/org/apache/commons/configuration/Configuration.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Configuration.java 16 Aug 2004 22:16:31 -0000 1.10
+++ Configuration.java 18 Oct 2004 09:52:02 -0000 1.11
@@ -171,6 +171,8 @@
/**
* Get a boolean associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -210,6 +212,8 @@
/**
* Get a byte associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -249,6 +253,8 @@
/**
* Get a double associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -287,6 +293,8 @@
/**
* Get a float associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -299,6 +307,8 @@
/**
* Get a [EMAIL PROTECTED] Float} associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -326,6 +336,8 @@
/**
* Get a int associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -338,6 +350,8 @@
/**
* Get an [EMAIL PROTECTED] Integer} associated with the given configuration
key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -365,6 +379,8 @@
/**
* Get a long associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -377,6 +393,8 @@
/**
* Get a [EMAIL PROTECTED] Long} associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -416,6 +434,8 @@
/**
* Get a [EMAIL PROTECTED] Short} associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -443,6 +463,8 @@
/**
* Get a [EMAIL PROTECTED] BigDecimal} associated with the given configuration
key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -466,6 +488,8 @@
/**
* Get a [EMAIL PROTECTED] BigInteger} associated with the given configuration
key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -491,6 +515,8 @@
/**
* Get a string associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
@@ -528,10 +554,12 @@
/**
* Get a List of strings associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
- * @return The associated List.
+ * @return The associated List of strings.
*
* @throws ConversionException is thrown if the key maps to an
* object that is not a List.
@@ -556,6 +584,8 @@
/**
* Get a Vector of strings associated with the given configuration key.
+ * If the key doesn't map to an existing object, the default value
+ * is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
