2004-11-07 Andrew John Hughes <gnu_andrew@member.fsf.org>

       * java/util/Collections.java
       Added documentation.
       * java/util/SortedMap.java
       Clarified some method examples.
       * java/util/SortedSet.java
       Clarified some method examples.

From-SVN: r90227

libjava/ChangeLog

 2004-11-07  Andrew John Hughes <gnu_andrew@member.fsf.org>
 
+	* java/util/Collections.java
+	Added documentation.
+	* java/util/SortedMap.java
+	Clarified some method examples.
+	* java/util/SortedSet.java
+	Clarified some method examples.
+
+2004-11-07  Andrew John Hughes <gnu_andrew@member.fsf.org>
+
 	* java/util/Currency.java
 	Documented variables and methods more fully.
 	Caches the currency instances, so that a request

libjava/java/util/SortedMap.java

@@ -97,10 +97,10 @@ public interface SortedMap extends Map
    * <p>
    *
    * The returned map throws an IllegalArgumentException any time a key is
-   * used which is out of the range of toKey. Note that the endpoint is not
-   * included; if you want the endpoint, pass the successor object in to
-   * toKey.  For example, for Strings, you can request
-   * <code>headMap(limit + "\0")</code>.
+   * used which is out of the range of toKey. Note that the endpoint, toKey,
+   * is not included; if you want this value to be included, pass its successor
+   * object in to toKey.  For example, for Integers, you could request
+   * <code>headMap(new Integer(limit.intValue() + 1))</code>.
    *
    * @param toKey the exclusive upper range of the submap
    * @return the submap
@@ -130,9 +130,10 @@ public interface SortedMap extends Map
    * The returned map throws an IllegalArgumentException any time a key is
    * used which is out of the range of fromKey and toKey. Note that the
    * lower endpoint is included, but the upper is not; if you want to
-   * change the inclusion or exclusion of an endpoint, pass the successor
-   * object in instead.  For example, for Strings, you can request
-   * <code>subMap(lowlimit + "\0", highlimit + "\0")</code> to reverse
+   * change the inclusion or exclusion of an endpoint, pass its successor
+   * object in instead.  For example, for Integers, you could request
+   * <code>subMap(new Integer(lowlimit.intValue() + 1),
+   * new Integer(highlimit.intValue() + 1))</code> to reverse
    * the inclusiveness of both endpoints.
    *
    * @param fromKey the inclusive lower range of the submap
@@ -154,10 +155,10 @@ public interface SortedMap extends Map
    * <p>
    *
    * The returned map throws an IllegalArgumentException any time a key is
-   * used which is out of the range of fromKey. Note that the endpoint is
-   * included; if you do not want the endpoint, pass the successor object in
-   * to fromKey.  For example, for Strings, you can request
-   * <code>tailMap(limit + "\0")</code>.
+   * used which is out of the range of fromKey. Note that the endpoint, fromKey, is
+   * included; if you do not want this value to be included, pass its successor object in
+   * to fromKey.  For example, for Integers, you could request
+   * <code>tailMap(new Integer(limit.intValue() + 1))</code>.
    *
    * @param fromKey the inclusive lower range of the submap
    * @return the submap

libjava/java/util/SortedSet.java

@@ -99,10 +99,10 @@ public interface SortedSet extends Set
    * <p>
    *
    * The returned set throws an IllegalArgumentException any time an element is
-   * used which is out of the range of toElement. Note that the endpoint is not
-   * included; if you want the endpoint, pass the successor object in to
-   * toElement.  For example, for Strings, you can request
-   * <code>headSet(limit + "\0")</code>.
+   * used which is out of the range of toElement. Note that the endpoint, toElement,
+   * is not included; if you want this value included, pass its successor object in to
+   * toElement.  For example, for Integers, you could request
+   * <code>headSet(new Integer(limit.intValue() + 1))</code>.
    *
    * @param toElement the exclusive upper range of the subset
    * @return the subset
@@ -133,9 +133,10 @@ public interface SortedSet extends Set
    * The returned set throws an IllegalArgumentException any time an element is
    * used which is out of the range of fromElement and toElement. Note that the
    * lower endpoint is included, but the upper is not; if you want to
-   * change the inclusion or exclusion of an endpoint, pass the successor
-   * object in instead.  For example, for Strings, you can request
-   * <code>subSet(lowlimit + "\0", highlimit + "\0")</code> to reverse
+   * change the inclusion or exclusion of an endpoint, pass its successor
+   * object in instead.  For example, for Integers, you can request
+   * <code>subSet(new Integer(lowlimit.intValue() + 1),
+   * new Integer(highlimit.intValue() + 1))</code> to reverse
    * the inclusiveness of both endpoints.
    *
    * @param fromElement the inclusive lower range of the subset
@@ -157,10 +158,10 @@ public interface SortedSet extends Set
    * <p>
    *
    * The returned set throws an IllegalArgumentException any time an element is
-   * used which is out of the range of fromElement. Note that the endpoint is
-   * included; if you do not want the endpoint, pass the successor object in
-   * to fromElement.  For example, for Strings, you can request
-   * <code>tailSet(limit + "\0")</code>.
+   * used which is out of the range of fromElement. Note that the endpoint,
+   * fromElement, is included; if you do not want this value to be included, pass its
+   * successor object in to fromElement.  For example, for Integers, you could request
+   * <code>tailSet(new Integer(limit.intValue() + 1))</code>.
    *
    * @param fromElement the inclusive lower range of the subset
    * @return the subset