Module java.base

Package java.util.concurrent

Interface ConcurrentNavigableMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Superinterfaces:

ConcurrentMap<K,V>, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>

All Known Implementing Classes:

ConcurrentSkipListMap

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

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

This interface is a member of the Java Collections Framework.

Since:

1.6

Author:

Doug Lea

Nested Class Summary

Nested classes/interfaces declared in interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
NavigableSet<K>	descendingKeySet()	Returns a reverse order NavigableSet view of the keys contained in this map.
ConcurrentNavigableMap<K,V>	descendingMap()	Returns a reverse order view of the mappings contained in this map.
ConcurrentNavigableMap<K,V>	headMap(K toKey)
ConcurrentNavigableMap<K,V>	headMap(K toKey, boolean inclusive)
NavigableSet<K>	keySet()	Returns a NavigableSet view of the keys contained in this map.
NavigableSet<K>	navigableKeySet()	Returns a NavigableSet view of the keys contained in this map.
ConcurrentNavigableMap<K,V>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
ConcurrentNavigableMap<K,V>	subMap(K fromKey, K toKey)
ConcurrentNavigableMap<K,V>	tailMap(K fromKey)
ConcurrentNavigableMap<K,V>	tailMap(K fromKey, boolean inclusive)

Methods declared in interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods declared in interface java.util.Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size

Methods declared in interface java.util.NavigableMap

ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry

Methods declared in interface java.util.SortedMap

comparator, entrySet, firstKey, lastKey, values

Method Details

subMap

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

Specified by:

subMap in interface NavigableMap<K,V>

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

headMap

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

Specified by:

headMap in interface NavigableMap<K,V>

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

tailMap

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

Specified by:

tailMap in interface NavigableMap<K,V>

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

subMap

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

Specified by:

subMap in interface NavigableMap<K,V>

Specified by:

subMap in interface SortedMap<K,V>

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

headMap

ConcurrentNavigableMap<K,V> headMap(K toKey)

Specified by:

headMap in interface NavigableMap<K,V>

Specified by:

headMap in interface SortedMap<K,V>

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

tailMap

ConcurrentNavigableMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface NavigableMap<K,V>

Specified by:

tailMap in interface SortedMap<K,V>

Throws:

ClassCastException

NullPointerException

IllegalArgumentException

descendingMap

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.

Specified by:

descendingMap in interface NavigableMap<K,V>

Returns:

a reverse order view of this map

navigableKeySet

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.

Specified by:

navigableKeySet in interface NavigableMap<K,V>

Returns:

a navigable set view of the keys in this map

keySet

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.

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

Returns:

a navigable set view of the keys in this map

descendingKeySet

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.

Specified by:

descendingKeySet in interface NavigableMap<K,V>

Returns:

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