|
Préférences
Moteurs de recherche
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.6.0
java.util
|
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V> |
Constructor Summary | |
---|---|
TreeMap()
Constructs a new, empty tree map, using the natural ordering of its keys. |
|
TreeMap(Comparator<? super K> comparator)
Constructs a new, empty tree map, ordered according to the given comparator. |
|
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. |
|
TreeMap(SortedMap<K,? extends V> m)
Constructs a new tree map containing the same mappings and using the same ordering as the specified sorted map. |
Method Summary | |
---|---|
Map.Entry<K,V> |
ceilingEntry(K key)
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. |
K |
ceilingKey(K key)
Returns the least key greater than or equal to the given key, or null if there is no such key. |
void |
clear()
Removes all of the mappings from this map. |
Object |
clone()
Returns a shallow copy of this TreeMap instance. |
Comparator<? super K> |
comparator()
Returns the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys. |
boolean |
containsKey(Object key)
Returns true if this map contains a mapping for the specified key. |
boolean |
containsValue(Object value)
Returns true if this map maps one or more keys to the specified value. |
NavigableSet<K> |
descendingKeySet()
Returns a reverse order NavigableSet view of the keys contained in this map. |
NavigableMap<K,V> |
descendingMap()
Returns a reverse order view of the mappings contained in this map. |
Set<Map.Entry<K,V>> |
entrySet()
Returns a Set view of the mappings contained in this map. |
Map.Entry<K,V> |
firstEntry()
Returns a key-value mapping associated with the least key in this map, or null if the map is empty. |
K |
firstKey()
Returns the first (lowest) key currently in this map. |
Map.Entry<K,V> |
floorEntry(K key)
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. |
K |
floorKey(K key)
Returns the greatest key less than or equal to the given key, or null if there is no such key. |
V |
get(Object key)
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. |
SortedMap<K,V> |
headMap(K toKey)
Returns a view of the portion of this map whose keys are strictly less than toKey. |
NavigableMap<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 . |
Map.Entry<K,V> |
higherEntry(K key)
Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there
is no such key. |
K |
higherKey(K key)
Returns the least key strictly greater than the given key, or null if there is no such key. |
Set<K> |
keySet()
Returns a Set view of the keys contained in this map. |
Map.Entry<K,V> |
lastEntry()
Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty. |
K |
lastKey()
Returns the last (highest) key currently in this map. |
Map.Entry<K,V> |
lowerEntry(K key)
Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is
no such key. |
K |
lowerKey(K key)
Returns the greatest key strictly less than the given key, or null if there is no such key. |
NavigableSet<K> |
navigableKeySet()
Returns a NavigableSet view of the keys contained in this map. |
Map.Entry<K,V> |
pollFirstEntry()
Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty. |
Map.Entry<K,V> |
pollLastEntry()
Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty. |
V |
put(K key,
V value)
Associates the specified value with the specified key in this map. |
void |
putAll(Map<? extends K,? extends V> map)
Copies all of the mappings from the specified map to this map. |
V |
remove(Object key)
Removes the mapping for this key from this TreeMap if present. |
int |
size()
Returns the number of key-value mappings in this map. |
NavigableMap<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 . |
SortedMap<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. |
SortedMap<K,V> |
tailMap(K fromKey)
Returns a view of the portion of this map whose keys are greater than or equal to fromKey. |
NavigableMap<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 . |
Collection<V> |
values()
Returns a Collection view of the values contained in this map. |
Methods inherited from class java.util.AbstractMap |
---|
equals, hashCode, isEmpty, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
equals, hashCode, isEmpty |
Constructor Detail |
---|
public TreeMap()
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.
public TreeMap(Comparator<? super K> comparator)
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)
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.
m
- the map whose mappings are to be placed in this map
ClassCastException
- if the keys in m are not Comparable
,
or are not mutually comparable
NullPointerException
- if the specified map is nullpublic TreeMap(SortedMap<K,? extends V> m)
m
- the sorted map whose mappings are to be placed in this map,
and whose comparator is to be used to sort this map
NullPointerException
- if the specified map is nullMethod Detail |
---|
public int size()
public boolean containsKey(Object key)
containsKey
in interface Map<K,V>
containsKey
in class AbstractMap<K,V>
key
- key whose presence in this map is to be tested
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 keyspublic boolean containsValue(Object value)
containsValue
in interface Map<K,V>
containsValue
in class AbstractMap<K,V>
value
- value whose presence in this map is to be tested
public V get(Object key)
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.
key
- the key whose associated value is to be returned
null
if this map contains no mapping for the key
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 keyspublic Comparator<? super K> comparator()
SortedMap
comparator
in interface SortedMap<K,V>
public K firstKey()
SortedMap
NoSuchElementException
- if this map is emptypublic K lastKey()
SortedMap
NoSuchElementException
- if this map is emptypublic void putAll(Map<? extends K,? extends V> map)
map
- mappings to be stored in this map
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 keyspublic V put(K key, V value)
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key
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 keyspublic V remove(Object key)
key
- key for which mapping should be removed
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 keyspublic void clear()
public Object clone()
clone
in class AbstractMap<K,V>
Cloneable
public Map.Entry<K,V> firstEntry()
NavigableMap
null
if the map is empty.
firstEntry
in interface NavigableMap<K,V>
null
if this map is emptypublic Map.Entry<K,V> lastEntry()
NavigableMap
null
if the map is empty.
lastEntry
in interface NavigableMap<K,V>
null
if this map is emptypublic Map.Entry<K,V> pollFirstEntry()
NavigableMap
null
if the map is empty.
pollFirstEntry
in interface NavigableMap<K,V>
null
if this map is emptypublic Map.Entry<K,V> pollLastEntry()
NavigableMap
null
if the map is empty.
pollLastEntry
in interface NavigableMap<K,V>
null
if this map is emptypublic Map.Entry<K,V> lowerEntry(K key)
NavigableMap
null
if there is
no such key.
lowerEntry
in interface NavigableMap<K,V>
key
- the key
key
,
or null
if there is no such key
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 keyspublic K lowerKey(K key)
NavigableMap
null
if there is no such key.
lowerKey
in interface NavigableMap<K,V>
key
- the key
key
,
or null
if there is no such key
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 keyspublic Map.Entry<K,V> floorEntry(K key)
NavigableMap
null
if there
is no such key.
floorEntry
in interface NavigableMap<K,V>
key
- the key
key
, or null
if there is no such key
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 keyspublic K floorKey(K key)
NavigableMap
null
if there is no such key.
floorKey
in interface NavigableMap<K,V>
key
- the key
key
,
or null
if there is no such key
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 keyspublic Map.Entry<K,V> ceilingEntry(K key)
NavigableMap
null
if
there is no such key.
ceilingEntry
in interface NavigableMap<K,V>
key
- the key
key
, or null
if there is no such key
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 keyspublic K ceilingKey(K key)
NavigableMap
null
if there is no such key.
ceilingKey
in interface NavigableMap<K,V>
key
- the key
key
,
or null
if there is no such key
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 keyspublic Map.Entry<K,V> higherEntry(K key)
NavigableMap
null
if there
is no such key.
higherEntry
in interface NavigableMap<K,V>
key
- the key
key
,
or null
if there is no such key
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 keyspublic K higherKey(K key)
NavigableMap
null
if there is no such key.
higherKey
in interface NavigableMap<K,V>
key
- the key
key
,
or null
if there is no such key
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 keyspublic Set<K> keySet()
Set
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.
public NavigableSet<K> navigableKeySet()
NavigableMap
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.
navigableKeySet
in interface NavigableMap<K,V>
public NavigableSet<K> descendingKeySet()
NavigableMap
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.
descendingKeySet
in interface NavigableMap<K,V>
public Collection<V> values()
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 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.
public Set<Map.Entry<K,V>> entrySet()
Set
view of the mappings contained in this map.
The set's iterator returns the entries in 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.
public NavigableMap<K,V> descendingMap()
NavigableMap
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
.
descendingMap
in interface NavigableMap<K,V>
public NavigableMap<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
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 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 rangepublic NavigableMap<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 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 uses natural ordering, or its comparator
does not permit null keys
IllegalArgumentException
- if this map itself has a
restricted range, and toKey
lies outside the
bounds of the rangepublic NavigableMap<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 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 uses natural ordering, or its comparator
does not permit null keys
IllegalArgumentException
- if this map itself has a
restricted range, and fromKey
lies outside the
bounds of the rangepublic SortedMap<K,V> subMap(K fromKey, K toKey)
NavigableMap
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
Equivalent to subMap(fromKey, true, toKey, false)
.
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 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 rangepublic SortedMap<K,V> headMap(K toKey)
NavigableMap
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
Equivalent to headMap(toKey, false)
.
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 uses natural ordering, or its comparator
does not permit null keys
IllegalArgumentException
- if this map itself has a
restricted range, and toKey lies outside the
bounds of the rangepublic SortedMap<K,V> tailMap(K fromKey)
NavigableMap
The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.
Equivalent to tailMap(fromKey, true)
.
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 uses natural ordering, or its comparator
does not permit null keys
IllegalArgumentException
- if this map itself has a
restricted range, and fromKey lies outside the
bounds of the range