|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
| 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(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. |
| Methods inherited from interface java.util.concurrent.ConcurrentMap |
|---|
putIfAbsent, remove, replace, replace |
| 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, putAll, remove, size |
| Method Detail |
|---|
ConcurrentNavigableMap<K,V> subMap(K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive)
NavigableMapfromKey to toKey. If fromKey and
toKey are equal, the returned map is empty unless
fromExclusive 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.
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 view
fromKey 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 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 range
ConcurrentNavigableMap<K,V> headMap(K toKey,
boolean inclusive)
NavigableMapinclusive 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 view
inclusive 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 keys
IllegalArgumentException - if this map itself has a
restricted range, and toKey lies outside the
bounds of the range
ConcurrentNavigableMap<K,V> tailMap(K fromKey,
boolean inclusive)
NavigableMapinclusive 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 view
inclusive 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 keys
IllegalArgumentException - if this map itself has a
restricted range, and fromKey lies outside the
bounds of the range
ConcurrentNavigableMap<K,V> subMap(K fromKey,
K toKey)
NavigableMapThe 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 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)
NavigableMapThe 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 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)
NavigableMapThe 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 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> 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 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.
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 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.
keySet in interface Map<K,V>keySet in interface SortedMap<K,V>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 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.
descendingKeySet in interface NavigableMap<K,V>
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.