public interface

ConcurrentNavigableMap

implements NavigableMap<K, V> ConcurrentMap<K, V>
java.util.concurrent.ConcurrentNavigableMap<K, V>
Known Indirect Subclasses

Class Overview

A ConcurrentMap supporting NavigableMap operations, and recursively so for its navigable sub-maps.

This interface is a member of the Java Collections Framework.

Summary

Public Methods
abstract NavigableSet<K> descendingKeySet()
Returns a reverse order NavigableSet view of the keys contained in this map.
abstract ConcurrentNavigableMap<K, V> descendingMap()
Returns a reverse order view of the mappings contained in this map.
abstract ConcurrentNavigableMap<K, V> headMap(K toKey, boolean inclusive)
Returns a view of the head of the map whose keys are smaller than (or equal to, depends on inclusive argument) endKey.
abstract ConcurrentNavigableMap<K, V> headMap(K toKey)
Returns a sorted map over a range of this sorted map with all keys that are less than the specified endKey.
abstract NavigableSet<K> keySet()
Returns a NavigableSet view of the keys contained in this map.
abstract NavigableSet<K> navigableKeySet()
Returns a NavigableSet view of the keys contained in this map.
abstract ConcurrentNavigableMap<K, V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
Returns a view of part of the map whose keys is from startKey to endKey.
abstract ConcurrentNavigableMap<K, V> subMap(K fromKey, K toKey)
Returns a sorted map over a range of this sorted map with all keys greater than or equal to the specified startKey and less than the specified endKey.
abstract ConcurrentNavigableMap<K, V> tailMap(K fromKey)
Returns a sorted map over a range of this sorted map with all keys that are greater than or equal to the specified startKey.
abstract ConcurrentNavigableMap<K, V> tailMap(K fromKey, boolean inclusive)
Returns 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.NavigableMap
From interface java.util.SortedMap
From interface java.util.concurrent.ConcurrentMap

Public Methods

public abstract NavigableSet<K> descendingKeySet ()

Since: API Level 9

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. 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.

The view's iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Returns
  • a reverse order navigable set view of the keys in this map

public abstract ConcurrentNavigableMap<K, V> descendingMap ()

Since: API Level 9

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.

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
  • a reverse order view of this map

public abstract ConcurrentNavigableMap<K, V> headMap (K toKey, boolean inclusive)

Since: API Level 9

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

Parameters
toKey the end key
inclusive true if the end key is in the returned map
Returns
  • the head-map view

public abstract ConcurrentNavigableMap<K, V> headMap (K toKey)

Since: API Level 9

Returns a sorted map over a range of this sorted map with all keys that are less than the specified endKey. Changes to the returned sorted map are reflected in this sorted map and vice versa.

Note: The returned map will not allow an insertion of a key outside the specified range.

Parameters
toKey the high boundary of the range specified.
Returns
  • a sorted map where the keys are less than endKey.

public abstract NavigableSet<K> keySet ()

Since: API Level 9

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. 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.

The view's iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

This method is equivalent to method navigableKeySet.

Returns
  • a navigable set view of the keys in this map

public abstract NavigableSet<K> navigableKeySet ()

Since: API Level 9

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. 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.

The view's iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Returns
  • a navigable set view of the keys in this map

public abstract ConcurrentNavigableMap<K, V> subMap (K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)

Since: API Level 9

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

Parameters
fromKey the start key
fromInclusive true if the start key is in the returned map
toKey the end key
toInclusive true if the end key is in the returned map
Returns
  • the sub-map view

public abstract ConcurrentNavigableMap<K, V> subMap (K fromKey, K toKey)

Since: API Level 9

Returns a sorted map over a range of this sorted map with all keys greater than or equal to the specified startKey and less than the specified endKey. Changes to the returned sorted map are reflected in this sorted map and vice versa.

Note: The returned map will not allow an insertion of a key outside the specified range.

Parameters
fromKey the low boundary of the range (inclusive).
toKey the high boundary of the range (exclusive),
Returns
  • a sorted map with the key from the specified range.

public abstract ConcurrentNavigableMap<K, V> tailMap (K fromKey)

Since: API Level 9

Returns a sorted map over a range of this sorted map with all keys that are greater than or equal to the specified startKey. Changes to the returned sorted map are reflected in this sorted map and vice versa.

Note: The returned map will not allow an insertion of a key outside the specified range.

Parameters
fromKey the low boundary of the range specified.
Returns
  • a sorted map where the keys are greater or equal to startKey.

public abstract ConcurrentNavigableMap<K, V> tailMap (K fromKey, boolean inclusive)

Since: API Level 9

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

Parameters
fromKey the start key
inclusive true if the start key is in the returned map
Returns
  • the tail-map view