NavigableMap
  public
  
  
  
  interface
  NavigableMap
  
  
      implements
      
        SortedMap<K, V>
      
  
  
| java.util.NavigableMap<K, V> | 
A SortedMap extended with navigation methods returning the
 closest matches for given search targets. Methods
 lowerEntry(K), floorEntry(K), ceilingEntry(K),
 and higherEntry(K) 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.  Similarly, methods
 lowerKey(K), floorKey(K), ceilingKey(K), and
 higherKey(K) return only the associated keys. All of these
 methods are designed for locating, not traversing entries.
 
A NavigableMap may be accessed and traversed in either
 ascending or descending key order.  The 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
 subMap(K, boolean, K, boolean),
 headMap(K, boolean), and
 tailMap(K, boolean)
 differ from the like-named SortedMap methods in accepting
 additional arguments describing whether lower and upper bounds are
 inclusive versus exclusive.  Submaps of any NavigableMap
 must implement the NavigableMap interface.
 
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.
 
The methods
 ceilingEntry(K),
 firstEntry(),
 floorEntry(K),
 higherEntry(K),
 lastEntry(),
 lowerEntry(K),
 pollFirstEntry(), and
 pollLastEntry()
 return Map.Entry instances that represent snapshots of mappings as
 of the time of the call. They do not support mutation of the
 underlying map via the optional setValue method.
 
Methods
 subMap(K, K),
 headMap(K), and
 tailMap(K)
 are specified to return SortedMap to allow existing
 implementations of SortedMap to be compatibly retrofitted to
 implement NavigableMap, but extensions and implementations
 of this interface are encouraged to override these methods to return
 NavigableMap.  Similarly,
 SortedMap.keySet() can be overridden to return NavigableSet.
Summary
| Public methods | |
|---|---|
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      ceilingEntry(K key)
      Returns a key-value mapping associated with the least key
 greater than or equal to the given key, or  | 
| 
        abstract
        
        
        
        
        K | 
      ceilingKey(K key)
      Returns the least key greater than or equal to the given key,
 or  | 
| 
        abstract
        
        
        
        
        NavigableSet<K> | 
      descendingKeySet()
      Returns a reverse order  | 
| 
        abstract
        
        
        
        
        NavigableMap<K, V> | 
      descendingMap()
      Returns a reverse order view of the mappings contained in this map. | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      firstEntry()
      Returns a key-value mapping associated with the least
 key in this map, or  | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      floorEntry(K key)
      Returns a key-value mapping associated with the greatest key
 less than or equal to the given key, or  | 
| 
        abstract
        
        
        
        
        K | 
      floorKey(K key)
      Returns the greatest key less than or equal to the given key,
 or  | 
| 
        abstract
        
        
        
        
        SortedMap<K, V> | 
      headMap(K toKey)
      Returns a view of the portion of this map whose keys are
 strictly less than  Equivalent to  | 
| 
        abstract
        
        
        
        
        NavigableMap<K, V> | 
      headMap(K toKey, boolean inclusive)
      Returns a view of the portion of this map whose keys are less than (or
 equal to, if  | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      higherEntry(K key)
      Returns a key-value mapping associated with the least key
 strictly greater than the given key, or  | 
| 
        abstract
        
        
        
        
        K | 
      higherKey(K key)
      Returns the least key strictly greater than the given key, or
  | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      lastEntry()
      Returns a key-value mapping associated with the greatest
 key in this map, or  | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      lowerEntry(K key)
      Returns a key-value mapping associated with the greatest key
 strictly less than the given key, or  | 
| 
        abstract
        
        
        
        
        K | 
      lowerKey(K key)
      Returns the greatest key strictly less than the given key, or
  | 
| 
        abstract
        
        
        
        
        NavigableSet<K> | 
      navigableKeySet()
      Returns a  | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      pollFirstEntry()
      Removes and returns a key-value mapping associated with
 the least key in this map, or  | 
| 
        abstract
        
        
        
        
        Entry<K, V> | 
      pollLastEntry()
      Removes and returns a key-value mapping associated with
 the greatest key in this map, or  | 
| 
        
        default
        
        
        
        NavigableMap<K, V> | 
      reversed()
      Returns a reverse-ordered view of this map. 
 This method is equivalent to  | 
| 
        abstract
        
        
        
        
        SortedMap<K, V> | 
      subMap(K fromKey, K toKey)
      Returns a view of the portion of this map whose keys range from
  Equivalent to  | 
| 
        abstract
        
        
        
        
        NavigableMap<K, V> | 
      subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
      Returns a view of the portion of this map whose keys range from
  | 
| 
        abstract
        
        
        
        
        NavigableMap<K, V> | 
      tailMap(K fromKey, boolean inclusive)
      Returns a view of the portion of this map whose keys are greater than (or
 equal to, if  | 
| 
        abstract
        
        
        
        
        SortedMap<K, V> | 
      tailMap(K fromKey)
      Returns a view of the portion of this map whose keys are
 greater than or equal to  Equivalent to  | 
| Inherited methods | |
|---|---|
Public methods
ceilingEntry
public abstract Entry<K, V> ceilingEntry (K key)
Returns a key-value mapping associated with the least key
 greater than or equal to the given key, or null if
 there is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| Entry<K, V> | an entry with the least key greater than or equal to key, ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
ceilingKey
public abstract K ceilingKey (K key)
Returns the least key greater than or equal to the given key,
 or null if there is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| K | the least key greater than or equal to key,
         ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
descendingKeySet
public abstract NavigableSet<K> descendingKeySet ()
Returns a reverse order NavigableSet view of the keys contained in this map.
 The set's iterator returns the keys in descending order.
 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 remove operation), the results of the iteration are undefined.  The
 set supports element removal, which removes the corresponding mapping
 from the map, via the Iterator.remove, Set.remove,
 removeAll, retainAll, and clear operations.
 It does not support the add or addAll operations.
| Returns | |
|---|---|
| NavigableSet<K> | a reverse order navigable set view of the keys in this map | 
descendingMap
public abstract NavigableMap<K, V> descendingMap ()
Returns a reverse order view of the mappings contained in this map.
 The descending map is backed by this map, so changes to the map are
 reflected in the descending map, and vice-versa.  If either map is
 modified while an iteration over a collection view of either map
 is in progress (except through the iterator's own remove
 operation), the results of the iteration are undefined.
 
The returned map has an ordering equivalent to
 Collections.reverseOrder(comparator()).
 The expression m.descendingMap().descendingMap() returns a
 view of m essentially equivalent to m.
| Returns | |
|---|---|
| NavigableMap<K, V> | a reverse order view of this map | 
firstEntry
public abstract Entry<K, V> firstEntry ()
Returns a key-value mapping associated with the least
 key in this map, or null if the map is empty.
| Returns | |
|---|---|
| Entry<K, V> | an entry with the least key,
         or nullif this map is empty | 
floorEntry
public abstract Entry<K, V> floorEntry (K key)
Returns a key-value mapping associated with the greatest key
 less than or equal to the given key, or null if there
 is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| Entry<K, V> | an entry with the greatest key less than or equal to key, ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
floorKey
public abstract K floorKey (K key)
Returns the greatest key less than or equal to the given key,
 or null if there is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| K | the greatest key less than or equal to key,
         ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
headMap
public abstract SortedMap<K, V> headMap (K toKey)
Returns a view of the portion of this map whose keys are
 strictly less than 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.
 
The returned map will throw an IllegalArgumentException
 on an attempt to insert a key outside its range.
 
Equivalent to headMap(toKey, false).
| Parameters | |
|---|---|
| toKey | K: high endpoint (exclusive) of the keys in the returned map | 
| Returns | |
|---|---|
| SortedMap<K, V> | a view of the portion of this map whose keys are strictly
         less than toKey | 
| Throws | |
|---|---|
| ClassCastException | |
| NullPointerException | |
| IllegalArgumentException | |
headMap
public abstract NavigableMap<K, V> headMap (K toKey, boolean inclusive)
Returns a view of the portion of this map whose keys are less than (or
 equal to, if inclusive is true) 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.
 
The returned map will throw an IllegalArgumentException
 on an attempt to insert a key outside its range.
| Parameters | |
|---|---|
| toKey | K: high endpoint of the keys in the returned map | 
| inclusive | boolean:trueif the high endpoint
        is to be included in the returned view | 
| Returns | |
|---|---|
| NavigableMap<K, V> | a view of the portion of this map whose keys are less than
         (or equal to, if inclusiveis true)toKey | 
| Throws | |
|---|---|
| ClassCastException | if toKeyis not compatible
         with this map's comparator (or, if the map has no comparator,
         iftoKeydoes not implementComparable).
         Implementations may, but are not required to, throw this
         exception iftoKeycannot be compared to keys
         currently in the map. | 
