--- jsr166/src/jsr166x/NavigableMap.java 2004/09/06 17:01:54 1.1
+++ jsr166/src/jsr166x/NavigableMap.java 2004/09/07 11:37:57 1.2
@@ -9,19 +9,19 @@ package jsr166x;
import java.util.*;
/**
- * A {@link SortedMap} extended with methods returning key-value pairs
- * holding the closest matches for given search targets. Methods
- * lowerEntry, floorEntry, ceilingEntry,
- * and higherEntry return {@link Map.Entry} objects
- * associated with keys respectively less than, less than or equal,
- * greater than or equal, and greater than a given key, returning
- * null if there is no such key. These methods are designed
- * for locating, not traversing entries. To traverse, use view
- * iterators and/or submap. This interface additionally
- * defines methods firstEntry, pollFirstEntry
- * lastEntry, and pollLastEntry that return and/or
- * remove the least and greatest mappings, if any exist, else
- * returning null.
+ * A {@link SortedMap} extended with navigation methods returning
+ * key-value pairs holding the closest matches for given search
+ * targets. Methods lowerEntry, floorEntry,
+ * ceilingEntry, and higherEntry return
+ * Map.Entry objects associated with keys respectively less
+ * than, less than or equal, greater than or equal, and greater than a
+ * given key, returning null if there is no such key. These
+ * methods are designed for locating, not traversing entries. To
+ * traverse, use view iterators and/or submap. This interface
+ * additionally defines methods firstEntry,
+ * pollFirstEntry, lastEntry, and
+ * pollLastEntry that return and/or remove the least and
+ * greatest mappings, if any exist, else returning null.
*
*
Implementations of these methods are expected to return
* Map.Entry pairs representing snapshots of mappings at the
@@ -37,11 +37,11 @@ import java.util.*;
public interface NavigableMap extends SortedMap {
/**
* Returns a key-value mapping associated with the least key
- * greater than or equal to the given key, or null if there is
+ * greater than or equal to the given key, or null if there is
* no such entry.
*
* @param key the key.
- * @return an Entry associated with ceiling of given key, or null
+ * @return an Entry associated with ceiling of given key, or null
* if there is no such Entry.
* @throws ClassCastException if key cannot be compared with the keys
* currently in the map.
@@ -52,12 +52,12 @@ public interface NavigableMap exten
/**
* Returns a key-value mapping associated with the greatest
- * key strictly less than the given key, or null if there is no
+ * key strictly less than the given key, or null if there is no
* such entry.
*
* @param key the key.
* @return an Entry with greatest key less than the given
- * key, or null if there is no such Entry.
+ * key, or null if there is no such Entry.
* @throws ClassCastException if key cannot be compared with the keys
* currently in the map.
* @throws NullPointerException if key is null and this map
@@ -67,11 +67,11 @@ public interface NavigableMap exten
/**
* Returns a key-value mapping associated with the greatest
- * key less than or equal to the given key, or null if there is no
+ * key less than or equal to the given key, or null if there is no
* such entry.
*
* @param key the key.
- * @return an Entry associated with floor of given key, or null
+ * @return an Entry associated with floor of given key, or null
* if there is no such Entry.
* @throws ClassCastException if key cannot be compared with the keys
* currently in the map.
@@ -82,12 +82,12 @@ public interface NavigableMap exten
/**
* Returns a key-value mapping associated with the least
- * key strictly greater than the given key, or null if there is no
+ * key strictly greater than the given key, or null if there is no
* such entry.
*
* @param key the key.
* @return an Entry with least key greater than the given key, or
- * null if there is no such Entry.
+ * null if there is no such Entry.
* @throws ClassCastException if key cannot be compared with the keys
* currently in the map.
* @throws NullPointerException if key is null and this map
@@ -97,36 +97,36 @@ public interface NavigableMap exten
/**
* Returns a key-value mapping associated with the least
- * key in this map, or null if the map is empty.
+ * key in this map, or null if the map is empty.
*
- * @return an Entry with least key, or null
+ * @return an Entry with least key, or null
* if the map is empty.
*/
public Map.Entry firstEntry();
/**
* Returns a key-value mapping associated with the greatest
- * key in this map, or null if the map is empty.
+ * key in this map, or null if the map is empty.
*
- * @return an Entry with greatest key, or null
+ * @return an Entry with greatest key, or null
* if the map is empty.
*/
public Map.Entry lastEntry();
/**
* Removes and returns a key-value mapping associated with
- * the least key in this map, or null if the map is empty.
+ * the least key in this map, or null if the map is empty.
*
- * @return the removed first entry of this map, or null
+ * @return the removed first entry of this map, or null
* if the map is empty.
*/
public Map.Entry pollFirstEntry();
/**
* Removes and returns a key-value mapping associated with
- * the greatest key in this map, or null if the map is empty.
+ * the greatest key in this map, or null if the map is empty.
*
- * @return the removed last entry of this map, or null
+ * @return the removed last entry of this map, or null
* if the map is empty.
*/
public Map.Entry pollLastEntry();