Skip to content

Most visited

Recently visited

navigation

ConcurrentNavigableMap

public interface ConcurrentNavigableMap
implements ConcurrentMap<K, V>, NavigableMap<K, V>

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


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

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)

Returns a view of the portion of this map whose keys are strictly less than toKey.

Equivalent to headMap(toKey, false).

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

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, K toKey)

Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.

Equivalent to subMap(fromKey, true, toKey, false).

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

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

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

Returns a view of the portion of this map whose keys are greater than or equal to fromKey.

Equivalent to tailMap(fromKey, true).

Inherited methods

From interface java.util.concurrent.ConcurrentMap
From interface java.util.NavigableMap
From interface java.util.Map
From interface java.util.SortedMap

Public methods

descendingKeySet

Added in API level 9
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. 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 iterators and spliterators are weakly consistent.

Returns
NavigableSet<K> a reverse order navigable set view of the keys in this map

descendingMap

Added in API level 9
ConcurrentNavigableMap<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.

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
ConcurrentNavigableMap<K, V> a reverse order view of this map

headMap

Added in API level 9
ConcurrentNavigableMap<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
ConcurrentNavigableMap<K, V> a view of the portion of this map whose keys are strictly less than toKey
Throws
ClassCastException
NullPointerException
IllegalArgumentException

headMap

Added in API level 9
ConcurrentNavigableMap<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: true if the high endpoint is to be included in the returned view
Returns
ConcurrentNavigableMap<K, V> a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey
Throws
ClassCastException
NullPointerException
IllegalArgumentException

keySet

Added in API level 9
NavigableSet<K> keySet ()

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 iterators and spliterators are weakly consistent.

This method is equivalent to method navigableKeySet.

Returns
NavigableSet<K> a navigable set view of the keys in this map

navigableKeySet

Added in API level 9
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. 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 iterators and spliterators are weakly consistent.

Returns
NavigableSet<K> a navigable set view of the keys in this map

subMap

Added in API level 9
ConcurrentNavigableMap<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
ConcurrentNavigableMap<K, V> a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive
Throws
ClassCastException
NullPointerException
IllegalArgumentException

subMap

Added in API level 9
ConcurrentNavigableMap<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: true if the low endpoint is to be included in the returned view
toKey K: high endpoint of the keys in the returned map
toInclusive boolean: true if the high endpoint is to be included in the returned view
Returns
ConcurrentNavigableMap<K, V> a view of the portion of this map whose keys range from fromKey to toKey
Throws
ClassCastException
NullPointerException
IllegalArgumentException

tailMap

Added in API level 9
ConcurrentNavigableMap<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: true if the low endpoint is to be included in the returned view
Returns
ConcurrentNavigableMap<K, V> a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey
Throws
ClassCastException
NullPointerException
IllegalArgumentException

tailMap

Added in API level 9
ConcurrentNavigableMap<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
ConcurrentNavigableMap<K, V> a view of the portion of this map whose keys are greater than or equal to fromKey
Throws
ClassCastException
NullPointerException
IllegalArgumentException
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.