--- jsr166/src/main/java/util/NavigableMap.java	2004/12/28 12:14:07	1.1
+++ jsr166/src/main/java/util/NavigableMap.java	2005/05/02 22:34:56	1.6
@@ -25,8 +25,12 @@ package java.util;
  * <tt>descendingEntrySet</tt> return descending views. The
  * performance of ascending traversals is likely to be faster than
  * descending traversals.  Notice that it is possible to perform
- * subrannge traversals in either direction using <tt>SubMap</tt>.
- * 
+ * subrange traversals in either direction using <tt>navigableSubMap</tt>.
+ * Methods <tt>navigableSubMap</tt>, <tt>navigableHeadMap</tt>, and
+ * <tt>navigableTailMap</tt> differ from the similarly named
+ * <tt>SortedMap</tt> methods only in that the returned maps
+ * are guaranteed to obey the <tt>NavigableMap</tt> interface.
+ *
  * <p>This interface additionally defines methods <tt>firstEntry</tt>,
  * <tt>pollFirstEntry</tt>, <tt>lastEntry</tt>, and
  * <tt>pollLastEntry</tt> that return and/or remove the least and
@@ -41,14 +45,15 @@ package java.util;
  *
  * @author Doug Lea
  * @param <K> the type of keys maintained by this map
