svn commit: r1678600 - /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java

[oh...@apache.org]

Author: oheger
Date: Sun May 10 20:08:01 2015
New Revision: 1678600

URL: http://svn.apache.org/r1678600
Log:
Javadoc improvement of the getKeys() method.

Of course, the iterator returned by an immutable configuration does not allow
removing elements.

Modified:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java?rev=1678600&r1=1678599&r2=1678600&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java Sun May 10 20:08:01 2015
@@ -118,13 +118,8 @@ public interface ImmutableConfiguration
 
     /**
      * 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()} 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
-     * {@link #clearProperty(String)} for this property. So it is
-     * highly recommended to avoid using the iterator's {@code remove()}
+     * iterator can be used to obtain all defined keys. It does not allow
+     * removing elements from this configuration via its {@code remove()}
      * method.
      *
      * @return An Iterator.