is new.
public interface ConcurrentNavigableMap<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
Java Collections Framework
.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface java.util. Map |
|---|
| Map.Entry < K , V > |
| Method Summary | |
|---|---|
NavigableSet
|
descendingKeySet
()
Returns a reverse order
NavigableSet
|
| ConcurrentNavigableMap < K , V |
descendingMap
()
Returns a
reverse order
view of the
mappings contained in
map.
|
| ConcurrentNavigableMap < K , V |
headMap
Returns a view of the portion of this map whose keys
are strictly less than
.
|
| ConcurrentNavigableMap < K , V |
headMap
Returns a view of the portion of this map whose keys are
less
(or
to, if inclusive is true) toKey.
|
NavigableSet
|
keySet
()
Returns a
NavigableSet
|
NavigableSet
|
navigableKeySet
()
Returns a
NavigableSet
|
ConcurrentNavigableMap
<
K
,
V
|
subMap
(
K
fromKey, boolean fromInclusive,
K
Returns a view of the portion of this map whose keys range from fromKey to toKey.
|
ConcurrentNavigableMap
<
K
,
V
|
subMap
(
K
fromKey,
K
Returns a view of the portion of this map whose keys range from
fromKey
, inclusive, to
toKey
, exclusive.
|
ConcurrentNavigableMap
<
K
,
V
|
tailMap
(
K
Returns a view of the portion of this map whose keys are greater than or equal to
fromKey
.
|
ConcurrentNavigableMap
<
K
,
V
|
tailMap
(
K
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 , remove , replace , replace |
| Methods inherited from interface java.util. NavigableMap |
|---|
ceilingEntry
,
ceilingKey
,
|
| Methods inherited from interface java.util. SortedMap |
|---|
comparator
,
entrySet
,
firstKey
,
|
| Methods inherited from interface java.util. Map |
|---|
| clear , containsKey , containsValue , equals , get , hashCode , isEmpty , put , putAll , remove , size |
| Method Detail |
|---|
subMap
ConcurrentNavigableMap<K,V>subMap
navigableSubMap(K fromKey,boolean fromInclusive, K
toKey, boolean toInclusive)
toKey)
NavigableMap
toKey. If
empty unless fromExclusive and toExclusive are both true.
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.
subMap
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
toKey;
headMap
ConcurrentNavigableMap<K,V>headMap
navigableHeadMap(KtoKey, boolean inclusive)
toKey)
NavigableMap
(or equal to, if inclusive is true) toKey.
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
headMap
inclusive - true if the high endpoint is to be included in the returned view
(or equal to, if inclusive is true)
toKey
tailMap
ConcurrentNavigableMap<K,V>tailMap
navigableTailMap(KfromKey, boolean inclusive)
fromKey)
NavigableMap
(or
to, if inclusive is true) fromKey.
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
tailMap
inclusive - true if the low endpoint is to be included in the returned view
(or
to, if inclusive is true)
ConcurrentNavigableMap<K,V> subMap(K fromKey,
K toKey)
Description copied from interface:
NavigableMap
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).
subMap
in interface
NavigableMap
<
K
,
V
>
Specified by:
ConcurrentNavigableMap<K,V> headMap(K toKey)
Description copied from interface:
NavigableMap
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).
headMap
in interface
NavigableMap
<
K
,
V
>
Specified by:
ConcurrentNavigableMap<K,V> tailMap(K fromKey)
Description copied from interface:
NavigableMap
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).
tailMap
in interface
NavigableMap
<
K
,
V
>
Specified by:
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 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
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 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
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 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
in interface
NavigableMap
<
K
,
V
>
Returns:
a reverse order navigable set view of the keys in this map