| NullPointerException | if toKeyis null
         and this map does not permit null keys | 
| IllegalArgumentException | if this map itself has a
         restricted range, and toKeylies outside the
         bounds of the range | 
higherEntry
public abstract Entry<K, V> higherEntry (K key)
Returns a key-value mapping associated with the least key
 strictly greater than the given key, or null if there
 is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| Entry<K, V> | an entry with the least key greater than key,
         ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
higherKey
public abstract K higherKey (K key)
Returns the least key strictly greater than the given key, or
 null if there is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| K | the least key greater than key,
         ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
lastEntry
public abstract Entry<K, V> lastEntry ()
Returns a key-value mapping associated with the greatest
 key in this map, or null if the map is empty.
| Returns | |
|---|---|
| Entry<K, V> | an entry with the greatest key,
         or nullif this map is empty | 
lowerEntry
public abstract Entry<K, V> lowerEntry (K key)
Returns a key-value mapping associated with the greatest key
 strictly less than the given key, or null if there is
 no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| Entry<K, V> | an entry with the greatest key less than key,
         ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
lowerKey
public abstract K lowerKey (K key)
Returns the greatest key strictly less than the given key, or
 null if there is no such key.
| Parameters | |
|---|---|
| key | K: the key | 
| Returns | |
|---|---|
| K | the greatest key less than key,
         ornullif there is no such key | 
| Throws | |
|---|---|
| ClassCastException | if the specified key cannot be compared with the keys currently in the map | 
| NullPointerException | if the specified key is null and this map does not permit null keys | 
navigableKeySet
public abstract NavigableSet<K> navigableKeySet ()
Returns a NavigableSet view of the keys contained in this map.
 The set's iterator returns the keys in ascending order.
 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 remove operation), the results of the iteration are undefined.  The
 set supports element removal, which removes the corresponding mapping
 from the map, via the Iterator.remove, Set.remove,
 removeAll, retainAll, and clear operations.
 It does not support the add or addAll operations.
| Returns | |
|---|---|
| NavigableSet<K> | a navigable set view of the keys in this map | 
pollFirstEntry
public abstract Entry<K, V> pollFirstEntry ()
Removes and returns a key-value mapping associated with
 the least key in this map, or null if the map is empty.
| Returns | |
|---|---|
| Entry<K, V> | the removed first entry of this map,
         or nullif this map is empty | 
pollLastEntry
public abstract Entry<K, V> pollLastEntry ()
Removes and returns a key-value mapping associated with
 the greatest key in this map, or null if the map is empty.
| Returns | |
|---|---|
| Entry<K, V> | the removed last entry of this map,
         or nullif this map is empty | 
reversed
public NavigableMap<K, V> reversed ()
Returns a reverse-ordered view of this map. The encounter order of mappings in the returned view is the inverse of the encounter order of mappings in this map. The reverse ordering affects all order-sensitive operations, including those on the view collections of the returned view. If the implementation permits modifications to this view, the modifications "write through" to the underlying map. Changes to the underlying map might or might not be visible in this reversed view, depending upon the implementation.
 This method is equivalent to descendingMap.
Implementation Requirements:
- The implementation in this interface returns the result of calling the
 descendingMapmethod.
