1 |
|
/* |
2 |
|
* Written by Doug Lea and Josh Bloch with assistance from members of JCP |
3 |
|
* JSR-166 Expert Group and released to the public domain, as explained at |
4 |
< |
* http://creativecommons.org/licenses/publicdomain |
4 |
> |
* http://creativecommons.org/publicdomain/zero/1.0/ |
5 |
|
*/ |
6 |
|
|
7 |
|
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 |
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 |
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}. |
55 |
< |
* |
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"> |
58 |
|
* Java Collections Framework</a>. |
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 |
|
* |
269 |
|
* Returns a view of the portion of this map whose keys range from |
270 |
|
* {@code fromKey} to {@code toKey}. If {@code fromKey} and |
271 |
|
* {@code toKey} are equal, the returned map is empty unless |
272 |
< |
* {@code fromExclusive} and {@code toExclusive} are both true. The |
272 |
> |
* {@code fromInclusive} and {@code toInclusive} are both true. The |
273 |
|
* returned map is backed by this map, so changes in the returned map are |
274 |
|
* reflected in this map, and vice-versa. The returned map supports all |
275 |
|
* optional map operations that this map supports. |