--- jsr166/src/jsr166x/NavigableMap.java	2004/12/21 17:27:44	1.3
+++ jsr166/src/jsr166x/NavigableMap.java	2011/12/05 04:48:16	1.8
@@ -1,7 +1,7 @@
 /*
  * Written by Doug Lea with assistance from members of JCP JSR-166
  * Expert Group and released to the public domain, as explained at
- * http://creativecommons.org/licenses/publicdomain
+ * http://creativecommons.org/publicdomain/zero/1.0/
  */
 
 package jsr166x;
@@ -9,27 +9,26 @@ package jsr166x;
 import java.util.*;
 
 /**
- * A {@link SortedMap} extended with navigation methods returning
- * key-value pairs holding the closest matches for given search
- * targets. Methods <tt>lowerEntry</tt>, <tt>floorEntry</tt>,
- * <tt>ceilingEntry</tt>, and <tt>higherEntry</tt> return
- * <tt>Map.Entry</tt> objects associated with keys respectively less
- * than, less than or equal, greater than or equal, and greater than a
- * given key, returning <tt>null</tt> if there is no such key.
- * Similarly, methods <tt>lowerKey</tt>, <tt>floorKey</tt>,
- * <tt>ceilingKey</tt>, and <tt>higherKey</tt> return only the
- * associated keys. All of these methods are designed for locating,
- * not traversing entries.
+ * A {@link SortedMap} extended with navigation methods returning the
+ * closest matches for given search targets. Methods
+ * <tt>lowerEntry</tt>, <tt>floorEntry</tt>, <tt>ceilingEntry</tt>,
+ * and <tt>higherEntry</tt> return <tt>Map.Entry</tt> objects
+ * associated with keys respectively less than, less than or equal,
+ * greater than or equal, and greater than a given key, returning
+ * <tt>null</tt> if there is no such key.  Similarly, methods
+ * <tt>lowerKey</tt>, <tt>floorKey</tt>, <tt>ceilingKey</tt>, and
+ * <tt>higherKey</tt> return only the associated keys. All of these
+ * methods are designed for locating, not traversing entries.
  *
  * <p>A <tt>NavigableMap</tt> may be viewed and traversed in either
  * ascending or descending key order.  The <tt>Map</tt> methods
- * <tt>keySet</tt> and <tt>entrySet</tt>) return ascending views, and
+ * <tt>keySet</tt> and <tt>entrySet</tt> return ascending views, and
  * the additional methods <tt>descendingKeySet</tt> and
- * <tt>descendingEntrySet</tt>) return descending views. The
+ * <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>.
- * 
+ *
  * <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
@@ -44,14 +43,14 @@ import 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
  */
 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.
@@ -65,7 +64,7 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
@@ -79,8 +78,8 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
@@ -94,7 +93,7 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
@@ -109,7 +108,7 @@ public interface NavigableMap<K,V> exten
      * 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.
@@ -124,7 +123,7 @@ public interface NavigableMap<K,V> exten
      * 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.
@@ -139,7 +138,7 @@ public interface NavigableMap<K,V> exten
      * 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.
@@ -153,7 +152,7 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
@@ -167,8 +166,8 @@ public interface NavigableMap<K,V> exten
     /**
      * 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();
@@ -176,7 +175,7 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
      */
@@ -185,7 +184,7 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
      */
@@ -194,7 +193,7 @@ public interface NavigableMap<K,V> exten
     /**
      * 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.
      */
@@ -220,7 +219,7 @@ public interface NavigableMap<K,V> exten
     /**
      * Returns a set view of the mappings contained in this map, in
      * descending key order.  Each element in the returned set is a
-     * {@link Map.Entry}.  The set is backed by the map, so changes to
+     * <tt>Map.Entry</tt>.  The set is backed by the map, so changes to
      * the map are reflected in the set, and vice-versa.  If the map
      * is modified while an iteration over the set is in progress
      * (except through the iterator's own <tt>remove</tt> operation,
@@ -243,7 +242,7 @@ public interface NavigableMap<K,V> exten
      * <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.
-
+     *
      * @param fromKey low endpoint (inclusive) of the subMap.
      * @param toKey high endpoint (exclusive) of the subMap.
      *
@@ -266,7 +265,7 @@ public interface NavigableMap<K,V> exten
      * 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.  
+     * 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>.
@@ -293,5 +292,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);
+    public NavigableMap<K,V> tailMap(K fromKey);
 }