|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
Interface ConcurrentNavigableMap<K,V>
Type Parameters:
K - the type of keys maintained by this map
V - the type of mapped values
All Superinterfaces:
All Known Implementing Classes:
public interface ConcurrentNavigableMap<K,V>
Since:
1.6
Author:
Doug Lea
Nested classes/interfaces inherited from interface java.util. Map |
|
Method Summary |
|
Returns a reverse order NavigableSet view of the keys contained in this map. |
|
Returns a reverse order view of the mappings contained in this map.
|
|
Returns a view of the portion of this map whose keys are
strictly less than toKey.
|
|
Returns a view of the portion of this map whose keys are less than (or
equal to, if inclusive is true) toKey.
|
|
Returns a NavigableSet view of the keys contained in this map. |
|
Returns a NavigableSet view of the keys contained in this map. |
|
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.
|
|
Returns a view of the portion of this map whose keys range from
fromKey, inclusive, to toKey, exclusive.
|
|
Returns a view of the portion of this map whose keys are
greater than or equal to fromKey.
|
|
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 |
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll |
Methods inherited from interface java.util. Map |
clear, containsKey, containsValue, copyOf, entry, entrySet, equals, get, hashCode, isEmpty, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, remove, size, values |
|
ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry |
Methods inherited from interface java.util. SortedMap |
|
|
( K fromKey, boolean fromInclusive, K toKey, boolean toInclusive) |
Returns a view of the portion of this map whose keys range from
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.
Specified by:
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 from
fromKey to toKey
Throws:
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.
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 range
|
( 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. 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:
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 - 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.
|
( 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. 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:
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 - 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.
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).
Specified by:
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 from
fromKey, inclusive, to toKey, exclusive
Throws:
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.
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 range
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:
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 - 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.
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:
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 - 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.
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:
Returns:
a reverse order view of this map
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:
Returns:
a navigable set view of the keys in this map
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:
Returns:
a navigable set view of the keys in this map
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:
Returns:
a reverse order navigable set view of the keys in this map
|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz