|
Préférences
Moteurs de recherche
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.4.2
java.util
|
Constructor Summary | |
TreeMap()
Constructs a new, empty map, sorted according to the keys' natural order. |
|
TreeMap(Comparator c)
Constructs a new, empty map, sorted according to the given comparator. |
|
TreeMap(Map m)
Constructs a new map containing the same mappings as the given map, sorted according to the keys' natural order. |
|
TreeMap(SortedMap m)
Constructs a new map containing the same mappings as the given SortedMap, sorted according to the same ordering. |
Method Summary | |
void |
clear()
Removes all mappings from this TreeMap. |
Object |
clone()
Returns a shallow copy of this TreeMap instance. |
Comparator |
comparator()
Returns the comparator used to order this map, or null if this map uses its keys' natural order. |
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. |
Set |
entrySet()
Returns a set view of the mappings contained in this map. |
Object |
firstKey()
Returns the first (lowest) key currently in this sorted map. |
Object |
get(Object key)
Returns the value to which this map maps the specified key. |
SortedMap |
headMap(Object toKey)
Returns a view of the portion of this map whose keys are strictly less than toKey. |
Set |
keySet()
Returns a Set view of the keys contained in this map. |
Object |
lastKey()
Returns the last (highest) key currently in this sorted map. |
Object |
put(Object key,
Object value)
Associates the specified value with the specified key in this map. |
void |
putAll(Map map)
Copies all of the mappings from the specified map to this map. |
Object |
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. |
SortedMap |
subMap(Object fromKey,
Object toKey)
Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. |
SortedMap |
tailMap(Object fromKey)
Returns a view of the portion of this map whose keys are greater than or equal to fromKey. |
Collection |
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
public TreeMap(Comparator c)
c
- the comparator that will be used to sort this map. A
null value indicates that the keys' natural
ordering should be used.public TreeMap(Map m)
m
- the map whose mappings are to be placed in this map.
ClassCastException
- the keys in t are not Comparable, or
are not mutually comparable.
NullPointerException
- if the specified map is null.public TreeMap(SortedMap 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 sorted map is null.Method Detail |
public int size()
size
in interface Map
size
in class AbstractMap
public boolean containsKey(Object key)
containsKey
in interface Map
containsKey
in class AbstractMap
key
- key whose presence in this map is to be tested.
ClassCastException
- if the key cannot be compared with the keys
currently in the map.
NullPointerException
- key is null and this map uses
natural ordering, or its comparator does not tolerate
null keys.public boolean containsValue(Object value)
containsValue
in interface Map
containsValue
in class AbstractMap
value
- value whose presence in this Map is to be tested.
public Object get(Object key)
get
in interface Map
get
in class AbstractMap
key
- key whose associated value is to be returned.
ClassCastException
- key cannot be compared with the keys
currently in the map.
NullPointerException
- key is null and this map uses
natural ordering, or its comparator does not tolerate
null keys.containsKey(Object)
public Comparator comparator()
comparator
in interface SortedMap
public Object firstKey()
NoSuchElementException
- Map is empty.public Object lastKey()
NoSuchElementException
- Map is empty.public void putAll(Map map)
putAll
in interface Map
putAll
in class AbstractMap
map
- mappings to be stored in this map.
ClassCastException
- class of a key or value in the specified
map prevents it from being stored in this map.
NullPointerException
- if the given map is null or
this map does not permit null keys and a
key in the specified map is null.public Object put(Object key, Object value)
put
in interface Map
put
in class AbstractMap
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.
ClassCastException
- key cannot be compared with the keys
currently in the map.
NullPointerException
- key is null and this map uses
natural order, or its comparator does not tolerate
null keys.public Object remove(Object key)
remove
in interface Map
remove
in class AbstractMap
key
- key for which mapping should be removed
ClassCastException
- key cannot be compared with the keys
currently in the map.
NullPointerException
- key is null and this map uses
natural order, or its comparator does not tolerate
null keys.public void clear()
clear
in interface Map
clear
in class AbstractMap
public Object clone()
clone
in class AbstractMap
public Set keySet()
keySet
in interface Map
keySet
in class AbstractMap
public Collection values()
values
in interface Map
values
in class AbstractMap
public Set entrySet()
entrySet
in interface Map
entrySet
in class AbstractMap
Map.Entry
public SortedMap subMap(Object fromKey, Object toKey)
The sorted map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key less than fromKey or greater than or equal to toKey.
Note: this method always returns a half-open range (which includes its low endpoint but not its high endpoint). If you need a closed range (which includes both endpoints), and the key type allows for calculation of the successor a given key, merely request the subrange from lowEndpoint to successor(highEndpoint). For example, suppose that m is a sorted map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are between low and high, inclusive:
SortedMap sub = m.submap(low, high+"\0");A similar technique can be used to generate an open range (which contains neither endpoint). The following idiom obtains a view containing all of the key-value mappings in m whose keys are between low and high, exclusive:
SortedMap sub = m.subMap(low+"\0", high);
fromKey
- low endpoint (inclusive) of the subMap.toKey
- high endpoint (exclusive) of the subMap.
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).
IllegalArgumentException
- if fromKey is greater than
toKey.
NullPointerException
- if fromKey or toKey is
null and this map uses natural order, or its
comparator does not tolerate null keys.public SortedMap headMap(Object toKey)
The sorted map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key greater than or equal to toKey.
Note: this method always returns a view that does not contain its (high) endpoint. If you need a view that does contain this endpoint, and the key type allows for calculation of the successor a given key, merely request a headMap bounded by successor(highEndpoint). For example, suppose that suppose that m is a sorted map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are less than or equal to high:
SortedMap head = m.headMap(high+"\0");
toKey
- high endpoint (exclusive) of the headMap.
ClassCastException
- if toKey is not compatible
with this map's comparator (or, if the map has no comparator,
if toKey does not implement Comparable).
IllegalArgumentException
- if this map is itself a subMap,
headMap, or tailMap, and toKey is not within the
specified range of the subMap, headMap, or tailMap.
NullPointerException
- if toKey is null and
this map uses natural order, or its comparator does not
tolerate null keys.public SortedMap tailMap(Object fromKey)
The sorted map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key less than fromKey.
Note: this method always returns a view that contains its (low) endpoint. If you need a view that does not contain this endpoint, and the element type allows for calculation of the successor a given value, merely request a tailMap bounded by successor(lowEndpoint). For For example, suppose that suppose that m is a sorted map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are strictly greater than low:
SortedMap tail = m.tailMap(low+"\0");
fromKey
- low endpoint (inclusive) of the tailMap.
ClassCastException
- if fromKey is not compatible
with this map's comparator (or, if the map has no comparator,
if fromKey does not implement Comparable).
IllegalArgumentException
- if this map is itself a subMap,
headMap, or tailMap, and fromKey is not within the
specified range of the subMap, headMap, or tailMap.
NullPointerException
- if fromKey is null and
this map uses natural order, or its comparator does not
tolerate null keys.