ConcurrentNavigableMap (Java Platform SE 6) (original) (raw)
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:
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
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
| Map.Entry<K,V> |
| Method Summary | |
|---|---|
| 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) Returns a view of the portion of this map whose keys are strictly less than toKey. |
| ConcurrentNavigableMap<K,V> | [headMap](../../../java/util/concurrent/ConcurrentNavigableMap.html#headMap%28K, boolean%29)(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. |
| 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](../../../java/util/concurrent/ConcurrentNavigableMap.html#subMap%28K, boolean, K, boolean%29)(K fromKey, boolean fromInclusive,K toKey, boolean toInclusive) Returns a view of the portion of this map whose keys range fromfromKey to toKey. |
| ConcurrentNavigableMap<K,V> | [subMap](../../../java/util/concurrent/ConcurrentNavigableMap.html#subMap%28K, K%29)(K fromKey,K toKey) Returns a view of the portion of this map whose keys range fromfromKey, inclusive, to toKey, exclusive. |
| ConcurrentNavigableMap<K,V> | tailMap(K fromKey) Returns a view of the portion of this map whose keys are greater than or equal to fromKey. |
| ConcurrentNavigableMap<K,V> | [tailMap](../../../java/util/concurrent/ConcurrentNavigableMap.html#tailMap%28K, boolean%29)(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. |
| Methods inherited from interface java.util.concurrent.ConcurrentMap |
|---|
| [putIfAbsent](../../../java/util/concurrent/ConcurrentMap.html#putIfAbsent%28K, V%29), [remove](../../../java/util/concurrent/ConcurrentMap.html#remove%28java.lang.Object, java.lang.Object%29), [replace](../../../java/util/concurrent/ConcurrentMap.html#replace%28K, V%29), [replace](../../../java/util/concurrent/ConcurrentMap.html#replace%28K, V, V%29) |
| Methods inherited from interface java.util.NavigableMap |
|---|
| ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry |
| Methods inherited from interface java.util.SortedMap |
|---|
| comparator, entrySet, firstKey, lastKey, values |
| Methods inherited from interface java.util.Map |
|---|
| clear, containsKey, containsValue, equals, get, hashCode, isEmpty, [put](../../../java/util/Map.html#put%28K, V%29), putAll, remove, size |
| Method Detail |
|---|
subMap
ConcurrentNavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
Description copied from interface: [NavigableMap](../../../java/util/NavigableMap.html#subMap%28K, boolean, K, boolean%29)
Returns a view of the portion of this map whose keys range fromfromKey to toKey. If fromKey andtoKey are equal, the returned map is empty unlessfromExclusive and toExclusive 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.
Specified by:
[subMap](../../../java/util/NavigableMap.html#subMap%28K, boolean, K, boolean%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Parameters:
fromKey - low endpoint of the keys in the returned map
fromInclusive - true if the low endpoint is to be included in the returned view
toKey - high endpoint of the keys in the returned map
toInclusive - true if the high endpoint is to be included in the returned view
Returns:
a view of the portion of this map whose keys range fromfromKey to toKey
Throws:
[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - if fromKey and toKey cannot 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 if fromKey or toKey cannot be compared to keys currently in the map.
[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if fromKey or toKey is null and this map does not permit null keys
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if fromKey is greater thantoKey; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range
headMap
ConcurrentNavigableMap<K,V> headMap(K toKey, boolean inclusive)
Description copied from interface: [NavigableMap](../../../java/util/NavigableMap.html#headMap%28K, boolean%29)
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.
Specified by:
[headMap](../../../java/util/NavigableMap.html#headMap%28K, boolean%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Parameters:
toKey - high endpoint of the keys in the returned map
inclusive - true if the high endpoint is to be included in the returned view
Returns:
a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey
Throws:
[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if toKey is null and this map does not permit null keys
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if this map itself has a restricted range, and toKey lies outside the bounds of the range
tailMap
ConcurrentNavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
Description copied from interface: [NavigableMap](../../../java/util/NavigableMap.html#tailMap%28K, boolean%29)
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.
Specified by:
[tailMap](../../../java/util/NavigableMap.html#tailMap%28K, boolean%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Parameters:
fromKey - low endpoint of the keys in the returned map
inclusive - true if the low endpoint is to be included in the returned view
Returns:
a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey
Throws:
[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if fromKey is null and this map does not permit null keys
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if this map itself has a restricted range, and fromKey lies outside the bounds of the range
subMap
ConcurrentNavigableMap<K,V> subMap(K fromKey, K toKey)
Description copied from interface: [NavigableMap](../../../java/util/NavigableMap.html#subMap%28K, K%29)
Returns a view of the portion of this map whose keys range fromfromKey, inclusive, to toKey, exclusive. (IffromKey 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).
Specified by:
[subMap](../../../java/util/NavigableMap.html#subMap%28K, K%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Specified by:
[subMap](../../../java/util/SortedMap.html#subMap%28K, K%29) in interface [SortedMap](../../../java/util/SortedMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Parameters:
fromKey - low endpoint (inclusive) of the keys in the returned map
toKey - high endpoint (exclusive) of the keys in the returned map
Returns:
a view of the portion of this map whose keys range fromfromKey, inclusive, to toKey, exclusive
Throws:
[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - if fromKey and toKey cannot 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 if fromKey or toKey cannot be compared to keys currently in the map.
[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if fromKey or toKey is null and this map does not permit null keys
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if fromKey is greater thantoKey; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range
headMap
ConcurrentNavigableMap<K,V> headMap(K toKey)
Description copied from interface: [NavigableMap](../../../java/util/NavigableMap.html#headMap%28K%29)
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).
Specified by:
[headMap](../../../java/util/NavigableMap.html#headMap%28K%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Specified by:
[headMap](../../../java/util/SortedMap.html#headMap%28K%29) in interface [SortedMap](../../../java/util/SortedMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Parameters:
toKey - high endpoint (exclusive) of the keys in the returned map
Returns:
a view of the portion of this map whose keys are strictly less than toKey
Throws:
[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if toKey is null and this map does not permit null keys
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if this map itself has a restricted range, and toKey lies outside the bounds of the range
tailMap
ConcurrentNavigableMap<K,V> tailMap(K fromKey)
Description copied from interface: [NavigableMap](../../../java/util/NavigableMap.html#tailMap%28K%29)
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).
Specified by:
[tailMap](../../../java/util/NavigableMap.html#tailMap%28K%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Specified by:
[tailMap](../../../java/util/SortedMap.html#tailMap%28K%29) in interface [SortedMap](../../../java/util/SortedMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Parameters:
fromKey - low endpoint (inclusive) of the keys in the returned map
Returns:
a view of the portion of this map whose keys are greater than or equal to fromKey
Throws:
[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang") - if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if fromKey is null and this map does not permit null keys
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if this map itself has a restricted range, and fromKey lies outside the bounds of the range
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 toCollections.reverseOrder(comparator()). The expression m.descendingMap().descendingMap() returns a view of m essentially equivalent to m.
Specified by:
[descendingMap](../../../java/util/NavigableMap.html#descendingMap%28%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
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 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.
Specified by:
[navigableKeySet](../../../java/util/NavigableMap.html#navigableKeySet%28%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
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 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.
Specified by:
[keySet](../../../java/util/Map.html#keySet%28%29) in interface [Map](../../../java/util/Map.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Specified by:
[keySet](../../../java/util/SortedMap.html#keySet%28%29) in interface [SortedMap](../../../java/util/SortedMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
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 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.
Specified by:
[descendingKeySet](../../../java/util/NavigableMap.html#descendingKeySet%28%29) in interface [NavigableMap](../../../java/util/NavigableMap.html "interface in java.util")<[K](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap"),[V](../../../java/util/concurrent/ConcurrentNavigableMap.html "type parameter in ConcurrentNavigableMap")>
Returns:
a reverse order navigable set view of the keys in this map
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.