|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class TreeMap<K,V>
java.util.TreeMap<K,V>
Type Parameters:
K - the type of keys maintained by this map
V - the type of mapped values
All Implemented Interfaces:
public class TreeMap<K,V>
A Red-Black tree based
NavigableMap implementation.
The map is sorted according to the
natural
ordering of its keys, or by a
Comparator provided at map
creation time, depending on which constructor is used.
This implementation provides guaranteed log(n) time cost for the
containsKey, get, put and remove
operations. Algorithms are adaptations of those in Cormen, Leiserson, and
Rivest's Introduction to Algorithms.
Note that the ordering maintained by a tree map, like any sorted map, and
whether or not an explicit comparator is provided, must be consistent
with equals if this sorted map is to correctly implement the
Map interface. (See Comparable or Comparator for a
precise definition of consistent with equals.) This is so because
the Map interface is defined in terms of the equals
operation, but a sorted map performs all key comparisons using its
compareTo (or compare) method, so two keys that are deemed equal by
this method are, from the standpoint of the sorted map, equal. The behavior
of a sorted map is well-defined even if its ordering is
inconsistent with equals; it just fails to obey the general contract
of the Map interface.
Note that this implementation is not synchronized.
If multiple threads access a map concurrently, and at least one of the
threads modifies the map structurally, it must be synchronized
externally. (A structural modification is any operation that adds or
deletes one or more mappings; merely changing the value associated
with an existing key is not a structural modification.) This is
typically accomplished by synchronizing on some object that naturally
encapsulates the map.
If no such object exists, the map should be "wrapped" using the
Collections.synchronizedSortedMap
method. This is best done at creation time, to prevent accidental
unsynchronized access to the map:
SortedMap m = Collections.synchronizedSortedMap(new TreeMap(...));
The iterators returned by the iterator method of the collections
returned by all of this class's "collection view methods" are
fail-fast: if the map is structurally modified at any time after
the iterator is created, in any way except through the iterator's own
remove method, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent
modification, the iterator fails quickly and cleanly, rather than risking
arbitrary, non-deterministic behavior at an undetermined time in the future.
Note that the fail-fast behavior of an iterator cannot be guaranteed
as it is, generally speaking, impossible to make any hard guarantees in the
presence of unsynchronized concurrent modification. Fail-fast iterators
throw ConcurrentModificationException on a best-effort basis.
Therefore, it would be wrong to write a program that depended on this
exception for its correctness: the fail-fast behavior of iterators
should be used only to detect bugs.
All Map.Entry pairs returned by methods in this class
and its views represent snapshots of mappings at the time they were
produced. They do not support the Entry.setValue
method. (Note however that it is possible to change mappings in the
associated map using put.)
This class is a member of the
Java Collections Framework.
Since:
1.2
Author:
Josh Bloch and Doug Lea
See Also:
Nested classes/interfaces inherited from class java.util. AbstractMap |
|
Nested classes/interfaces inherited from interface java.util. Map |
|
Constructor Summary |
Constructs a new, empty tree map, using the natural ordering of its
keys.
|
Constructs a new, empty tree map, ordered according to the given
comparator.
|
Constructs a new tree map containing the same mappings as the given
map, ordered according to the natural ordering of its keys.
|
Constructs a new tree map containing the same mappings and
using the same ordering as the specified sorted map.
|
Method Summary |
|
Returns a key-value mapping associated with the least key
greater than or equal to the given key, or null if
there is no such key.
|
|
Returns the least key greater than or equal to the given key,
or null if there is no such key.
|
void |
Removes all of the mappings from this map.
|
|
Returns a shallow copy of this TreeMap instance.
|
|
Returns the comparator used to order the keys in this map, or
null if this map uses the natural ordering of its keys.
|
|
Attempts to compute a mapping for the specified key and its current
mapped value (or null if there is no current mapping).
|
|
If the specified key is not already associated with a value (or is mapped
to null), attempts to compute its value using the given mapping
function and enters it into this map unless null.
|
|
If the value for the specified key is present and non-null, attempts to
compute a new mapping given the key and its current mapped value.
|
boolean |
Returns true if this map contains a mapping for the specified
key.
|
boolean |
Returns true if this map maps one or more keys to the
specified value.
|
|
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 Set view of the mappings contained in this map.
|
|
Returns a key-value mapping associated with the least
key in this map, or null if the map is empty.
|
|
Returns the first (lowest) key currently in this map.
|
|
Returns a key-value mapping associated with the greatest key
less than or equal to the given key, or null if there
is no such key.
|
|
Returns the greatest key less than or equal to the given key,
or null if there is no such key.
|
void |
Performs the given action for each entry in this map until all entries
have been processed or the action throws an exception.
|
|
Returns the value to which the specified key is mapped,
or null if this map contains no mapping for the key.
|
|
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 key-value mapping associated with the least key
strictly greater than the given key, or null if there
is no such key.
|
|
Returns the least key strictly greater than the given key, or
null if there is no such key.
|
|
Returns a Set view of the keys contained in this map.
|
|
Returns a key-value mapping associated with the greatest
key in this map, or null if the map is empty.
|
|
Returns the last (highest) key currently in this map.
|
|
Returns a key-value mapping associated with the greatest key
strictly less than the given key, or null if there is
no such key.
|
|
Returns the greatest key strictly less than the given key, or
null if there is no such key.
|
|
If the specified key is not already associated with a value or is
associated with null, associates it with the given non-null value.
|
|
Returns a NavigableSet view of the keys contained in this map.
|
|
Removes and returns a key-value mapping associated with
the least key in this map, or null if the map is empty.
|
|
Removes and returns a key-value mapping associated with
the greatest key in this map, or null if the map is empty.
|
|
Associates the specified value with the specified key in this map.
|
void |
Copies all of the mappings from the specified map to this map.
|
|
If the specified key is not already associated with a value (or is mapped
to null) associates it with the given value and returns
null, else returns the current value.
|
|
Removes the mapping for this key from this TreeMap if present.
|
|
Replaces the entry for the specified key only if it is
currently mapped to some value.
|
boolean |
Replaces the entry for the specified key only if currently
mapped to the specified value.
|
void |
Replaces each entry's value with the result of invoking the given
function on that entry until all entries have been processed or the
function throws an exception.
|
int |
Returns the number of key-value mappings 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.
|
|
Returns a Collection view of the values contained in this map.
|
Methods inherited from class java.lang. Object |
|
Methods inherited from interface java.util. Map |
copyOf, entry, getOrDefault, of, of, of, of, of, of, of, of, of, of, of, ofEntries, remove |
Constructs a new, empty tree map, using the natural ordering of its
keys. All keys inserted into the map must implement the
Comparable interface. Furthermore, all such keys must be
mutually comparable:
k1.compareTo(k2) must not throw
a
ClassCastException for any keys
k1 and
k2 in the map. If the user attempts to put a key into the
map that violates this constraint (for example, the user attempts to
put a string key into a map whose keys are integers), the
put(Object key, Object value) call will throw a
ClassCastException.
Constructs a new, empty tree map, ordered according to the given
comparator. All keys inserted into the map must be
mutually
comparable by the given comparator:
comparator.compare(k1,
k2) must not throw a
ClassCastException for any keys
k1 and
k2 in the map. If the user attempts to put
a key into the map that violates this constraint, the
put(Object
key, Object value) call will throw a
ClassCastException.
Parameters:
comparator - the comparator that will be used to order this map.
If
null, the
natural
ordering of the keys will be used.
public TreeMap |
( Map<? extends K,? extends V> m) |
Constructs a new tree map containing the same mappings as the given
map, ordered according to the
natural ordering of its keys.
All keys inserted into the new map must implement the
Comparable interface. Furthermore, all such keys must be
mutually comparable:
k1.compareTo(k2) must not throw
a
ClassCastException for any keys
k1 and
k2 in the map. This method runs in n*log(n) time.
Parameters:
m - the map whose mappings are to be placed in this map
Throws:
Constructs a new tree map containing the same mappings and
using the same ordering as the specified sorted map. This
method runs in linear time.
Parameters:
m - the sorted map whose mappings are to be placed in this map,
and whose comparator is to be used to sort this map
Throws:
Returns the number of key-value mappings in this map.
Specified by:
Overrides:
Returns:
the number of key-value mappings in this map
public boolean containsKey |
|
Returns
true if this map contains a mapping for the specified
key.
Specified by:
Overrides:
Parameters:
key - key whose presence in this map is to be tested
Returns:
true if this map contains a mapping for the
specified key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
public boolean containsValue |
|
Returns
true if this map maps one or more keys to the
specified value. More formally, returns
true if and only if
this map contains at least one mapping to a value
v such
that
(value==null ? v==null : value.equals(v)). This
operation will probably require time linear in the map size for
most implementations.
Specified by:
Overrides:
Parameters:
value - value whose presence in this map is to be tested
Returns:
true if a mapping to value exists;
false otherwise
Since:
1.2
Returns the value to which the specified key is mapped,
or
null if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
k to a value v such that key compares
equal to k according to the map's ordering, then this
method returns v; otherwise it returns null.
(There can be at most one such mapping.)
A return value of null does not necessarily
indicate that the map contains no mapping for the key; it's also
possible that the map explicitly maps the key to null.
The containsKey operation may be used to
distinguish these two cases.
Specified by:
Overrides:
Parameters:
key - the key whose associated value is to be returned
Returns:
the value to which the specified key is mapped, or
null if this map contains no mapping for the key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Returns the comparator used to order the keys in this map, or
null if this map uses the
natural ordering of its keys.
Specified by:
Returns:
the comparator used to order the keys in this map,
or null if this map uses the natural ordering
of its keys
Returns the first (lowest) key currently in this map.
Specified by:
Returns:
the first (lowest) key currently in this map
Throws:
Returns the last (highest) key currently in this map.
Specified by:
Returns:
the last (highest) key currently in this map
Throws:
public void putAll |
( Map<? extends K,? extends V> map) |
Copies all of the mappings from the specified map to this map.
These mappings replace any mappings that this map had for any
of the keys currently in the specified map.
Specified by:
Overrides:
Parameters:
map - mappings to be stored in this map
Throws:
ClassCastException - if the class of a key or value in
the specified map prevents it from being stored in this map
NullPointerException - if the specified map is null or
the specified map contains a null key and this map does not
permit null keys
Associates the specified value with the specified key in this map.
If the map previously contained a mapping for the key, the old
value is replaced.
Specified by:
Overrides:
Parameters:
key - key with which the specified value is to be associated
value - value to be associated with the specified key
Returns:
the previous value associated with key, or
null if there was no mapping for key.
(A null return can also indicate that the map
previously associated null with key.)
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Description copied from interface:
Map
If the specified key is not already associated with a value (or is mapped
to null) associates it with the given value and returns
null, else returns the current value.
Specified by:
Parameters:
key - key with which the specified value is to be associated
value - value to be associated with the specified key
Returns:
the previous value associated with the specified key, or
null if there was no mapping for the key.
(A null return can also indicate that the map
previously associated null with the key,
if the implementation supports null values.)
|
( K key, Function<? super K,? extends V> mappingFunction) |
If the specified key is not already associated with a value (or is mapped
to
null), attempts to compute its value using the given mapping
function and enters it into this map unless
null.
If the mapping function returns null, no mapping is recorded.
If the mapping function itself throws an (unchecked) exception, the
exception is rethrown, and no mapping is recorded. The most
common usage is to construct a new object serving as an initial
mapped value or memoized result, as in:
map.computeIfAbsent(key, k -> new Value(f(k)));
Or to implement a multi-value map, Map<K,Collection<V>>,
supporting multiple values per key:
map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);
The mapping function should not modify this map during computation.
This method will, on a best-effort basis, throw a
ConcurrentModificationException if it is detected that the
mapping function modifies this map during computation.
Specified by:
Parameters:
key - key with which the specified value is to be associated
mappingFunction - the mapping function to compute a value
Returns:
the current (existing or computed) value associated with
the specified key, or null if the computed value is null
Throws:
public V computeIfPresent |
( K key, BiFunction<? super K,? super V,? extends V> remappingFunction) |
If the value for the specified key is present and non-null, attempts to
compute a new mapping given the key and its current mapped value.
If the remapping function returns null, the mapping is removed.
If the remapping function itself throws an (unchecked) exception, the
exception is rethrown, and the current mapping is left unchanged.
The remapping function should not modify this map during computation.
This method will, on a best-effort basis, throw a
ConcurrentModificationException if it is detected that the
remapping function modifies this map during computation.
Specified by:
Parameters:
key - key with which the specified value is to be associated
remappingFunction - the remapping function to compute a value
Returns:
the new value associated with the specified key, or null if none
Throws:
|
( K key, BiFunction<? super K,? super V,? extends V> remappingFunction) |
Attempts to compute a mapping for the specified key and its current
mapped value (or
null if there is no current mapping). For
example, to either create or append a
String msg to a value
mapping:
map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))
(Method
merge() is often simpler to use for such purposes.)
If the remapping function returns null, the mapping is removed
(or remains absent if initially absent). If the remapping function
itself throws an (unchecked) exception, the exception is rethrown, and
the current mapping is left unchanged.
The remapping function should not modify this map during computation.
This method will, on a best-effort basis, throw a
ConcurrentModificationException if it is detected that the
remapping function modifies this map during computation.
Specified by:
Parameters:
key - key with which the specified value is to be associated
remappingFunction - the remapping function to compute a value
Returns:
the new value associated with the specified key, or null if none
Throws:
|
( K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction) |
If the specified key is not already associated with a value or is
associated with null, associates it with the given non-null value.
Otherwise, replaces the associated value with the results of the given
remapping function, or removes if the result is
null. This
method may be of use when combining multiple mapped values for a key.
For example, to either create or append a
String msg to a
value mapping:
map.merge(key, msg, String::concat)
If the remapping function returns null, the mapping is removed.
If the remapping function itself throws an (unchecked) exception, the
exception is rethrown, and the current mapping is left unchanged.
The remapping function should not modify this map during computation.
This method will, on a best-effort basis, throw a
ConcurrentModificationException if it is detected that the
remapping function modifies this map during computation.
Specified by:
Parameters:
key - key with which the resulting value is to be associated
value - the non-null value to be merged with the existing value
associated with the key or, if no existing value or a null value
is associated with the key, to be associated with the key
remappingFunction - the remapping function to recompute a value if
present
Returns:
the new value associated with the specified key, or null if no
value is associated with the key
Throws:
Removes the mapping for this key from this TreeMap if present.
Specified by:
Overrides:
Parameters:
key - key for which mapping should be removed
Returns:
the previous value associated with key, or
null if there was no mapping for key.
(A null return can also indicate that the map
previously associated null with key.)
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Removes all of the mappings from this map.
The map will be empty after this call returns.
Specified by:
Overrides:
Returns a shallow copy of this
TreeMap instance. (The keys and
values themselves are not cloned.)
Overrides:
Returns:
a shallow copy of this map
See Also:
Returns a key-value mapping associated with the least
key in this map, or null if the map is empty.
Specified by:
Returns:
an entry with the least key,
or null if this map is empty
Since:
1.6
Returns a key-value mapping associated with the greatest
key in this map, or null if the map is empty.
Specified by:
Returns:
an entry with the greatest key,
or null if this map is empty
Since:
1.6
Removes and returns a key-value mapping associated with
the least key in this map, or null if the map is empty.
Specified by:
Returns:
the removed first entry of this map,
or null if this map is empty
Since:
1.6
Removes and returns a key-value mapping associated with
the greatest key in this map, or null if the map is empty.
Specified by:
Returns:
the removed last entry of this map,
or null if this map is empty
Since:
1.6
Returns a key-value mapping associated with the greatest key
strictly less than the given key, or null if there is
no such key.
Specified by:
Parameters:
key - the key
Returns:
an entry with the greatest key less than key,
or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns the greatest key strictly less than the given key, or
null if there is no such key.
Specified by:
Parameters:
key - the key
Returns:
the greatest key less than key,
or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns a key-value mapping associated with the greatest key
less than or equal to the given key, or null if there
is no such key.
Specified by:
Parameters:
key - the key
Returns:
an entry with the greatest key less than or equal to
key, or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns the greatest key less than or equal to the given key,
or null if there is no such key.
Specified by:
Parameters:
key - the key
Returns:
the greatest key less than or equal to key,
or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns a key-value mapping associated with the least key
greater than or equal to the given key, or null if
there is no such key.
Specified by:
Parameters:
key - the key
Returns:
an entry with the least key greater than or equal to
key, or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns the least key greater than or equal to the given key,
or null if there is no such key.
Specified by:
Parameters:
key - the key
Returns:
the least key greater than or equal to key,
or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns a key-value mapping associated with the least key
strictly greater than the given key, or null if there
is no such key.
Specified by:
Parameters:
key - the key
Returns:
an entry with the least key greater than key,
or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns the least key strictly greater than the given key, or
null if there is no such key.
Specified by:
Parameters:
key - the key
Returns:
the least key greater than key,
or null if there is no such key
Throws:
ClassCastException - if the specified key cannot be compared
with the keys currently in the map
NullPointerException - if the specified key is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
Returns a
Set view of the keys contained in this map.
The set's iterator returns the keys in ascending order.
The set's spliterator is
late-binding,
fail-fast, and additionally reports Spliterator.SORTED
and Spliterator.ORDERED with an encounter order that is ascending
key order. The spliterator's comparator (see
Spliterator.getComparator()) is null if
the tree map's comparator (see comparator()) is null.
Otherwise, the spliterator's comparator is the same as or imposes the
same total ordering as the tree map's comparator.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. 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.
Specified by:
Overrides:
Returns:
a set view of the keys contained 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. If the map is modified while an iteration
over the set is in progress (except through the iterator's own
remove operation), the results of the iteration are undefined. 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.
Specified by:
Returns:
a navigable set view of the keys in this map
Since:
1.6
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. If the map is modified while an iteration
over the set is in progress (except through the iterator's own
remove operation), the results of the iteration are undefined. 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.
Specified by:
Returns:
a reverse order navigable set view of the keys in this map
Since:
1.6
Returns a
Collection view of the values contained in this map.
The collection's iterator returns the values in ascending order
of the corresponding keys. The collection's spliterator is
late-binding,
fail-fast, and additionally reports Spliterator.ORDERED
with an encounter order that is ascending order of the corresponding
keys.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.
Specified by:
Overrides:
Returns:
a collection view of the values contained in this map
Returns a
Set view of the mappings contained in this map.
The set's iterator returns the entries in ascending key order. The
set's spliterator is
late-binding,
fail-fast, and additionally reports Spliterator.SORTED and
Spliterator.ORDERED with an encounter order that is ascending key
order.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation, or through the
setValue operation on a map entry returned by the
iterator) the results of the iteration are undefined. 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.
Specified by:
Overrides:
Returns:
a set view of the mappings contained in this 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. If either map is
modified while an iteration over a collection view of either map
is in progress (except through the iterator's own
remove
operation), the results of the iteration are undefined.
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
Since:
1.6
|
( 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.
NullPointerException - if
fromKey or
toKey is
null and this map uses natural ordering, or its comparator
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
Since:
1.6
|
( 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.
NullPointerException - if
toKey is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
|
( 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.
NullPointerException - if
fromKey is null
and this map uses natural ordering, or its comparator
does not permit null keys
Since:
1.6
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.
NullPointerException - if
fromKey or
toKey is
null and this map uses natural ordering, or its comparator
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
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.
NullPointerException - if
toKey is null
and this map uses natural ordering, or its comparator
does not permit null keys
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.
NullPointerException - if
fromKey is null
and this map uses natural ordering, or its comparator
does not permit null keys
public boolean replace |
( K key, V oldValue, V newValue) |
Description copied from interface:
Map
Replaces the entry for the specified key only if currently
mapped to the specified value.
Specified by:
Parameters:
key - key with which the specified value is associated
oldValue - value expected to be associated with the specified key
newValue - value to be associated with the specified key
Returns:
true if the value was replaced
Description copied from interface:
Map
Replaces the entry for the specified key only if it is
currently mapped to some value.
Specified by:
Parameters:
key - key with which the specified value is associated
value - value to be associated with the specified key
Returns:
the previous value associated with the specified key, or
null if there was no mapping for the key.
(A null return can also indicate that the map
previously associated null with the key,
if the implementation supports null values.)
Description copied from interface:
Map
Performs the given action for each entry in this map until all entries
have been processed or the action throws an exception. Unless
otherwise specified by the implementing class, actions are performed in
the order of entry set iteration (if an iteration order is specified.)
Exceptions thrown by the action are relayed to the caller.
Specified by:
Parameters:
action - The action to be performed for each entry
Description copied from interface:
Map
Replaces each entry's value with the result of invoking the given
function on that entry until all entries have been processed or the
function throws an exception. Exceptions thrown by the function are
relayed to the caller.
Specified by:
Parameters:
function - the function to apply to each entry
|
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