public interface

NavigableMap

implements SortedMap<K, V>
java.util.NavigableMap<K, V>
Known Indirect Subclasses

Class Overview

NavigableMap is a SortedMap with navigation methods answering the closest matches for specified item.

Summary

Public Methods
abstract Entry<K, V> ceilingEntry(Object key)
Answers an entry related with the smallest key greater than or equal to the specified key, or null if no such key.
abstract Object ceilingKey(Object key)
Answers the smallest key greater than or equal to the specified key, or null if no such key.
abstract NavigableSet<K> descendingKeySet()
Answers a NavigableSet view of the keys in descending order.
abstract NavigableMap<K, V> descendingMap()
Answers a reverse order view of the map.
abstract Entry<K, V> firstEntry()
Answers the entry with the smallest key, or null if the map is empty.
abstract Entry<K, V> floorEntry(Object key)
Answers an entry related with the biggest key less than or equal to the specified key, or null if no such key.
abstract Object floorKey(Object key)
Answers the biggest key less than or equal to the specified key, or null if no such key.
abstract NavigableMap<K, V> headMap(Object endKey, boolean inclusive)
Answers a view of the head of the map whose keys are smaller than (or equal to, depends on inclusive argument) endKey.
abstract Entry<K, V> higherEntry(Object key)
Answers an entry related with the smallest key greater than the specified key, or null if no such key.
abstract Object higherKey(Object key)
Answers the smallest key greater than the specified key, or null if no such key.
abstract Entry<K, V> lastEntry()
Answers the entry with the biggest key, or null if the map is empty.
abstract Entry<K, V> lowerEntry(Object key)
Answers an entry related with the biggest key less than the specified key, or null if no such key.
abstract Object lowerKey(Object key)
Answers the biggest key less than the specified key, or null if no such key.
abstract NavigableSet<K> navigableKeySet()
Answers a NavigableSet view of the keys in ascending order.
abstract Entry<K, V> pollFirstEntry()
Deletes and answers the entry with the smallest key, or null if the map is empty.
abstract Entry<K, V> pollLastEntry()
Deletes and answers the entry with the biggest key, or null if the map is empty.
abstract NavigableMap<K, V> subMap(Object startKey, boolean startInclusive, Object endKey, boolean endInclusive)
Answers a view of part of the map whose keys is from startKey to endKey.
abstract NavigableMap<K, V> tailMap(Object startKey, boolean inclusive)
Answers a view of the tail of the map whose keys are bigger than (or equal to, depends on inclusive argument) startKey.
[Expand]
Inherited Methods
From interface java.util.Map
From interface java.util.SortedMap

Public Methods

public abstract Entry<K, V> ceilingEntry (Object key)

Answers an entry related with the smallest key greater than or equal to the specified key, or null if no such key.

Parameters
key the key
Returns
  • the entry, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract Object ceilingKey (Object key)

Answers the smallest key greater than or equal to the specified key, or null if no such key.

Parameters
key the key
Returns
  • the smallest key greater than or equal to key, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract NavigableSet<K> descendingKeySet ()

Answers a NavigableSet view of the keys in descending order.

Returns
  • the navigable set view

public abstract NavigableMap<K, V> descendingMap ()

Answers a reverse order view of the map.

Returns
  • the reverse order view of the map

public abstract Entry<K, V> firstEntry ()

Answers the entry with the smallest key, or null if the map is empty.

Returns
  • the entry with the smallest key, or null if the map is empty

public abstract Entry<K, V> floorEntry (Object key)

Answers an entry related with the biggest key less than or equal to the specified key, or null if no such key.

Parameters
key the key
Returns
  • the entry, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract Object floorKey (Object key)

Answers the biggest key less than or equal to the specified key, or null if no such key.

Parameters
key the key
Returns
  • the biggest key less than or equal to key, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract NavigableMap<K, V> headMap (Object endKey, boolean inclusive)

Answers a view of the head of the map whose keys are smaller than (or equal to, depends on inclusive argument) endKey.

Parameters
endKey the end key
inclusive true if the end key is in the returned map
Returns
  • the head-map view
Throws
ClassCastException when the class of the end key is inappropriate for this SubMap
NullPointerException when the end key is null and this SortedMap does not support null keys
IllegalArgumentException when the map is range-limited and end key is out of the range of the map

public abstract Entry<K, V> higherEntry (Object key)

Answers an entry related with the smallest key greater than the specified key, or null if no such key.

Parameters
key the key
Returns
  • the entry, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract Object higherKey (Object key)

Answers the smallest key greater than the specified key, or null if no such key.

Parameters
key the key
Returns
  • the smallest key greater than key, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract Entry<K, V> lastEntry ()

Answers the entry with the biggest key, or null if the map is empty.

Returns
  • the entry with the biggest key, or null if the map is empty

public abstract Entry<K, V> lowerEntry (Object key)

Answers an entry related with the biggest key less than the specified key, or null if no such key.

Parameters
key the key
Returns
  • the entry, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract Object lowerKey (Object key)

Answers the biggest key less than the specified key, or null if no such key.

Parameters
key the key
Returns
  • the biggest key less than key, or null if no such key
Throws
ClassCastException if the key cannot be compared with the keys in the map
NullPointerException if the key is null and the map can not contain null key

public abstract NavigableSet<K> navigableKeySet ()

Answers a NavigableSet view of the keys in ascending order.

Returns
  • the navigable set view

public abstract Entry<K, V> pollFirstEntry ()

Deletes and answers the entry with the smallest key, or null if the map is empty.

Returns
  • the entry with the smallest key, or null if the map is empty

public abstract Entry<K, V> pollLastEntry ()

Deletes and answers the entry with the biggest key, or null if the map is empty.

Returns
  • the entry with the biggest key, or null if the map is empty

public abstract NavigableMap<K, V> subMap (Object startKey, boolean startInclusive, Object endKey, boolean endInclusive)

Answers a view of part of the map whose keys is from startKey to endKey.

Parameters
startKey the start key
startInclusive true if the start key is in the returned map
endKey the end key
endInclusive true if the end key is in the returned map
Returns
  • the sub-map view
Throws
ClassCastException when the class of the start or end key is inappropriate for this SubMap
NullPointerException when the start or end key is null and this SortedMap does not support null keys
IllegalArgumentException when the start key is greater than the end key

public abstract NavigableMap<K, V> tailMap (Object startKey, boolean inclusive)

Answers a view of the tail of the map whose keys are bigger than (or equal to, depends on inclusive argument) startKey.

Parameters
startKey the start key
inclusive true if the start key is in the returned map
Returns
  • the tail-map view
Throws
ClassCastException when the class of the start key is inappropriate for this SubMap
NullPointerException when the start key is null and this SortedMap does not support null keys
IllegalArgumentException when the map is range-limited and start key is out of the range of the map