K
- the type of keys maintained by this mapV
- the type of mapped valuespublic 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.
Method Summary | |
---|---|
ConcurrentNavigableMap<K,V> |
headMap(K toKey)
Equivalent to navigableHeadMap(K) . |
ConcurrentNavigableMap<K,V> |
navigableHeadMap(K toKey)
Returns a view of the portion of this map whose keys are strictly less than toKey. |
ConcurrentNavigableMap<K,V> |
navigableSubMap(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> |
navigableTailMap(K fromKey)
Returns a view of the portion of this map whose keys are greater than or equal to fromKey. |
ConcurrentNavigableMap<K,V> |
subMap(K fromKey,
K toKey)
Equivalent to navigableSubMap(K, K) . |
ConcurrentNavigableMap<K,V> |
tailMap(K fromKey)
Equivalent to navigableTailMap(K) . |
Methods inherited from interface java.util.concurrent.ConcurrentMap |
---|
putIfAbsent, remove, replace, replace |
Methods inherited from interface java.util.NavigableMap |
---|
ceilingEntry, ceilingKey, descendingEntrySet, descendingKeySet, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry |
Methods inherited from interface java.util.SortedMap |
---|
comparator, entrySet, firstKey, keySet, lastKey, values |
Method Detail |
---|
ConcurrentNavigableMap<K,V> navigableSubMap(K fromKey, K toKey)
NavigableMap
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
navigableSubMap
in interface NavigableMap<K,V>
fromKey
- low endpoint (inclusive) of the keys in the returned maptoKey
- high endpoint (exclusive) of the keys in the returned map
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 keys
IllegalArgumentException
- 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> navigableHeadMap(K toKey)
NavigableMap
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
navigableHeadMap
in interface NavigableMap<K,V>
toKey
- high endpoint (exclusive) of the keys in the returned map
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 keys
IllegalArgumentException
- if this map itself has a
restricted range, and toKey lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> navigableTailMap(K fromKey)
NavigableMap
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
navigableTailMap
in interface NavigableMap<K,V>
fromKey
- low endpoint (inclusive) of the keys in the returned map
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 keys
IllegalArgumentException
- if this map itself has a
restricted range, and fromKey lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> subMap(K fromKey, K toKey)
navigableSubMap(K, K)
.
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.
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 map
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 keys
IllegalArgumentException
- 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)
navigableHeadMap(K)
.
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.
headMap
in interface SortedMap<K,V>
toKey
- high endpoint (exclusive) of the keys in the returned map
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 keys
IllegalArgumentException
- if this map itself has a
restricted range, and toKey lies outside the
bounds of the rangeConcurrentNavigableMap<K,V> tailMap(K fromKey)
navigableTailMap(K)
.
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.
tailMap
in interface SortedMap<K,V>
fromKey
- low endpoint (inclusive) of the keys in the returned map
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 keys
IllegalArgumentException
- if this map itself has a
restricted range, and fromKey lies outside the
bounds of the range