- * @param <V> the type of mapped values 
+ * @param <V> the type of mapped values
+ * @since 1.6
  */
 public interface NavigableMap<K,V> extends SortedMap<K,V> {
     /**
      * Returns a key-value mapping associated with the least key
      * greater than or equal to the given key, or <tt>null</tt> if there is
-     * no such entry. 
-     * 
+     * no such entry.
+     *
      * @param key the key.
      * @return an Entry associated with ceiling of given key, or <tt>null</tt>
      * if there is no such Entry.
@@ -57,12 +62,12 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public Map.Entry<K,V> ceilingEntry(K key);
+    Map.Entry<K,V> ceilingEntry(K key);
 
     /**
      * Returns least key greater than or equal to the given key, or
      * <tt>null</tt> if there is no such key.
-     * 
+     *
      * @param key the key.
      * @return the ceiling key, or <tt>null</tt>
      * if there is no such key.
@@ -71,13 +76,13 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public K ceilingKey(K key);
+    K ceilingKey(K key);
 
     /**
      * Returns a key-value mapping associated with the greatest
      * key strictly less than the given key, or <tt>null</tt> if there is no
-     * such entry. 
-     * 
+     * such entry.
+     *
      * @param key the key.
      * @return an Entry with greatest key less than the given
      * key, or <tt>null</tt> if there is no such Entry.
@@ -86,12 +91,12 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public Map.Entry<K,V> lowerEntry(K key);
+    Map.Entry<K,V> lowerEntry(K key);
 
     /**
      * Returns the greatest key strictly less than the given key, or
      * <tt>null</tt> if there is no such key.
-     * 
+     *
      * @param key the key.
      * @return the greatest key less than the given
      * key, or <tt>null</tt> if there is no such key.
@@ -100,13 +105,13 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public K lowerKey(K key);
+    K lowerKey(K key);
 
     /**
      * Returns a key-value mapping associated with the greatest key
      * less than or equal to the given key, or <tt>null</tt> if there
      * is no such entry.
-     * 
+     *
      * @param key the key.
      * @return an Entry associated with floor of given key, or <tt>null</tt>
      * if there is no such Entry.
@@ -115,13 +120,13 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public Map.Entry<K,V> floorEntry(K key);
+    Map.Entry<K,V> floorEntry(K key);
 
     /**
      * Returns the greatest key
      * less than or equal to the given key, or <tt>null</tt> if there
      * is no such key.
-     * 
+     *
      * @param key the key.
      * @return the floor of given key, or <tt>null</tt> if there is no
      * such key.
@@ -130,13 +135,13 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public K floorKey(K key);
+    K floorKey(K key);
 
     /**
      * Returns a key-value mapping associated with the least key
      * strictly greater than the given key, or <tt>null</tt> if there
      * is no such entry.
-     * 
+     *
      * @param key the key.
      * @return an Entry with least key greater than the given key, or
      * <tt>null</tt> if there is no such Entry.
@@ -145,12 +150,12 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public Map.Entry<K,V> higherEntry(K key);
+    Map.Entry<K,V> higherEntry(K key);
 
     /**
      * Returns the least key strictly greater than the given key, or
      * <tt>null</tt> if there is no such key.
-     * 
+     *
      * @param key the key.
      * @return the least key greater than the given key, or
      * <tt>null</tt> if there is no such key.
@@ -159,43 +164,43 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if key is <tt>null</tt> and this map
      * does not support <tt>null</tt> keys.
      */
-    public K higherKey(K key);
+    K higherKey(K key);
 
     /**
      * Returns a key-value mapping associated with the least
      * key in this map, or <tt>null</tt> if the map is empty.
-     * 
-     * @return an Entry with least key, or <tt>null</tt> 
+     *
+     * @return an Entry with least key, or <tt>null</tt>
      * if the map is empty.
      */
-    public Map.Entry<K,V> firstEntry();
+    Map.Entry<K,V> firstEntry();
 
     /**
      * Returns a key-value mapping associated with the greatest
      * key in this map, or <tt>null</tt> if the map is empty.
-     * 
+     *
      * @return an Entry with greatest key, or <tt>null</tt>
      * if the map is empty.
      */
-    public Map.Entry<K,V> lastEntry();
+    Map.Entry<K,V> lastEntry();
 
     /**
      * Removes and returns a key-value mapping associated with
      * the least key in this map, or <tt>null</tt> if the map is empty.
-     * 
+     *
      * @return the removed first entry of this map, or <tt>null</tt>
      * if the map is empty.
      */
-    public Map.Entry<K,V> pollFirstEntry();
+    Map.Entry<K,V> pollFirstEntry();
 
     /**
      * Removes and returns a key-value mapping associated with
      * the greatest key in this map, or <tt>null</tt> if the map is empty.
-     * 
+     *
      * @return the removed last entry of this map, or <tt>null</tt>
      * if the map is empty.
      */
-    public Map.Entry<K,V> pollLastEntry();
+    Map.Entry<K,V> pollLastEntry();
 
     /**
      * Returns a set view of the keys contained in this map, in
@@ -237,10 +242,11 @@ public interface NavigableMap<K,V> exten
     /**
      * Returns a view of the portion of this map whose keys range from
      * <tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive.  (If
-     * <tt>fromKey</tt> and <tt>toKey</tt> are equal, the returned sorted map
-     * is empty.)  The returned sorted map is backed by this map, so changes
-     * in the returned sorted map are reflected in this map, and vice-versa.
-
+     * <tt>fromKey</tt> and <tt>toKey</tt> are equal, the returned
+     * navigable map is empty.)  The returned navigable map is backed
+     * by this map, so changes in the returned navigable map are
+     * reflected in this map, and vice-versa.
+     *
      * @param fromKey low endpoint (inclusive) of the subMap.
      * @param toKey high endpoint (exclusive) of the subMap.
      *
@@ -257,13 +263,13 @@ public interface NavigableMap<K,V> exten
      * <tt>toKey</tt> is <tt>null</tt> and this map does not support
      * <tt>null</tt> keys.
      */
-    public NavigableMap<K,V> subMap(K fromKey, K toKey);
+    NavigableMap<K,V> navigableSubMap(K fromKey, K toKey);
 
     /**
      * Returns a view of the portion of this map whose keys are strictly less
-     * than <tt>toKey</tt>.  The returned sorted map is backed by this map, so
-     * changes in the returned sorted map are reflected in this map, and
-     * vice-versa.  
+     * than <tt>toKey</tt>.  The returned navigable map is backed by this map, so
+     * changes in the returned navigable map are reflected in this map, and
+     * vice-versa.
      * @param toKey high endpoint (exclusive) of the headMap.
      * @return a view of the portion of this map whose keys are strictly
      *                less than <tt>toKey</tt>.
@@ -274,12 +280,12 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if <tt>toKey</tt> is <tt>null</tt>
      * and this map does not support <tt>null</tt> keys.
      */
-    public NavigableMap<K,V> headMap(K toKey);
+    NavigableMap<K,V> navigableHeadMap(K toKey);
 
     /**
      * Returns a view of the portion of this map whose keys are
-     * greater than or equal to <tt>fromKey</tt>.  The returned sorted
-     * map is backed by this map, so changes in the returned sorted
+     * greater than or equal to <tt>fromKey</tt>.  The returned navigable
+     * map is backed by this map, so changes in the returned navigable
      * map are reflected in this map, and vice-versa.
      * @param fromKey low endpoint (inclusive) of the tailMap.
      * @return a view of the portion of this map whose keys are greater
@@ -290,5 +296,5 @@ public interface NavigableMap<K,V> exten
      * @throws NullPointerException if <tt>fromKey</tt> is <tt>null</tt>
      * and this map does not support <tt>null</tt> keys.
      */
-    public NavigableMap<K,V>  tailMap(K fromKey);
+    NavigableMap<K,V>  navigableTailMap(K fromKey);
 }