K
- the type of keys maintained by this mapV
- the type of mapped valuespublic interface ConcurrentNavigableMap<K,V> extends ConcurrentMap<K,V>, NavigableMap<K,V>
ConcurrentMap
supporting NavigableMap
operations,
and recursively so for its navigable sub-maps.
This interface is a member of the Java Collections Framework.
Modifier and Type | Method and 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)
Returns a view of the portion of this map whose keys are
strictly less than
toKey . |
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 . |
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)
Returns a view of the portion of this map whose keys range from
fromKey to toKey . |
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. |
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(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 . |
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry
ConcurrentNavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
NavigableMap
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.
subMap
in interface NavigableMap<K,V>
fromKey
- low endpoint of the keys in the returned mapfromInclusive
- true
if the low endpoint
is to be included in the returned viewtoKey
- high endpoint of the keys in the returned maptoInclusive
- true
if the high endpoint
is to be included in the returned viewfromKey
to toKey
ClassCastException
- 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
- if fromKey
or toKey
is null and this map does not permit null keysIllegalArgumentException
- if fromKey
is greater than
toKey
; or if this map itself has a restricted
range, and fromKey
or toKey
lies
outside the bounds of the rangeConcurrentNavigableMap<K,V> headMap(K toKey, boolean inclusive)
NavigableMap
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.
headMap
in interface NavigableMap<K,V>
toKey
- high endpoint of the keys in the returned mapinclusive
- true
if the high endpoint
is to be included in the returned viewinclusive
is true) toKey
ClassCastException
- 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
- if toKey
is null
and this map does not permit null keysIllegalArgumentException
- if this map itself has a
restricted range, and toKey
lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
NavigableMap
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.
tailMap
in interface NavigableMap<K,V>
fromKey
- low endpoint of the keys in the returned mapinclusive
- true
if the low endpoint
is to be included in the returned viewinclusive
is true) fromKey
ClassCastException
- 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
- if fromKey
is null
and this map does not permit null keysIllegalArgumentException
- if this map itself has a
restricted range, and fromKey
lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> subMap(K fromKey, K toKey)
NavigableMap
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>
subMap
in interface SortedMap<K,V>
fromKey
- low endpoint (inclusive) of the keys in the returned maptoKey
- high endpoint (exclusive) of the keys in the returned mapfromKey
, inclusive, to toKey
, exclusiveClassCastException
- 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
- if fromKey
or toKey
is null and this map does not permit null keysIllegalArgumentException
- if fromKey
is greater than
toKey
; or if this map itself has a restricted
range, and fromKey
or toKey
lies
outside the bounds of the rangeConcurrentNavigableMap<K,V> headMap(K toKey)
NavigableMap
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>
headMap
in interface SortedMap<K,V>
toKey
- high endpoint (exclusive) of the keys in the returned maptoKey
ClassCastException
- 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
- if toKey
is null and
this map does not permit null keysIllegalArgumentException
- if this map itself has a
restricted range, and toKey
lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> tailMap(K fromKey)
NavigableMap
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>
tailMap
in interface SortedMap<K,V>
fromKey
- low endpoint (inclusive) of the keys in the returned mapfromKey
ClassCastException
- 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
- if fromKey
is null and
this map does not permit null keysIllegalArgumentException
- if this map itself has a
restricted range, and fromKey
lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> descendingMap()
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
.
descendingMap
in interface NavigableMap<K,V>
NavigableSet<K> navigableKeySet()
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.
navigableKeySet
in interface NavigableMap<K,V>
NavigableSet<K> keySet()
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
.
NavigableSet<K> descendingKeySet()
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.
descendingKeySet
in interface NavigableMap<K,V>
Submit a bug or feature
For further API reference and developer documentation, see Java SE 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.