| Returns | |
|---|---|
| NavigableMap<K, V> | a reverse-ordered view of this map, as a NavigableMap | 
subMap
public abstract SortedMap<K, V> subMap (K fromKey, K toKey)
Returns a view of the portion of this map whose keys range from
 fromKey, inclusive, to toKey, exclusive.  (If
 fromKey and toKey are equal, the returned map
 is empty.)  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.
 
The returned map will throw an IllegalArgumentException
 on an attempt to insert a key outside its range.
 
Equivalent to subMap(fromKey, true, toKey, false).
| Parameters | |
|---|---|
| fromKey | K: low endpoint (inclusive) of the keys in the returned map | 
| toKey | K: high endpoint (exclusive) of the keys in the returned map | 
| Returns | |
|---|---|
| SortedMap<K, V> | a view of the portion of this map whose keys range from fromKey, inclusive, totoKey, exclusive | 
| Throws | |
|---|---|
| ClassCastException | |
| NullPointerException | |
| IllegalArgumentException | |
subMap
public abstract NavigableMap<K, V> subMap (K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
Returns a view of the portion of this map whose keys range from
 fromKey to toKey.  If fromKey and
 toKey are equal, the returned map is empty unless
 fromInclusive and 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.
 
The returned map will throw an IllegalArgumentException
 on an attempt to insert a key outside of its range, or to construct a
 submap either of whose endpoints lie outside its range.
| Parameters | |
|---|---|
| fromKey | K: low endpoint of the keys in the returned map | 
| fromInclusive | boolean:trueif the low endpoint
        is to be included in the returned view | 
| toKey | K: high endpoint of the keys in the returned map | 
| toInclusive | boolean:trueif the high endpoint
        is to be included in the returned view | 
| Returns | |
|---|---|
| NavigableMap<K, V> | a view of the portion of this map whose keys range from fromKeytotoKey | 
| Throws | |
|---|---|
| ClassCastException | if fromKeyandtoKeycannot be compared to one another using this map's comparator
         (or, if the map has no comparator, using natural ordering).
         Implementations may, but are not required to, throw this
         exception iffromKeyortoKeycannot be compared to keys currently in the map. | 
| NullPointerException | if fromKeyortoKeyis null and this map does not permit null keys | 
| IllegalArgumentException | if fromKeyis greater thantoKey; or if this map itself has a restricted
         range, andfromKeyortoKeylies
         outside the bounds of the range | 
tailMap
public abstract NavigableMap<K, V> tailMap (K fromKey, boolean inclusive)
Returns a view of the portion of this map whose keys are greater than (or
 equal to, if inclusive is true) 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.
 
The returned map will throw an IllegalArgumentException
 on an attempt to insert a key outside its range.
| Parameters | |
|---|---|
| fromKey | K: low endpoint of the keys in the returned map | 
| inclusive | boolean:trueif the low endpoint
        is to be included in the returned view | 
| Returns | |
|---|---|
| NavigableMap<K, V> | a view of the portion of this map whose keys are greater than
         (or equal to, if inclusiveis true)fromKey | 
| Throws | |
|---|---|
| ClassCastException | if fromKeyis not compatible
         with this map's comparator (or, if the map has no comparator,
         iffromKeydoes not implementComparable).
         Implementations may, but are not required to, throw this
         exception iffromKeycannot be compared to keys
         currently in the map. | 
| NullPointerException | if fromKeyis null
         and this map does not permit null keys | 
| IllegalArgumentException | if this map itself has a
         restricted range, and fromKeylies outside the
         bounds of the range | 
tailMap
public abstract SortedMap<K, V> tailMap (K fromKey)
Returns a view of the portion of this map whose keys are
 greater than or equal to 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.
 
The returned map will throw an IllegalArgumentException
 on an attempt to insert a key outside its range.
 
Equivalent to tailMap(fromKey, true).
| Parameters | |
|---|---|
| fromKey | K: low endpoint (inclusive) of the keys in the returned map | 
| Returns | |
|---|---|
| SortedMap<K, V> | a view of the portion of this map whose keys are greater
         than or equal to fromKey | 
| Throws | |
|---|---|
| ClassCastException | |
| NullPointerException | |
| IllegalArgumentException | |
