NavigableMap

A {@link SortedMap} extended with navigation methods returning the closest matches for given search targets. Methods {@code lowerEntry}, {@code floorEntry}, {@code ceilingEntry}, and {@code higherEntry} return {@code MapEntry} objects associated with keys respectively less than, less than or equal, greater than or equal, and greater than a given key, returning {@code null} if there is no such key. Similarly, methods {@code lowerKey}, {@code floorKey}, {@code ceilingKey}, and {@code higherKey} return only the associated keys. All of these methods are designed for locating, not traversing entries.

A {@code NavigableMap} may be accessed and traversed in either ascending or descending key order. The {@code descendingMap} method returns a view of the map with the senses of all relational and directional methods inverted. The performance of ascending operations and views is likely to be faster than that of descending ones. Methods {@code subMap}, {@code headMap}, and {@code tailMap} differ from the like-named {@code SortedMap} methods in accepting additional arguments describing whether lower and upper bounds are inclusive versus exclusive. Submaps of any {@code NavigableMap} must implement the {@code NavigableMap} interface.

This interface additionally defines methods {@code firstEntry}, {@code pollFirstEntry}, {@code lastEntry}, and {@code pollLastEntry} that return and/or remove the least and greatest mappings, if any exist, else returning {@code null}.

Implementations of entry-returning methods are expected to return {@code MapEntry} pairs representing snapshots of mappings at the time they were produced, and thus generally do not support the optional {@code Entry.setValue} method. Note however that it is possible to change mappings in the associated map using method {@code put}.

Methods {@link #subMap(Object, Object) subMap(K, K)}, {@link #headMap(Object) headMap(K)}, and {@link #tailMap(Object) tailMap(K)} are specified to return {@code SortedMap} to allow existing implementations of {@code SortedMap} to be compatibly retrofitted to implement {@code NavigableMap}, but extensions and implementations of this interface are encouraged to override these methods to return {@code NavigableMap}. Similarly, {@link #keySet()} can be overriden to return {@code NavigableSet}.

This interface is a member of the <a href="{@docRoot}/../technotes/guides/collections/index.html"> Java Collections Framework</a>.

@author Doug Lea @author Josh Bloch @param !K the type of keys maintained by this map @param !V the type of mapped values

interface NavigableMap : SortedMap!(K, V)(

) {

MapEntry!(K, V) lowerEntry(K key);

K lowerKey(K key);

MapEntry!(K, V) floorEntry(K key);

K floorKey(K key);

MapEntry!(K, V) ceilingEntry(K key);

K ceilingKey(K key);

MapEntry!(K, V) higherEntry(K key);

K higherKey(K key);

MapEntry!(K, V) firstEntry();

MapEntry!(K, V) lastEntry();

MapEntry!(K, V) pollFirstEntry();

MapEntry!(K, V) pollLastEntry();

NavigableMap!(K, V) subMap(K fromKey, bool fromInclusive, K toKey, bool toInclusive);

NavigableMap!(K, V) headMap(K toKey, bool inclusive);

NavigableMap!(K, V) tailMap(K fromKey, bool inclusive);

SortedMap!(K, V) subMap(K fromKey, K toKey);

SortedMap!(K, V) headMap(K toKey);

SortedMap!(K, V) tailMap(K fromKey);

}

Members

Functions

ceilingEntry MapEntry!(K, V) ceilingEntry(K key): Returns a key-value mapping associated with the least key greater than or equal to the given key, or {@code null} if there is no such key.
ceilingKey K ceilingKey(K key): Returns the least key greater than or equal to the given key, or {@code null} if there is no such key.
firstEntry MapEntry!(K, V) firstEntry(): Returns a key-value mapping associated with the least key in this map, or {@code null} if the map is empty.
floorEntry MapEntry!(K, V) floorEntry(K key): Returns a key-value mapping associated with the greatest key less than or equal to the given key, or {@code null} if there is no such key.
floorKey K floorKey(K key): Returns the greatest key less than or equal to the given key, or {@code null} if there is no such key.
headMap SortedMap!(K, V) headMap(K toKey): {@inheritDoc}
headMap NavigableMap!(K, V) headMap(K toKey, bool inclusive): Returns a view of the portion of this map whose keys are less than (or equal to, if {@code inclusive} is true) {@code toKey}. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.
higherEntry MapEntry!(K, V) higherEntry(K key): Returns a key-value mapping associated with the least key strictly greater than the given key, or {@code null} if there is no such key.
higherKey K higherKey(K key): Returns the least key strictly greater than the given key, or {@code null} if there is no such key.
lastEntry MapEntry!(K, V) lastEntry(): Returns a key-value mapping associated with the greatest key in this map, or {@code null} if the map is empty.
lowerEntry MapEntry!(K, V) lowerEntry(K key): Returns a key-value mapping associated with the greatest key strictly less than the given key, or {@code null} if there is no such key.
lowerKey K lowerKey(K key): Returns the greatest key strictly less than the given key, or {@code null} if there is no such key.
pollFirstEntry MapEntry!(K, V) pollFirstEntry(): Removes and returns a key-value mapping associated with the least key in this map, or {@code null} if the map is empty.
pollLastEntry MapEntry!(K, V) pollLastEntry(): Removes and returns a key-value mapping associated with the greatest key in this map, or {@code null} if the map is empty.
subMap NavigableMap!(K, V) subMap(K fromKey, bool fromInclusive, K toKey, bool toInclusive): Returns a view of the portion of this map whose keys range from {@code fromKey} to {@code toKey}. If {@code fromKey} and {@code toKey} are equal, the returned map is empty unless {@code fromInclusive} and {@code toInclusive} are both true. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.
subMap SortedMap!(K, V) subMap(K fromKey, K toKey): {@inheritDoc}
tailMap NavigableMap!(K, V) tailMap(K fromKey, bool inclusive): Returns a view of the portion of this map whose keys are greater than (or equal to, if {@code inclusive} is true) {@code fromKey}. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.
tailMap SortedMap!(K, V) tailMap(K fromKey): {@inheritDoc}

NavigableMap

Members

Functions

Meta

Source