commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ohe...@apache.org
Subject svn commit: r263898 - /jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/Configuration.java
Date Sun, 28 Aug 2005 18:17:14 GMT
Author: oheger
Date: Sun Aug 28 11:17:05 2005
New Revision: 263898

URL: http://svn.apache.org/viewcvs?rev=263898&view=rev
Log:
JavaDoc update of the getKeys() method

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

Modified: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/Configuration.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/Configuration.java?rev=263898&r1=263897&r2=263898&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/Configuration.java
(original)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/Configuration.java
Sun Aug 28 11:17:05 2005
@@ -135,12 +135,21 @@
      *
      * @param prefix The prefix to test against.
      * @return An Iterator of keys that match the prefix.
+     * @see #getKeys()
      */
     Iterator getKeys(String prefix);
 
     /**
-     * Get the list of the keys contained in the configuration.
-     *
+     * Get the list of the keys contained in the configuration. The returned
+     * iterator can be used to obtain all defined keys. Note that the exact
+     * behavior of the iterator's <code>remove()</code> method is specific to
+     * a concrete implementation. It <em>may</em> remove the corresponding
+     * property from the configuration, but this is not guaranteed. In any case
+     * it is no replacement for calling
+     * <code>{@link #clearProperty(String)}</code> for this property. So it is
+     * highly recommended to avoid using the iterator's <code>remove()</code>
+     * method.
+     * 
      * @return An Iterator.
      */
     Iterator getKeys();



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