ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/main/java/util/NavigableMap.java

Comparing jsr166/src/main/java/util/NavigableMap.java (file contents):
Revision 1.24 by jsr166, Tue Mar 15 19:47:02 2011 UTC vs.
Revision 1.28 by jsr166, Sat Mar 9 01:51:15 2013 UTC

#	Line 9 | Line 9 | package java.util;
9		/**
10		* A {@link SortedMap} extended with navigation methods returning the
11		* closest matches for given search targets. Methods
12	<	* {@code lowerEntry}, {@code floorEntry}, {@code ceilingEntry},
13	<	* and {@code higherEntry} return {@code Map.Entry} objects
12	>	* {@link #lowerEntry}, {@link #floorEntry}, {@link #ceilingEntry},
13	>	* and {@link #higherEntry} return {@code Map.Entry} objects
14		* associated with keys respectively less than, less than or equal,
15		* greater than or equal, and greater than a given key, returning
16		* {@code null} if there is no such key.  Similarly, methods
17	<	* {@code lowerKey}, {@code floorKey}, {@code ceilingKey}, and
18	<	* {@code higherKey} return only the associated keys. All of these
17	>	* {@link #lowerKey}, {@link #floorKey}, {@link #ceilingKey}, and
18	>	* {@link #higherKey} return only the associated keys. All of these
19		* methods are designed for locating, not traversing entries.
20		*
21		* <p>A {@code NavigableMap} may be accessed and traversed in either
#	Line 30 | Line 30 | package java.util;
30		* Submaps of any {@code NavigableMap} must implement the {@code
31		* NavigableMap} interface.
32		*
33	<	* <p>This interface additionally defines methods {@code firstEntry},
34	<	* {@code pollFirstEntry}, {@code lastEntry}, and
35	<	* {@code pollLastEntry} that return and/or remove the least and
33	>	* <p>This interface additionally defines methods {@link #firstEntry},
34	>	* {@link #pollFirstEntry}, {@link #lastEntry}, and
35	>	* {@link #pollLastEntry} that return and/or remove the least and
36		* greatest mappings, if any exist, else returning {@code null}.
37		*
38		* <p>Implementations of entry-returning methods are expected to
#	Line 51 | Line 51 | package java.util;
51		* implement {@code NavigableMap}, but extensions and implementations
52		* of this interface are encouraged to override these methods to return
53		* {@code NavigableMap}.  Similarly,
54	<	* {@link #keySet()} can be overriden to return {@code NavigableSet}.
54	>	* {@link #keySet()} can be overridden to return {@code NavigableSet}.
55		*
56		* <p>This interface is a member of the
57		* <a href="{@docRoot}/../technotes/guides/collections/index.html">
#	Line 225 | Line 225 | public interface NavigableMap<K,V> exten
225		* operation), the results of the iteration are undefined.
226		*
227		* <p>The returned map has an ordering equivalent to
228	<	* <tt>{@link Collections#reverseOrder(Comparator) Collections.reverseOrder}(comparator())</tt>.
228	>	* {@link Collections#reverseOrder(Comparator) Collections.reverseOrder}{@code (comparator())}.
229		* The expression {@code m.descendingMap().descendingMap()} returns a
230		* view of {@code m} essentially equivalent to {@code m}.
231		*

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines