| 1 |
|
/* |
| 2 |
|
* %W% %E% |
| 3 |
|
* |
| 4 |
< |
* Copyright 2004 Sun Microsystems, Inc. All rights reserved. |
| 4 |
> |
* Copyright 2005 Sun Microsystems, Inc. All rights reserved. |
| 5 |
|
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. |
| 6 |
|
*/ |
| 7 |
|
|
| 8 |
< |
package java.util; |
| 9 |
< |
|
| 8 |
> |
package java.util; |
| 9 |
> |
import java.util.*; // for javadoc (till 6280605 is fixed) |
| 10 |
|
|
| 11 |
|
/** |
| 12 |
< |
* Red-Black tree based implementation of the <tt>NavigableMap</tt> interface. |
| 13 |
< |
* This class guarantees that the map will be in ascending key order, sorted |
| 14 |
< |
* according to the <i>natural order</i> for the key's class (see |
| 15 |
< |
* <tt>Comparable</tt>), or by the comparator provided at creation time, |
| 16 |
< |
* depending on which constructor is used.<p> |
| 12 |
> |
* A Red-Black tree based {@link NavigableMap} implementation. |
| 13 |
> |
* The map is sorted according to the {@linkplain Comparable natural |
| 14 |
> |
* ordering} of its keys, or by a {@link Comparator} provided at map |
| 15 |
> |
* creation time, depending on which constructor is used. |
| 16 |
|
* |
| 17 |
< |
* This implementation provides guaranteed log(n) time cost for the |
| 17 |
> |
* <p>This implementation provides guaranteed log(n) time cost for the |
| 18 |
|
* <tt>containsKey</tt>, <tt>get</tt>, <tt>put</tt> and <tt>remove</tt> |
| 19 |
|
* operations. Algorithms are adaptations of those in Cormen, Leiserson, and |
| 20 |
< |
* Rivest's <I>Introduction to Algorithms</I>.<p> |
| 20 |
> |
* Rivest's <I>Introduction to Algorithms</I>. |
| 21 |
|
* |
| 22 |
< |
* Note that the ordering maintained by a sorted map (whether or not an |
| 22 |
> |
* <p>Note that the ordering maintained by a sorted map (whether or not an |
| 23 |
|
* explicit comparator is provided) must be <i>consistent with equals</i> if |
| 24 |
|
* this sorted map is to correctly implement the <tt>Map</tt> interface. (See |
| 25 |
|
* <tt>Comparable</tt> or <tt>Comparator</tt> for a precise definition of |
| 29 |
|
* method, so two keys that are deemed equal by this method are, from the |
| 30 |
|
* standpoint of the sorted map, equal. The behavior of a sorted map |
| 31 |
|
* <i>is</i> well-defined even if its ordering is inconsistent with equals; it |
| 32 |
< |
* just fails to obey the general contract of the <tt>Map</tt> interface.<p> |
| 32 |
> |
* just fails to obey the general contract of the <tt>Map</tt> interface. |
| 33 |
|
* |
| 34 |
< |
* <b>Note that this implementation is not synchronized.</b> If multiple |
| 34 |
> |
* <p><b>Note that this implementation is not synchronized.</b> If multiple |
| 35 |
|
* threads access a map concurrently, and at least one of the threads modifies |
| 36 |
|
* the map structurally, it <i>must</i> be synchronized externally. (A |
| 37 |
|
* structural modification is any operation that adds or deletes one or more |
| 43 |
|
* time, to prevent accidental unsynchronized access to the map: |
| 44 |
|
* <pre> |
| 45 |
|
* Map m = Collections.synchronizedMap(new TreeMap(...)); |
| 46 |
< |
* </pre><p> |
| 46 |
> |
* </pre> |
| 47 |
|
* |
| 48 |
< |
* The iterators returned by all of this class's "collection view methods" are |
| 48 |
> |
* <p>The iterators returned by the <tt>iterator</tt> method of the collections |
| 49 |
> |
* returned by all of this class's "collection view methods" are |
| 50 |
|
* <i>fail-fast</i>: if the map is structurally modified at any time after the |
| 51 |
|
* iterator is created, in any way except through the iterator's own |
| 52 |
< |
* <tt>remove</tt> or <tt>add</tt> methods, the iterator throws a |
| 53 |
< |
* <tt>ConcurrentModificationException</tt>. Thus, in the face of concurrent |
| 52 |
> |
* <tt>remove</tt> method, the iterator will throw a {@link |
| 53 |
> |
* ConcurrentModificationException}. Thus, in the face of concurrent |
| 54 |
|
* modification, the iterator fails quickly and cleanly, rather than risking |
| 55 |
< |
* arbitrary, non-deterministic behavior at an undetermined time in the |
| 56 |
< |
* future. |
| 55 |
> |
* arbitrary, non-deterministic behavior at an undetermined time in the future. |
| 56 |
|
* |
| 57 |
|
* <p>Note that the fail-fast behavior of an iterator cannot be guaranteed |
| 58 |
|
* as it is, generally speaking, impossible to make any hard guarantees in the |
| 60 |
|
* throw <tt>ConcurrentModificationException</tt> on a best-effort basis. |
| 61 |
|
* Therefore, it would be wrong to write a program that depended on this |
| 62 |
|
* exception for its correctness: <i>the fail-fast behavior of iterators |
| 63 |
< |
* should be used only to detect bugs.</i><p> |
| 63 |
> |
* should be used only to detect bugs.</i> |
| 64 |
|
* |
| 65 |
|
* <p>All <tt>Map.Entry</tt> pairs returned by methods in this class |
| 66 |
|
* and its views represent snapshots of mappings at the time they were |
| 72 |
|
* <a href="{@docRoot}/../guide/collections/index.html"> |
| 73 |
|
* Java Collections Framework</a>. |
| 74 |
|
* |
| 75 |
+ |
* @param <K> the type of keys maintained by this map |
| 76 |
+ |
* @param <V> the type of mapped values |
| 77 |
+ |
* |
| 78 |
|
* @author Josh Bloch and Doug Lea |
| 79 |
|
* @version %I%, %G% |
| 80 |
|
* @see Map |
| 92 |
|
implements NavigableMap<K,V>, Cloneable, java.io.Serializable |
| 93 |
|
{ |
| 94 |
|
/** |
| 95 |
< |
* The Comparator used to maintain order in this TreeMap, or |
| 96 |
< |
* null if this TreeMap uses its elements natural ordering. |
| 95 |
> |
* The comparator used to maintain order in this tree map, or |
| 96 |
> |
* null if it uses the natural ordering of its keys. |
| 97 |
|
* |
| 98 |
|
* @serial |
| 99 |
|
*/ |
| 115 |
|
private void decrementSize() { modCount++; size--; } |
| 116 |
|
|
| 117 |
|
/** |
| 118 |
< |
* Constructs a new, empty map, sorted according to the keys' natural |
| 119 |
< |
* order. All keys inserted into the map must implement the |
| 120 |
< |
* <tt>Comparable</tt> interface. Furthermore, all such keys must be |
| 121 |
< |
* <i>mutually comparable</i>: <tt>k1.compareTo(k2)</tt> must not throw a |
| 122 |
< |
* ClassCastException for any elements <tt>k1</tt> and <tt>k2</tt> in the |
| 123 |
< |
* map. If the user attempts to put a key into the map that violates this |
| 124 |
< |
* constraint (for example, the user attempts to put a string key into a |
| 125 |
< |
* map whose keys are integers), the <tt>put(Object key, Object |
| 126 |
< |
* value)</tt> call will throw a <tt>ClassCastException</tt>. |
| 127 |
< |
* |
| 126 |
< |
* @see Comparable |
| 118 |
> |
* Constructs a new, empty tree map, using the natural ordering of its |
| 119 |
> |
* keys. All keys inserted into the map must implement the {@link |
| 120 |
> |
* Comparable} interface. Furthermore, all such keys must be |
| 121 |
> |
* <i>mutually comparable</i>: <tt>k1.compareTo(k2)</tt> must not throw |
| 122 |
> |
* a <tt>ClassCastException</tt> for any keys <tt>k1</tt> and |
| 123 |
> |
* <tt>k2</tt> in the map. If the user attempts to put a key into the |
| 124 |
> |
* map that violates this constraint (for example, the user attempts to |
| 125 |
> |
* put a string key into a map whose keys are integers), the |
| 126 |
> |
* <tt>put(Object key, Object value)</tt> call will throw a |
| 127 |
> |
* <tt>ClassCastException</tt>. |
| 128 |
|
*/ |
| 129 |
|
public TreeMap() { |
| 130 |
|
} |
| 131 |
|
|
| 132 |
|
/** |
| 133 |
< |
* Constructs a new, empty map, sorted according to the given comparator. |
| 134 |
< |
* All keys inserted into the map must be <i>mutually comparable</i> by |
| 135 |
< |
* the given comparator: <tt>comparator.compare(k1, k2)</tt> must not |
| 136 |
< |
* throw a <tt>ClassCastException</tt> for any keys <tt>k1</tt> and |
| 137 |
< |
* <tt>k2</tt> in the map. If the user attempts to put a key into the |
| 138 |
< |
* map that violates this constraint, the <tt>put(Object key, Object |
| 139 |
< |
* value)</tt> call will throw a <tt>ClassCastException</tt>. |
| 140 |
< |
* |
| 141 |
< |
* @param c the comparator that will be used to sort this map. A |
| 142 |
< |
* <tt>null</tt> value indicates that the keys' <i>natural |
| 143 |
< |
* ordering</i> should be used. |
| 144 |
< |
*/ |
| 145 |
< |
public TreeMap(Comparator<? super K> c) { |
| 146 |
< |
this.comparator = c; |
| 133 |
> |
* Constructs a new, empty tree map, ordered according to the given |
| 134 |
> |
* comparator. All keys inserted into the map must be <i>mutually |
| 135 |
> |
* comparable</i> by the given comparator: <tt>comparator.compare(k1, |
| 136 |
> |
* k2)</tt> must not throw a <tt>ClassCastException</tt> for any keys |
| 137 |
> |
* <tt>k1</tt> and <tt>k2</tt> in the map. If the user attempts to put |
| 138 |
> |
* a key into the map that violates this constraint, the <tt>put(Object |
| 139 |
> |
* key, Object value)</tt> call will throw a |
| 140 |
> |
* <tt>ClassCastException</tt>. |
| 141 |
> |
* |
| 142 |
> |
* @param comparator the comparator that will be used to order this map. |
| 143 |
> |
* If <tt>null</tt>, the {@linkplain Comparable natural |
| 144 |
> |
* ordering} of the keys will be used. |
| 145 |
> |
*/ |
| 146 |
> |
public TreeMap(Comparator<? super K> comparator) { |
| 147 |
> |
this.comparator = comparator; |
| 148 |
|
} |
| 149 |
|
|
| 150 |
|
/** |
| 151 |
< |
* Constructs a new map containing the same mappings as the given map, |
| 152 |
< |
* sorted according to the keys' <i>natural order</i>. All keys inserted |
| 153 |
< |
* into the new map must implement the <tt>Comparable</tt> interface. |
| 154 |
< |
* Furthermore, all such keys must be <i>mutually comparable</i>: |
| 155 |
< |
* <tt>k1.compareTo(k2)</tt> must not throw a <tt>ClassCastException</tt> |
| 156 |
< |
* for any elements <tt>k1</tt> and <tt>k2</tt> in the map. This method |
| 157 |
< |
* runs in n*log(n) time. |
| 158 |
< |
* |
| 159 |
< |
* @param m the map whose mappings are to be placed in this map. |
| 160 |
< |
* @throws ClassCastException the keys in t are not Comparable, or |
| 161 |
< |
* are not mutually comparable. |
| 162 |
< |
* @throws NullPointerException if the specified map is null. |
| 151 |
> |
* Constructs a new tree map containing the same mappings as the given |
| 152 |
> |
* map, ordered according to the <i>natural ordering</i> of its keys. |
| 153 |
> |
* All keys inserted into the new map must implement the {@link |
| 154 |
> |
* Comparable} interface. Furthermore, all such keys must be |
| 155 |
> |
* <i>mutually comparable</i>: <tt>k1.compareTo(k2)</tt> must not throw |
| 156 |
> |
* a <tt>ClassCastException</tt> for any keys <tt>k1</tt> and |
| 157 |
> |
* <tt>k2</tt> in the map. This method runs in n*log(n) time. |
| 158 |
> |
* |
| 159 |
> |
* @param m the map whose mappings are to be placed in this map |
| 160 |
> |
* @throws ClassCastException if the keys in m are not {@link Comparable}, |
| 161 |
> |
* or are not mutually comparable |
| 162 |
> |
* @throws NullPointerException if the specified map is null |
| 163 |
|
*/ |
| 164 |
|
public TreeMap(Map<? extends K, ? extends V> m) { |
| 165 |
|
putAll(m); |
| 166 |
|
} |
| 167 |
|
|
| 168 |
|
/** |
| 169 |
< |
* Constructs a new map containing the same mappings as the given |
| 170 |
< |
* <tt>SortedMap</tt>, sorted according to the same ordering. This method |
| 171 |
< |
* runs in linear time. |
| 169 |
> |
* Constructs a new tree map containing the same mappings and |
| 170 |
> |
* using the same ordering as the specified sorted map. This |
| 171 |
> |
* method runs in linear time. |
| 172 |
|
* |
| 173 |
|
* @param m the sorted map whose mappings are to be placed in this map, |
| 174 |
< |
* and whose comparator is to be used to sort this map. |
| 175 |
< |
* @throws NullPointerException if the specified sorted map is null. |
| 174 |
> |
* and whose comparator is to be used to sort this map |
| 175 |
> |
* @throws NullPointerException if the specified map is null |
| 176 |
|
*/ |
| 177 |
|
public TreeMap(SortedMap<K, ? extends V> m) { |
| 178 |
|
comparator = m.comparator(); |
| 189 |
|
/** |
| 190 |
|
* Returns the number of key-value mappings in this map. |
| 191 |
|
* |
| 192 |
< |
* @return the number of key-value mappings in this map. |
| 192 |
> |
* @return the number of key-value mappings in this map |
| 193 |
|
*/ |
| 194 |
|
public int size() { |
| 195 |
|
return size; |
| 199 |
|
* Returns <tt>true</tt> if this map contains a mapping for the specified |
| 200 |
|
* key. |
| 201 |
|
* |
| 202 |
< |
* @param key key whose presence in this map is to be tested. |
| 201 |
< |
* |
| 202 |
> |
* @param key key whose presence in this map is to be tested |
| 203 |
|
* @return <tt>true</tt> if this map contains a mapping for the |
| 204 |
< |
* specified key. |
| 205 |
< |
* @throws ClassCastException if the key cannot be compared with the keys |
| 206 |
< |
* currently in the map. |
| 207 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 208 |
< |
* natural ordering, or its comparator does not tolerate |
| 209 |
< |
* <tt>null</tt> keys. |
| 204 |
> |
* specified key |
| 205 |
> |
* @throws ClassCastException if the specified key cannot be compared |
| 206 |
> |
* with the keys currently in the map |
| 207 |
> |
* @throws NullPointerException if the specified key is null |
| 208 |
> |
* and this map uses natural ordering, or its comparator |
| 209 |
> |
* does not permit null keys |
| 210 |
|
*/ |
| 211 |
|
public boolean containsKey(Object key) { |
| 212 |
|
return getEntry(key) != null; |
| 217 |
|
* specified value. More formally, returns <tt>true</tt> if and only if |
| 218 |
|
* this map contains at least one mapping to a value <tt>v</tt> such |
| 219 |
|
* that <tt>(value==null ? v==null : value.equals(v))</tt>. This |
| 220 |
< |
* operation will probably require time linear in the Map size for most |
| 221 |
< |
* implementations of Map. |
| 220 |
> |
* operation will probably require time linear in the map size for |
| 221 |
> |
* most implementations. |
| 222 |
|
* |
| 223 |
< |
* @param value value whose presence in this Map is to be tested. |
| 224 |
< |
* @return <tt>true</tt> if a mapping to <tt>value</tt> exists; |
| 225 |
< |
* <tt>false</tt> otherwise. |
| 223 |
> |
* @param value value whose presence in this map is to be tested |
| 224 |
> |
* @return <tt>true</tt> if a mapping to <tt>value</tt> exists; |
| 225 |
> |
* <tt>false</tt> otherwise |
| 226 |
|
* @since 1.2 |
| 227 |
|
*/ |
| 228 |
|
public boolean containsValue(Object value) { |
| 251 |
|
} |
| 252 |
|
|
| 253 |
|
/** |
| 254 |
< |
* Returns the value to which this map maps the specified key. Returns |
| 255 |
< |
* <tt>null</tt> if the map contains no mapping for this key. A return |
| 254 |
> |
* Returns the value to which this map maps the specified key, or |
| 255 |
> |
* <tt>null</tt> if the map contains no mapping for the key. A return |
| 256 |
|
* value of <tt>null</tt> does not <i>necessarily</i> indicate that the |
| 257 |
|
* map contains no mapping for the key; it's also possible that the map |
| 258 |
< |
* explicitly maps the key to <tt>null</tt>. The <tt>containsKey</tt> |
| 259 |
< |
* operation may be used to distinguish these two cases. |
| 258 |
> |
* explicitly maps the key to <tt>null</tt>. The {@link #containsKey |
| 259 |
> |
* containsKey} operation may be used to distinguish these two cases. |
| 260 |
|
* |
| 261 |
< |
* @param key key whose associated value is to be returned. |
| 261 |
> |
* @param key key whose associated value is to be returned |
| 262 |
|
* @return the value to which this map maps the specified key, or |
| 263 |
< |
* <tt>null</tt> if the map contains no mapping for the key. |
| 264 |
< |
* @throws ClassCastException key cannot be compared with the keys |
| 265 |
< |
* currently in the map. |
| 266 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 267 |
< |
* natural ordering, or its comparator does not tolerate |
| 268 |
< |
* <tt>null</tt> keys. |
| 268 |
< |
* |
| 269 |
< |
* @see #containsKey(Object) |
| 263 |
> |
* <tt>null</tt> if the map contains no mapping for the key |
| 264 |
> |
* @throws ClassCastException if the specified key cannot be compared |
| 265 |
> |
* with the keys currently in the map |
| 266 |
> |
* @throws NullPointerException if the specified key is null |
| 267 |
> |
* and this map uses natural ordering, or its comparator |
| 268 |
> |
* does not permit null keys |
| 269 |
|
*/ |
| 270 |
|
public V get(Object key) { |
| 271 |
|
Entry<K,V> p = getEntry(key); |
| 272 |
|
return (p==null ? null : p.value); |
| 273 |
|
} |
| 274 |
|
|
| 276 |
– |
/** |
| 277 |
– |
* Returns the comparator used to order this map, or <tt>null</tt> if this |
| 278 |
– |
* map uses its keys' natural order. |
| 279 |
– |
* |
| 280 |
– |
* @return the comparator associated with this sorted map, or |
| 281 |
– |
* <tt>null</tt> if it uses its keys' natural sort method. |
| 282 |
– |
*/ |
| 275 |
|
public Comparator<? super K> comparator() { |
| 276 |
|
return comparator; |
| 277 |
|
} |
| 278 |
|
|
| 279 |
|
/** |
| 280 |
< |
* Returns the first (lowest) key currently in this sorted map. |
| 289 |
< |
* |
| 290 |
< |
* @return the first (lowest) key currently in this sorted map. |
| 291 |
< |
* @throws NoSuchElementException Map is empty. |
| 280 |
> |
* @throws NoSuchElementException {@inheritDoc} |
| 281 |
|
*/ |
| 282 |
|
public K firstKey() { |
| 283 |
|
return key(getFirstEntry()); |
| 284 |
|
} |
| 285 |
|
|
| 286 |
|
/** |
| 287 |
< |
* Returns the last (highest) key currently in this sorted map. |
| 299 |
< |
* |
| 300 |
< |
* @return the last (highest) key currently in this sorted map. |
| 301 |
< |
* @throws NoSuchElementException Map is empty. |
| 287 |
> |
* @throws NoSuchElementException {@inheritDoc} |
| 288 |
|
*/ |
| 289 |
|
public K lastKey() { |
| 290 |
|
return key(getLastEntry()); |
| 291 |
|
} |
| 292 |
|
|
| 293 |
|
/** |
| 294 |
< |
* Copies all of the mappings from the specified map to this map. These |
| 295 |
< |
* mappings replace any mappings that this map had for any of the keys |
| 296 |
< |
* currently in the specified map. |
| 297 |
< |
* |
| 298 |
< |
* @param map mappings to be stored in this map. |
| 299 |
< |
* @throws ClassCastException class of a key or value in the specified |
| 300 |
< |
* map prevents it from being stored in this map. |
| 301 |
< |
* |
| 302 |
< |
* @throws NullPointerException if the given map is <tt>null</tt> or |
| 303 |
< |
* this map does not permit <tt>null</tt> keys and a |
| 318 |
< |
* key in the specified map is <tt>null</tt>. |
| 294 |
> |
* Copies all of the mappings from the specified map to this map. |
| 295 |
> |
* These mappings replace any mappings that this map had for any |
| 296 |
> |
* of the keys currently in the specified map. |
| 297 |
> |
* |
| 298 |
> |
* @param map mappings to be stored in this map |
| 299 |
> |
* @throws ClassCastException if the class of a key or value in |
| 300 |
> |
* the specified map prevents it from being stored in this map |
| 301 |
> |
* @throws NullPointerException if the specified map is null or |
| 302 |
> |
* the specified map contains a null key and this map does not |
| 303 |
> |
* permit null keys |
| 304 |
|
*/ |
| 305 |
|
public void putAll(Map<? extends K, ? extends V> map) { |
| 306 |
|
int mapSize = map.size(); |
| 325 |
|
* does not contain an entry for the key. |
| 326 |
|
* |
| 327 |
|
* @return this map's entry for the given key, or <tt>null</tt> if the map |
| 328 |
< |
* does not contain an entry for the key. |
| 329 |
< |
* @throws ClassCastException if the key cannot be compared with the keys |
| 330 |
< |
* currently in the map. |
| 331 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 332 |
< |
* natural order, or its comparator does not tolerate * |
| 333 |
< |
* <tt>null</tt> keys. |
| 328 |
> |
* does not contain an entry for the key |
| 329 |
> |
* @throws ClassCastException if the specified key cannot be compared |
| 330 |
> |
* with the keys currently in the map |
| 331 |
> |
* @throws NullPointerException if the specified key is null |
| 332 |
> |
* and this map uses natural ordering, or its comparator |
| 333 |
> |
* does not permit null keys |
| 334 |
|
*/ |
| 335 |
|
private Entry<K,V> getEntry(Object key) { |
| 336 |
|
// Offload comparator-based version for sake of performance |
| 337 |
|
if (comparator != null) |
| 338 |
|
return getEntryUsingComparator(key); |
| 339 |
< |
Comparable<K> k = (Comparable<K>) key; |
| 339 |
> |
Comparable<? super K> k = (Comparable<? super K>) key; |
| 340 |
|
Entry<K,V> p = root; |
| 341 |
|
while (p != null) { |
| 342 |
|
int cmp = k.compareTo(p.key); |
| 510 |
|
} |
| 511 |
|
|
| 512 |
|
/** |
| 513 |
< |
* Returns the key corresponding to the specified Entry. Throw |
| 514 |
< |
* NoSuchElementException if the Entry is <tt>null</tt>. |
| 513 |
> |
* Returns the key corresponding to the specified Entry. |
| 514 |
> |
* @throws NoSuchElementException if the Entry is null |
| 515 |
|
*/ |
| 516 |
|
private static <K> K key(Entry<K,?> e) { |
| 517 |
|
if (e==null) |
| 521 |
|
|
| 522 |
|
/** |
| 523 |
|
* Associates the specified value with the specified key in this map. |
| 524 |
< |
* If the map previously contained a mapping for this key, the old |
| 524 |
> |
* If the map previously contained a mapping for the key, the old |
| 525 |
|
* value is replaced. |
| 526 |
|
* |
| 527 |
< |
* @param key key with which the specified value is to be associated. |
| 528 |
< |
* @param value value to be associated with the specified key. |
| 527 |
> |
* @param key key with which the specified value is to be associated |
| 528 |
> |
* @param value value to be associated with the specified key |
| 529 |
|
* |
| 530 |
< |
* @return previous value associated with specified key, or <tt>null</tt> |
| 531 |
< |
* if there was no mapping for key. A <tt>null</tt> return can |
| 532 |
< |
* also indicate that the map previously associated <tt>null</tt> |
| 533 |
< |
* with the specified key. |
| 534 |
< |
* @throws ClassCastException key cannot be compared with the keys |
| 535 |
< |
* currently in the map. |
| 536 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 537 |
< |
* natural order, or its comparator does not tolerate |
| 538 |
< |
* <tt>null</tt> keys. |
| 530 |
> |
* @return the previous value associated with <tt>key</tt>, or |
| 531 |
> |
* <tt>null</tt> if there was no mapping for <tt>key</tt>. |
| 532 |
> |
* (A <tt>null</tt> return can also indicate that the map |
| 533 |
> |
* previously associated <tt>null</tt> with <tt>key</tt>.) |
| 534 |
> |
* @throws ClassCastException if the specified key cannot be compared |
| 535 |
> |
* with the keys currently in the map |
| 536 |
> |
* @throws NullPointerException if the specified key is null |
| 537 |
> |
* and this map uses natural ordering, or its comparator |
| 538 |
> |
* does not permit null keys |
| 539 |
|
*/ |
| 540 |
|
public V put(K key, V value) { |
| 541 |
|
Entry<K,V> t = root; |
| 542 |
|
|
| 543 |
|
if (t == null) { |
| 544 |
+ |
if (key == null) { |
| 545 |
+ |
if (comparator == null) |
| 546 |
+ |
throw new NullPointerException(); |
| 547 |
+ |
comparator.compare(key, key); |
| 548 |
+ |
} |
| 549 |
|
incrementSize(); |
| 550 |
|
root = new Entry<K,V>(key, value, null); |
| 551 |
|
return null; |
| 552 |
< |
} |
| 552 |
> |
} |
| 553 |
|
|
| 554 |
|
while (true) { |
| 555 |
|
int cmp = compare(key, t.key); |
| 581 |
|
* Removes the mapping for this key from this TreeMap if present. |
| 582 |
|
* |
| 583 |
|
* @param key key for which mapping should be removed |
| 584 |
< |
* @return previous value associated with specified key, or <tt>null</tt> |
| 585 |
< |
* if there was no mapping for key. A <tt>null</tt> return can |
| 586 |
< |
* also indicate that the map previously associated |
| 587 |
< |
* <tt>null</tt> with the specified key. |
| 588 |
< |
* |
| 589 |
< |
* @throws ClassCastException key cannot be compared with the keys |
| 590 |
< |
* currently in the map. |
| 591 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 592 |
< |
* natural order, or its comparator does not tolerate |
| 603 |
< |
* <tt>null</tt> keys. |
| 584 |
> |
* @return the previous value associated with <tt>key</tt>, or |
| 585 |
> |
* <tt>null</tt> if there was no mapping for <tt>key</tt>. |
| 586 |
> |
* (A <tt>null</tt> return can also indicate that the map |
| 587 |
> |
* previously associated <tt>null</tt> with <tt>key</tt>.) |
| 588 |
> |
* @throws ClassCastException if the specified key cannot be compared |
| 589 |
> |
* with the keys currently in the map |
| 590 |
> |
* @throws NullPointerException if the specified key is null |
| 591 |
> |
* and this map uses natural ordering, or its comparator |
| 592 |
> |
* does not permit null keys |
| 593 |
|
*/ |
| 594 |
|
public V remove(Object key) { |
| 595 |
|
Entry<K,V> p = getEntry(key); |
| 602 |
|
} |
| 603 |
|
|
| 604 |
|
/** |
| 605 |
< |
* Removes all mappings from this TreeMap. |
| 605 |
> |
* Removes all of the mappings from this map. |
| 606 |
> |
* The map will be empty after this call returns. |
| 607 |
|
*/ |
| 608 |
|
public void clear() { |
| 609 |
|
modCount++; |
| 615 |
|
* Returns a shallow copy of this <tt>TreeMap</tt> instance. (The keys and |
| 616 |
|
* values themselves are not cloned.) |
| 617 |
|
* |
| 618 |
< |
* @return a shallow copy of this Map. |
| 618 |
> |
* @return a shallow copy of this map |
| 619 |
|
*/ |
| 620 |
|
public Object clone() { |
| 621 |
|
TreeMap<K,V> clone = null; |
| 646 |
|
// NavigableMap API methods |
| 647 |
|
|
| 648 |
|
/** |
| 649 |
< |
* Returns a key-value mapping associated with the least |
| 660 |
< |
* key in this map, or <tt>null</tt> if the map is empty. |
| 661 |
< |
* |
| 662 |
< |
* @return an Entry with least key, or <tt>null</tt> |
| 663 |
< |
* if the map is empty. |
| 649 |
> |
* @since 1.6 |
| 650 |
|
*/ |
| 651 |
|
public Map.Entry<K,V> firstEntry() { |
| 652 |
|
Entry<K,V> e = getFirstEntry(); |
| 653 |
< |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry(e); |
| 653 |
> |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 654 |
|
} |
| 655 |
|
|
| 656 |
|
/** |
| 657 |
< |
* Returns a key-value mapping associated with the greatest |
| 672 |
< |
* key in this map, or <tt>null</tt> if the map is empty. |
| 673 |
< |
* The returned entry does <em>not</em> support |
| 674 |
< |
* the <tt>Entry.setValue</tt> method. |
| 675 |
< |
* |
| 676 |
< |
* @return an Entry with greatest key, or <tt>null</tt> |
| 677 |
< |
* if the map is empty. |
| 657 |
> |
* @since 1.6 |
| 658 |
|
*/ |
| 659 |
|
public Map.Entry<K,V> lastEntry() { |
| 660 |
|
Entry<K,V> e = getLastEntry(); |
| 661 |
< |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry(e); |
| 661 |
> |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 662 |
|
} |
| 663 |
|
|
| 664 |
|
/** |
| 665 |
< |
* Removes and returns a key-value mapping associated with |
| 686 |
< |
* the least key in this map, or <tt>null</tt> if the map is empty. |
| 687 |
< |
* |
| 688 |
< |
* @return the removed first entry of this map, or <tt>null</tt> |
| 689 |
< |
* if the map is empty. |
| 665 |
> |
* @since 1.6 |
| 666 |
|
*/ |
| 667 |
|
public Map.Entry<K,V> pollFirstEntry() { |
| 668 |
|
Entry<K,V> p = getFirstEntry(); |
| 669 |
< |
if (p == null) |
| 669 |
> |
if (p == null) |
| 670 |
|
return null; |
| 671 |
< |
Map.Entry result = new AbstractMap.SimpleImmutableEntry(p); |
| 671 |
> |
Map.Entry<K,V> result = new AbstractMap.SimpleImmutableEntry<K,V>(p); |
| 672 |
|
deleteEntry(p); |
| 673 |
|
return result; |
| 674 |
|
} |
| 675 |
|
|
| 676 |
|
/** |
| 677 |
< |
* Removes and returns a key-value mapping associated with |
| 702 |
< |
* the greatest key in this map, or <tt>null</tt> if the map is empty. |
| 703 |
< |
* |
| 704 |
< |
* @return the removed last entry of this map, or <tt>null</tt> |
| 705 |
< |
* if the map is empty. |
| 677 |
> |
* @since 1.6 |
| 678 |
|
*/ |
| 679 |
|
public Map.Entry<K,V> pollLastEntry() { |
| 680 |
|
Entry<K,V> p = getLastEntry(); |
| 681 |
< |
if (p == null) |
| 681 |
> |
if (p == null) |
| 682 |
|
return null; |
| 683 |
< |
Map.Entry result = new AbstractMap.SimpleImmutableEntry(p); |
| 683 |
> |
Map.Entry<K,V> result = new AbstractMap.SimpleImmutableEntry<K,V>(p); |
| 684 |
|
deleteEntry(p); |
| 685 |
|
return result; |
| 686 |
|
} |
| 687 |
|
|
| 688 |
|
/** |
| 689 |
< |
* Returns a key-value mapping associated with the least key |
| 690 |
< |
* greater than or equal to the given key, or <tt>null</tt> if |
| 691 |
< |
* there is no such entry. |
| 692 |
< |
* |
| 693 |
< |
* @param key the key. |
| 722 |
< |
* @return an Entry associated with ceiling of given key, or |
| 723 |
< |
* <tt>null</tt> if there is no such Entry. |
| 724 |
< |
* @throws ClassCastException if key cannot be compared with the |
| 725 |
< |
* keys currently in the map. |
| 726 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 727 |
< |
* natural order, or its comparator does not tolerate |
| 728 |
< |
* <tt>null</tt> keys. |
| 689 |
> |
* @throws ClassCastException {@inheritDoc} |
| 690 |
> |
* @throws NullPointerException if the specified key is null |
| 691 |
> |
* and this map uses natural ordering, or its comparator |
| 692 |
> |
* does not permit null keys |
| 693 |
> |
* @since 1.6 |
| 694 |
|
*/ |
| 695 |
< |
public Map.Entry<K,V> ceilingEntry(K key) { |
| 696 |
< |
Entry<K,V> e = getCeilingEntry(key); |
| 697 |
< |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry(e); |
| 695 |
> |
public Map.Entry<K,V> lowerEntry(K key) { |
| 696 |
> |
Entry<K,V> e = getLowerEntry(key); |
| 697 |
> |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 698 |
|
} |
| 699 |
|
|
| 735 |
– |
|
| 700 |
|
/** |
| 701 |
< |
* Returns least key greater than or equal to the given key, or |
| 702 |
< |
* <tt>null</tt> if there is no such key. |
| 703 |
< |
* |
| 704 |
< |
* @param key the key. |
| 705 |
< |
* @return the ceiling key, or <tt>null</tt> |
| 742 |
< |
* if there is no such key. |
| 743 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 744 |
< |
* currently in the map. |
| 745 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 746 |
< |
* natural order, or its comparator does not tolerate |
| 747 |
< |
* <tt>null</tt> keys. |
| 701 |
> |
* @throws ClassCastException {@inheritDoc} |
| 702 |
> |
* @throws NullPointerException if the specified key is null |
| 703 |
> |
* and this map uses natural ordering, or its comparator |
| 704 |
> |
* does not permit null keys |
| 705 |
> |
* @since 1.6 |
| 706 |
|
*/ |
| 707 |
< |
public K ceilingKey(K key) { |
| 708 |
< |
Entry<K,V> e = getCeilingEntry(key); |
| 707 |
> |
public K lowerKey(K key) { |
| 708 |
> |
Entry<K,V> e = getLowerEntry(key); |
| 709 |
|
return (e == null)? null : e.key; |
| 710 |
|
} |
| 711 |
|
|
| 754 |
– |
|
| 755 |
– |
|
| 712 |
|
/** |
| 713 |
< |
* Returns a key-value mapping associated with the greatest key |
| 714 |
< |
* less than or equal to the given key, or <tt>null</tt> if there |
| 715 |
< |
* is no such entry. |
| 716 |
< |
* |
| 717 |
< |
* @param key the key. |
| 762 |
< |
* @return an Entry associated with floor of given key, or <tt>null</tt> |
| 763 |
< |
* if there is no such Entry. |
| 764 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 765 |
< |
* currently in the map. |
| 766 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 767 |
< |
* natural order, or its comparator does not tolerate |
| 768 |
< |
* <tt>null</tt> keys. |
| 713 |
> |
* @throws ClassCastException {@inheritDoc} |
| 714 |
> |
* @throws NullPointerException if the specified key is null |
| 715 |
> |
* and this map uses natural ordering, or its comparator |
| 716 |
> |
* does not permit null keys |
| 717 |
> |
* @since 1.6 |
| 718 |
|
*/ |
| 719 |
|
public Map.Entry<K,V> floorEntry(K key) { |
| 720 |
|
Entry<K,V> e = getFloorEntry(key); |
| 721 |
< |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry(e); |
| 721 |
> |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 722 |
|
} |
| 723 |
|
|
| 724 |
|
/** |
| 725 |
< |
* Returns the greatest key |
| 726 |
< |
* less than or equal to the given key, or <tt>null</tt> if there |
| 727 |
< |
* is no such key. |
| 728 |
< |
* |
| 729 |
< |
* @param key the key. |
| 781 |
< |
* @return the floor of given key, or <tt>null</tt> if there is no |
| 782 |
< |
* such key. |
| 783 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 784 |
< |
* currently in the map. |
| 785 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 786 |
< |
* natural order, or its comparator does not tolerate |
| 787 |
< |
* <tt>null</tt> keys. |
| 725 |
> |
* @throws ClassCastException {@inheritDoc} |
| 726 |
> |
* @throws NullPointerException if the specified key is null |
| 727 |
> |
* and this map uses natural ordering, or its comparator |
| 728 |
> |
* does not permit null keys |
| 729 |
> |
* @since 1.6 |
| 730 |
|
*/ |
| 731 |
|
public K floorKey(K key) { |
| 732 |
|
Entry<K,V> e = getFloorEntry(key); |
| 734 |
|
} |
| 735 |
|
|
| 736 |
|
/** |
| 737 |
< |
* Returns a key-value mapping associated with the least key |
| 738 |
< |
* strictly greater than the given key, or <tt>null</tt> if there |
| 739 |
< |
* is no such entry. |
| 740 |
< |
* |
| 741 |
< |
* @param key the key. |
| 800 |
< |
* @return an Entry with least key greater than the given key, or |
| 801 |
< |
* <tt>null</tt> if there is no such Entry. |
| 802 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 803 |
< |
* currently in the map. |
| 804 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 805 |
< |
* natural order, or its comparator does not tolerate |
| 806 |
< |
* <tt>null</tt> keys. |
| 737 |
> |
* @throws ClassCastException {@inheritDoc} |
| 738 |
> |
* @throws NullPointerException if the specified key is null |
| 739 |
> |
* and this map uses natural ordering, or its comparator |
| 740 |
> |
* does not permit null keys |
| 741 |
> |
* @since 1.6 |
| 742 |
|
*/ |
| 743 |
< |
public Map.Entry<K,V> higherEntry(K key) { |
| 744 |
< |
Entry<K,V> e = getHigherEntry(key); |
| 745 |
< |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry(e); |
| 743 |
> |
public Map.Entry<K,V> ceilingEntry(K key) { |
| 744 |
> |
Entry<K,V> e = getCeilingEntry(key); |
| 745 |
> |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 746 |
|
} |
| 747 |
|
|
| 748 |
|
/** |
| 749 |
< |
* Returns the least key strictly greater than the given key, or |
| 750 |
< |
* <tt>null</tt> if there is no such key. |
| 751 |
< |
* |
| 752 |
< |
* @param key the key. |
| 753 |
< |
* @return the least key greater than the given key, or |
| 819 |
< |
* <tt>null</tt> if there is no such key. |
| 820 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 821 |
< |
* currently in the map. |
| 822 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 823 |
< |
* natural order, or its comparator does not tolerate |
| 824 |
< |
* <tt>null</tt> keys. |
| 749 |
> |
* @throws ClassCastException {@inheritDoc} |
| 750 |
> |
* @throws NullPointerException if the specified key is null |
| 751 |
> |
* and this map uses natural ordering, or its comparator |
| 752 |
> |
* does not permit null keys |
| 753 |
> |
* @since 1.6 |
| 754 |
|
*/ |
| 755 |
< |
public K higherKey(K key) { |
| 756 |
< |
Entry<K,V> e = getHigherEntry(key); |
| 755 |
> |
public K ceilingKey(K key) { |
| 756 |
> |
Entry<K,V> e = getCeilingEntry(key); |
| 757 |
|
return (e == null)? null : e.key; |
| 758 |
|
} |
| 759 |
|
|
| 760 |
|
/** |
| 761 |
< |
* Returns a key-value mapping associated with the greatest |
| 762 |
< |
* key strictly less than the given key, or <tt>null</tt> if there is no |
| 763 |
< |
* such entry. |
| 764 |
< |
* |
| 765 |
< |
* @param key the key. |
| 837 |
< |
* @return an Entry with greatest key less than the given |
| 838 |
< |
* key, or <tt>null</tt> if there is no such Entry. |
| 839 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 840 |
< |
* currently in the map. |
| 841 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 842 |
< |
* natural order, or its comparator does not tolerate |
| 843 |
< |
* <tt>null</tt> keys. |
| 761 |
> |
* @throws ClassCastException {@inheritDoc} |
| 762 |
> |
* @throws NullPointerException if the specified key is null |
| 763 |
> |
* and this map uses natural ordering, or its comparator |
| 764 |
> |
* does not permit null keys |
| 765 |
> |
* @since 1.6 |
| 766 |
|
*/ |
| 767 |
< |
public Map.Entry<K,V> lowerEntry(K key) { |
| 768 |
< |
Entry<K,V> e = getLowerEntry(key); |
| 769 |
< |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry(e); |
| 767 |
> |
public Map.Entry<K,V> higherEntry(K key) { |
| 768 |
> |
Entry<K,V> e = getHigherEntry(key); |
| 769 |
> |
return (e == null)? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 770 |
|
} |
| 771 |
|
|
| 772 |
|
/** |
| 773 |
< |
* Returns the greatest key strictly less than the given key, or |
| 774 |
< |
* <tt>null</tt> if there is no such key. |
| 775 |
< |
* |
| 776 |
< |
* @param key the key. |
| 777 |
< |
* @return the greatest key less than the given |
| 856 |
< |
* key, or <tt>null</tt> if there is no such key. |
| 857 |
< |
* @throws ClassCastException if key cannot be compared with the keys |
| 858 |
< |
* currently in the map. |
| 859 |
< |
* @throws NullPointerException key is <tt>null</tt> and this map uses |
| 860 |
< |
* natural order, or its comparator does not tolerate |
| 861 |
< |
* <tt>null</tt> keys. |
| 773 |
> |
* @throws ClassCastException {@inheritDoc} |
| 774 |
> |
* @throws NullPointerException if the specified key is null |
| 775 |
> |
* and this map uses natural ordering, or its comparator |
| 776 |
> |
* does not permit null keys |
| 777 |
> |
* @since 1.6 |
| 778 |
|
*/ |
| 779 |
< |
public K lowerKey(K key) { |
| 780 |
< |
Entry<K,V> e = getLowerEntry(key); |
| 779 |
> |
public K higherKey(K key) { |
| 780 |
> |
Entry<K,V> e = getHigherEntry(key); |
| 781 |
|
return (e == null)? null : e.key; |
| 782 |
|
} |
| 783 |
|
|
| 790 |
|
*/ |
| 791 |
|
private transient Set<Map.Entry<K,V>> entrySet = null; |
| 792 |
|
private transient Set<Map.Entry<K,V>> descendingEntrySet = null; |
| 793 |
< |
private transient Set<K> descendingKeySet = null; |
| 878 |
< |
|
| 879 |
< |
transient Set<K> keySet = null; // XXX remove when integrated |
| 880 |
< |
transient Collection<V> values = null; // XXX remove when integrated |
| 793 |
> |
private transient Set<K> descendingKeySet = null; |
| 794 |
|
|
| 795 |
|
/** |
| 796 |
< |
* Returns a Set view of the keys contained in this map. The set's |
| 797 |
< |
* iterator will return the keys in ascending order. The set is backed by |
| 798 |
< |
* this <tt>TreeMap</tt> instance, so changes to this map are reflected in |
| 799 |
< |
* the Set, and vice-versa. The Set supports element removal, which |
| 800 |
< |
* removes the corresponding mapping from the map, via the |
| 801 |
< |
* <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>, |
| 802 |
< |
* <tt>retainAll</tt>, and <tt>clear</tt> operations. It does not support |
| 803 |
< |
* the <tt>add</tt> or <tt>addAll</tt> operations. |
| 804 |
< |
* |
| 805 |
< |
* @return a set view of the keys contained in this TreeMap. |
| 796 |
> |
* Returns a {@link Set} view of the keys contained in this map. |
| 797 |
> |
* The set's iterator returns the keys in ascending order. |
| 798 |
> |
* The set is backed by the map, so changes to the map are |
| 799 |
> |
* reflected in the set, and vice-versa. If the map is modified |
| 800 |
> |
* while an iteration over the set is in progress (except through |
| 801 |
> |
* the iterator's own <tt>remove</tt> operation), the results of |
| 802 |
> |
* the iteration are undefined. The set supports element removal, |
| 803 |
> |
* which removes the corresponding mapping from the map, via the |
| 804 |
> |
* <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, |
| 805 |
> |
* <tt>removeAll</tt>, <tt>retainAll</tt>, and <tt>clear</tt> |
| 806 |
> |
* operations. It does not support the <tt>add</tt> or <tt>addAll</tt> |
| 807 |
> |
* operations. |
| 808 |
|
*/ |
| 809 |
|
public Set<K> keySet() { |
| 810 |
|
Set<K> ks = keySet; |
| 815 |
|
public Iterator<K> iterator() { |
| 816 |
|
return new KeyIterator(getFirstEntry()); |
| 817 |
|
} |
| 818 |
< |
|
| 818 |
> |
|
| 819 |
|
public int size() { |
| 820 |
|
return TreeMap.this.size(); |
| 821 |
|
} |
| 822 |
< |
|
| 822 |
> |
|
| 823 |
|
public boolean contains(Object o) { |
| 824 |
|
return containsKey(o); |
| 825 |
|
} |
| 826 |
< |
|
| 826 |
> |
|
| 827 |
|
public boolean remove(Object o) { |
| 828 |
|
int oldSize = size; |
| 829 |
|
TreeMap.this.remove(o); |
| 830 |
|
return size != oldSize; |
| 831 |
|
} |
| 832 |
< |
|
| 832 |
> |
|
| 833 |
|
public void clear() { |
| 834 |
|
TreeMap.this.clear(); |
| 835 |
|
} |
| 836 |
|
} |
| 837 |
|
|
| 838 |
|
/** |
| 839 |
< |
* Returns a collection view of the values contained in this map. The |
| 840 |
< |
* collection's iterator will return the values in the order that their |
| 841 |
< |
* corresponding keys appear in the tree. The collection is backed by |
| 842 |
< |
* this <tt>TreeMap</tt> instance, so changes to this map are reflected in |
| 843 |
< |
* the collection, and vice-versa. The collection supports element |
| 844 |
< |
* removal, which removes the corresponding mapping from the map through |
| 845 |
< |
* the <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>, |
| 846 |
< |
* <tt>removeAll</tt>, <tt>retainAll</tt>, and <tt>clear</tt> operations. |
| 847 |
< |
* It does not support the <tt>add</tt> or <tt>addAll</tt> operations. |
| 848 |
< |
* |
| 849 |
< |
* @return a collection view of the values contained in this map. |
| 839 |
> |
* Returns a {@link Collection} view of the values contained in this map. |
| 840 |
> |
* The collection's iterator returns the values in ascending order |
| 841 |
> |
* of the corresponding keys. |
| 842 |
> |
* The collection is backed by the map, so changes to the map are |
| 843 |
> |
* reflected in the collection, and vice-versa. If the map is |
| 844 |
> |
* modified while an iteration over the collection is in progress |
| 845 |
> |
* (except through the iterator's own <tt>remove</tt> operation), |
| 846 |
> |
* the results of the iteration are undefined. The collection |
| 847 |
> |
* supports element removal, which removes the corresponding |
| 848 |
> |
* mapping from the map, via the <tt>Iterator.remove</tt>, |
| 849 |
> |
* <tt>Collection.remove</tt>, <tt>removeAll</tt>, |
| 850 |
> |
* <tt>retainAll</tt> and <tt>clear</tt> operations. It does not |
| 851 |
> |
* support the <tt>add</tt> or <tt>addAll</tt> operations. |
| 852 |
|
*/ |
| 853 |
|
public Collection<V> values() { |
| 854 |
|
Collection<V> vs = values; |
| 859 |
|
public Iterator<V> iterator() { |
| 860 |
|
return new ValueIterator(getFirstEntry()); |
| 861 |
|
} |
| 862 |
< |
|
| 862 |
> |
|
| 863 |
|
public int size() { |
| 864 |
|
return TreeMap.this.size(); |
| 865 |
|
} |
| 866 |
< |
|
| 866 |
> |
|
| 867 |
|
public boolean contains(Object o) { |
| 868 |
|
for (Entry<K,V> e = getFirstEntry(); e != null; e = successor(e)) |
| 869 |
|
if (valEquals(e.getValue(), o)) |
| 870 |
|
return true; |
| 871 |
|
return false; |
| 872 |
|
} |
| 873 |
< |
|
| 873 |
> |
|
| 874 |
|
public boolean remove(Object o) { |
| 875 |
|
for (Entry<K,V> e = getFirstEntry(); e != null; e = successor(e)) { |
| 876 |
|
if (valEquals(e.getValue(), o)) { |
| 880 |
|
} |
| 881 |
|
return false; |
| 882 |
|
} |
| 883 |
< |
|
| 883 |
> |
|
| 884 |
|
public void clear() { |
| 885 |
|
TreeMap.this.clear(); |
| 886 |
|
} |
| 887 |
|
} |
| 888 |
|
|
| 889 |
|
/** |
| 890 |
< |
* Returns a set view of the mappings contained in this map. The set's |
| 891 |
< |
* iterator returns the mappings in ascending key order. Each element in |
| 892 |
< |
* the returned set is a <tt>Map.Entry</tt>. The set is backed by this |
| 893 |
< |
* map, so changes to this map are reflected in the set, and vice-versa. |
| 894 |
< |
* The set supports element removal, which removes the corresponding |
| 895 |
< |
* mapping from the TreeMap, through the <tt>Iterator.remove</tt>, |
| 890 |
> |
* Returns a {@link Set} view of the mappings contained in this map. |
| 891 |
> |
* The set's iterator returns the entries in ascending key order. |
| 892 |
> |
* The set is backed by the map, so changes to the map are |
| 893 |
> |
* reflected in the set, and vice-versa. If the map is modified |
| 894 |
> |
* while an iteration over the set is in progress (except through |
| 895 |
> |
* the iterator's own <tt>remove</tt> operation, or through the |
| 896 |
> |
* <tt>setValue</tt> operation on a map entry returned by the |
| 897 |
> |
* iterator) the results of the iteration are undefined. The set |
| 898 |
> |
* supports element removal, which removes the corresponding |
| 899 |
> |
* mapping from the map, via the <tt>Iterator.remove</tt>, |
| 900 |
|
* <tt>Set.remove</tt>, <tt>removeAll</tt>, <tt>retainAll</tt> and |
| 901 |
< |
* <tt>clear</tt> operations. It does not support the <tt>add</tt> or |
| 902 |
< |
* <tt>addAll</tt> operations. |
| 982 |
< |
* |
| 983 |
< |
* @return a set view of the mappings contained in this map. |
| 984 |
< |
* @see Map.Entry |
| 901 |
> |
* <tt>clear</tt> operations. It does not support the |
| 902 |
> |
* <tt>add</tt> or <tt>addAll</tt> operations. |
| 903 |
|
*/ |
| 904 |
|
public Set<Map.Entry<K,V>> entrySet() { |
| 905 |
|
Set<Map.Entry<K,V>> es = entrySet; |
| 910 |
|
public Iterator<Map.Entry<K,V>> iterator() { |
| 911 |
|
return new EntryIterator(getFirstEntry()); |
| 912 |
|
} |
| 913 |
< |
|
| 913 |
> |
|
| 914 |
|
public boolean contains(Object o) { |
| 915 |
|
if (!(o instanceof Map.Entry)) |
| 916 |
|
return false; |
| 919 |
|
Entry<K,V> p = getEntry(entry.getKey()); |
| 920 |
|
return p != null && valEquals(p.getValue(), value); |
| 921 |
|
} |
| 922 |
< |
|
| 922 |
> |
|
| 923 |
|
public boolean remove(Object o) { |
| 924 |
|
if (!(o instanceof Map.Entry)) |
| 925 |
|
return false; |
| 932 |
|
} |
| 933 |
|
return false; |
| 934 |
|
} |
| 935 |
< |
|
| 935 |
> |
|
| 936 |
|
public int size() { |
| 937 |
|
return TreeMap.this.size(); |
| 938 |
|
} |
| 939 |
< |
|
| 939 |
> |
|
| 940 |
|
public void clear() { |
| 941 |
|
TreeMap.this.clear(); |
| 942 |
|
} |
| 943 |
|
} |
| 944 |
|
|
| 945 |
|
/** |
| 946 |
< |
* Returns a set view of the mappings contained in this map. The |
| 1029 |
< |
* set's iterator returns the mappings in descrending key order. |
| 1030 |
< |
* Each element in the returned set is a <tt>Map.Entry</tt>. The |
| 1031 |
< |
* set is backed by this map, so changes to this map are reflected |
| 1032 |
< |
* in the set, and vice-versa. The set supports element removal, |
| 1033 |
< |
* which removes the corresponding mapping from the TreeMap, |
| 1034 |
< |
* through the <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, |
| 1035 |
< |
* <tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> |
| 1036 |
< |
* operations. It does not support the <tt>add</tt> or |
| 1037 |
< |
* <tt>addAll</tt> operations. |
| 1038 |
< |
* |
| 1039 |
< |
* @return a set view of the mappings contained in this map, in |
| 1040 |
< |
* descending key order |
| 1041 |
< |
* @see Map.Entry |
| 946 |
> |
* @since 1.6 |
| 947 |
|
*/ |
| 948 |
|
public Set<Map.Entry<K,V>> descendingEntrySet() { |
| 949 |
|
Set<Map.Entry<K,V>> es = descendingEntrySet; |
| 957 |
|
} |
| 958 |
|
|
| 959 |
|
/** |
| 960 |
< |
* Returns a Set view of the keys contained in this map. The |
| 1056 |
< |
* set's iterator will return the keys in descending order. The |
| 1057 |
< |
* map is backed by this <tt>TreeMap</tt> instance, so changes to |
| 1058 |
< |
* this map are reflected in the Set, and vice-versa. The Set |
| 1059 |
< |
* supports element removal, which removes the corresponding |
| 1060 |
< |
* mapping from the map, via the <tt>Iterator.remove</tt>, |
| 1061 |
< |
* <tt>Set.remove</tt>, <tt>removeAll</tt>, <tt>retainAll</tt>, |
| 1062 |
< |
* and <tt>clear</tt> operations. It does not support the |
| 1063 |
< |
* <tt>add</tt> or <tt>addAll</tt> operations. |
| 1064 |
< |
* |
| 1065 |
< |
* @return a set view of the keys contained in this TreeMap. |
| 960 |
> |
* @since 1.6 |
| 961 |
|
*/ |
| 962 |
|
public Set<K> descendingKeySet() { |
| 963 |
|
Set<K> ks = descendingKeySet; |
| 971 |
|
} |
| 972 |
|
|
| 973 |
|
/** |
| 974 |
< |
* Returns a view of the portion of this map whose keys range from |
| 1080 |
< |
* <tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive. (If |
| 1081 |
< |
* <tt>fromKey</tt> and <tt>toKey</tt> are equal, the returned sorted map |
| 1082 |
< |
* is empty.) The returned sorted map is backed by this map, so changes |
| 1083 |
< |
* in the returned sorted map are reflected in this map, and vice-versa. |
| 1084 |
< |
* The returned sorted map supports all optional map operations.<p> |
| 1085 |
< |
* |
| 1086 |
< |
* The sorted map returned by this method will throw an |
| 1087 |
< |
* <tt>IllegalArgumentException</tt> if the user attempts to insert a key |
| 1088 |
< |
* less than <tt>fromKey</tt> or greater than or equal to |
| 1089 |
< |
* <tt>toKey</tt>.<p> |
| 1090 |
< |
* |
| 1091 |
< |
* Note: this method always returns a <i>half-open range</i> (which |
| 1092 |
< |
* includes its low endpoint but not its high endpoint). If you need a |
| 1093 |
< |
* <i>closed range</i> (which includes both endpoints), and the key type |
| 1094 |
< |
* allows for calculation of the successor a given key, merely request the |
| 1095 |
< |
* subrange from <tt>lowEndpoint</tt> to <tt>successor(highEndpoint)</tt>. |
| 1096 |
< |
* For example, suppose that <tt>m</tt> is a sorted map whose keys are |
| 1097 |
< |
* strings. The following idiom obtains a view containing all of the |
| 1098 |
< |
* key-value mappings in <tt>m</tt> whose keys are between <tt>low</tt> |
| 1099 |
< |
* and <tt>high</tt>, inclusive: |
| 1100 |
< |
* <pre> NavigableMap sub = m.submap(low, high+"\0");</pre> |
| 1101 |
< |
* A similar technique can be used to generate an <i>open range</i> (which |
| 1102 |
< |
* contains neither endpoint). The following idiom obtains a view |
| 1103 |
< |
* containing all of the key-value mappings in <tt>m</tt> whose keys are |
| 1104 |
< |
* between <tt>low</tt> and <tt>high</tt>, exclusive: |
| 1105 |
< |
* <pre> NavigableMap sub = m.subMap(low+"\0", high);</pre> |
| 1106 |
< |
* |
| 1107 |
< |
* @param fromKey low endpoint (inclusive) of the subMap. |
| 1108 |
< |
* @param toKey high endpoint (exclusive) of the subMap. |
| 1109 |
< |
* |
| 1110 |
< |
* @return a view of the portion of this map whose keys range from |
| 1111 |
< |
* <tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive. |
| 1112 |
< |
* |
| 1113 |
< |
* @throws ClassCastException if <tt>fromKey</tt> and <tt>toKey</tt> |
| 1114 |
< |
* cannot be compared to one another using this map's comparator |
| 1115 |
< |
* (or, if the map has no comparator, using natural ordering). |
| 1116 |
< |
* @throws IllegalArgumentException if <tt>fromKey</tt> is greater than |
| 1117 |
< |
* <tt>toKey</tt>. |
| 974 |
> |
* @throws ClassCastException {@inheritDoc} |
| 975 |
|
* @throws NullPointerException if <tt>fromKey</tt> or <tt>toKey</tt> is |
| 976 |
< |
* <tt>null</tt> and this map uses natural order, or its |
| 977 |
< |
* comparator does not tolerate <tt>null</tt> keys. |
| 976 |
> |
* null and this map uses natural ordering, or its comparator |
| 977 |
> |
* does not permit null keys |
| 978 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
| 979 |
> |
* @since 1.6 |
| 980 |
|
*/ |
| 981 |
< |
public NavigableMap<K,V> subMap(K fromKey, K toKey) { |
| 981 |
> |
public NavigableMap<K,V> navigableSubMap(K fromKey, K toKey) { |
| 982 |
|
return new SubMap(fromKey, toKey); |
| 983 |
|
} |
| 984 |
|
|
| 985 |
|
/** |
| 986 |
< |
* Returns a view of the portion of this map whose keys are strictly less |
| 987 |
< |
* than <tt>toKey</tt>. The returned sorted map is backed by this map, so |
| 988 |
< |
* changes in the returned sorted map are reflected in this map, and |
| 989 |
< |
* vice-versa. The returned sorted map supports all optional map |
| 990 |
< |
* operations.<p> |
| 991 |
< |
* |
| 1133 |
< |
* The sorted map returned by this method will throw an |
| 1134 |
< |
* <tt>IllegalArgumentException</tt> if the user attempts to insert a key |
| 1135 |
< |
* greater than or equal to <tt>toKey</tt>.<p> |
| 1136 |
< |
* |
| 1137 |
< |
* Note: this method always returns a view that does not contain its |
| 1138 |
< |
* (high) endpoint. If you need a view that does contain this endpoint, |
| 1139 |
< |
* and the key type allows for calculation of the successor a given key, |
| 1140 |
< |
* merely request a headMap bounded by <tt>successor(highEndpoint)</tt>. |
| 1141 |
< |
* For example, suppose that suppose that <tt>m</tt> is a sorted map whose |
| 1142 |
< |
* keys are strings. The following idiom obtains a view containing all of |
| 1143 |
< |
* the key-value mappings in <tt>m</tt> whose keys are less than or equal |
| 1144 |
< |
* to <tt>high</tt>: |
| 1145 |
< |
* <pre> |
| 1146 |
< |
* NavigableMap head = m.headMap(high+"\0"); |
| 1147 |
< |
* </pre> |
| 1148 |
< |
* |
| 1149 |
< |
* @param toKey high endpoint (exclusive) of the headMap. |
| 1150 |
< |
* @return a view of the portion of this map whose keys are strictly |
| 1151 |
< |
* less than <tt>toKey</tt>. |
| 1152 |
< |
* |
| 1153 |
< |
* @throws ClassCastException if <tt>toKey</tt> is not compatible |
| 1154 |
< |
* with this map's comparator (or, if the map has no comparator, |
| 1155 |
< |
* if <tt>toKey</tt> does not implement <tt>Comparable</tt>). |
| 1156 |
< |
* @throws IllegalArgumentException if this map is itself a subMap, |
| 1157 |
< |
* headMap, or tailMap, and <tt>toKey</tt> is not within the |
| 1158 |
< |
* specified range of the subMap, headMap, or tailMap. |
| 1159 |
< |
* @throws NullPointerException if <tt>toKey</tt> is <tt>null</tt> and |
| 1160 |
< |
* this map uses natural order, or its comparator does not |
| 1161 |
< |
* tolerate <tt>null</tt> keys. |
| 986 |
> |
* @throws ClassCastException {@inheritDoc} |
| 987 |
> |
* @throws NullPointerException if <tt>toKey</tt> is null |
| 988 |
> |
* and this map uses natural ordering, or its comparator |
| 989 |
> |
* does not permit null keys |
| 990 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
| 991 |
> |
* @since 1.6 |
| 992 |
|
*/ |
| 993 |
< |
public NavigableMap<K,V> headMap(K toKey) { |
| 993 |
> |
public NavigableMap<K,V> navigableHeadMap(K toKey) { |
| 994 |
|
return new SubMap(toKey, true); |
| 995 |
|
} |
| 996 |
|
|
| 997 |
|
/** |
| 998 |
< |
* Returns a view of the portion of this map whose keys are greater than |
| 999 |
< |
* or equal to <tt>fromKey</tt>. The returned sorted map is backed by |
| 1000 |
< |
* this map, so changes in the returned sorted map are reflected in this |
| 1001 |
< |
* map, and vice-versa. The returned sorted map supports all optional map |
| 1002 |
< |
* operations.<p> |
| 1003 |
< |
* |
| 1174 |
< |
* The sorted map returned by this method will throw an |
| 1175 |
< |
* <tt>IllegalArgumentException</tt> if the user attempts to insert a key |
| 1176 |
< |
* less than <tt>fromKey</tt>.<p> |
| 1177 |
< |
* |
| 1178 |
< |
* Note: this method always returns a view that contains its (low) |
| 1179 |
< |
* endpoint. If you need a view that does not contain this endpoint, and |
| 1180 |
< |
* the element type allows for calculation of the successor a given value, |
| 1181 |
< |
* merely request a tailMap bounded by <tt>successor(lowEndpoint)</tt>. |
| 1182 |
< |
* For example, suppose that <tt>m</tt> is a sorted map whose keys |
| 1183 |
< |
* are strings. The following idiom obtains a view containing |
| 1184 |
< |
* all of the key-value mappings in <tt>m</tt> whose keys are strictly |
| 1185 |
< |
* greater than <tt>low</tt>: <pre> |
| 1186 |
< |
* NavigableMap tail = m.tailMap(low+"\0"); |
| 1187 |
< |
* </pre> |
| 1188 |
< |
* |
| 1189 |
< |
* @param fromKey low endpoint (inclusive) of the tailMap. |
| 1190 |
< |
* @return a view of the portion of this map whose keys are greater |
| 1191 |
< |
* than or equal to <tt>fromKey</tt>. |
| 1192 |
< |
* @throws ClassCastException if <tt>fromKey</tt> is not compatible |
| 1193 |
< |
* with this map's comparator (or, if the map has no comparator, |
| 1194 |
< |
* if <tt>fromKey</tt> does not implement <tt>Comparable</tt>). |
| 1195 |
< |
* @throws IllegalArgumentException if this map is itself a subMap, |
| 1196 |
< |
* headMap, or tailMap, and <tt>fromKey</tt> is not within the |
| 1197 |
< |
* specified range of the subMap, headMap, or tailMap. |
| 1198 |
< |
* @throws NullPointerException if <tt>fromKey</tt> is <tt>null</tt> and |
| 1199 |
< |
* this map uses natural order, or its comparator does not |
| 1200 |
< |
* tolerate <tt>null</tt> keys. |
| 998 |
> |
* @throws ClassCastException {@inheritDoc} |
| 999 |
> |
* @throws NullPointerException if <tt>fromKey</tt> is null |
| 1000 |
> |
* and this map uses natural ordering, or its comparator |
| 1001 |
> |
* does not permit null keys |
| 1002 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
| 1003 |
> |
* @since 1.6 |
| 1004 |
|
*/ |
| 1005 |
< |
public NavigableMap<K,V> tailMap(K fromKey) { |
| 1005 |
> |
public NavigableMap<K,V> navigableTailMap(K fromKey) { |
| 1006 |
> |
return new SubMap(fromKey, false); |
| 1007 |
> |
} |
| 1008 |
> |
|
| 1009 |
> |
/** |
| 1010 |
> |
* Equivalent to {@link #navigableSubMap} but with a return type |
| 1011 |
> |
* conforming to the <tt>SortedMap</tt> interface. |
| 1012 |
> |
* |
| 1013 |
> |
* <p>{@inheritDoc} |
| 1014 |
> |
* |
| 1015 |
> |
* @throws ClassCastException {@inheritDoc} |
| 1016 |
> |
* @throws NullPointerException if <tt>fromKey</tt> or <tt>toKey</tt> is |
| 1017 |
> |
* null and this map uses natural ordering, or its comparator |
| 1018 |
> |
* does not permit null keys |
| 1019 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
| 1020 |
> |
*/ |
| 1021 |
> |
public SortedMap<K,V> subMap(K fromKey, K toKey) { |
| 1022 |
> |
return new SubMap(fromKey, toKey); |
| 1023 |
> |
} |
| 1024 |
> |
|
| 1025 |
> |
/** |
| 1026 |
> |
* Equivalent to {@link #navigableHeadMap} but with a return type |
| 1027 |
> |
* conforming to the <tt>SortedMap</tt> interface. |
| 1028 |
> |
* |
| 1029 |
> |
* <p>{@inheritDoc} |
| 1030 |
> |
* |
| 1031 |
> |
* @throws ClassCastException {@inheritDoc} |
| 1032 |
> |
* @throws NullPointerException if <tt>toKey</tt> is null |
| 1033 |
> |
* and this map uses natural ordering, or its comparator |
| 1034 |
> |
* does not permit null keys |
| 1035 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
| 1036 |
> |
*/ |
| 1037 |
> |
public SortedMap<K,V> headMap(K toKey) { |
| 1038 |
> |
return new SubMap(toKey, true); |
| 1039 |
> |
} |
| 1040 |
> |
|
| 1041 |
> |
/** |
| 1042 |
> |
* Equivalent to {@link #navigableTailMap} but with a return type |
| 1043 |
> |
* conforming to the <tt>SortedMap</tt> interface. |
| 1044 |
> |
* |
| 1045 |
> |
* <p>{@inheritDoc} |
| 1046 |
> |
* |
| 1047 |
> |
* @throws ClassCastException {@inheritDoc} |
| 1048 |
> |
* @throws NullPointerException if <tt>fromKey</tt> is null |
| 1049 |
> |
* and this map uses natural ordering, or its comparator |
| 1050 |
> |
* does not permit null keys |
| 1051 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
| 1052 |
> |
*/ |
| 1053 |
> |
public SortedMap<K,V> tailMap(K fromKey) { |
| 1054 |
|
return new SubMap(fromKey, false); |
| 1055 |
|
} |
| 1056 |
|
|
| 1093 |
|
} |
| 1094 |
|
|
| 1095 |
|
public boolean isEmpty() { |
| 1096 |
< |
return entrySet.isEmpty(); |
| 1096 |
> |
return entrySet().isEmpty(); |
| 1097 |
|
} |
| 1098 |
|
|
| 1099 |
|
public boolean containsKey(Object key) { |
| 1100 |
< |
return inRange((K) key) && TreeMap.this.containsKey(key); |
| 1100 |
> |
return inRange(key) && TreeMap.this.containsKey(key); |
| 1101 |
|
} |
| 1102 |
|
|
| 1103 |
|
public V get(Object key) { |
| 1104 |
< |
if (!inRange((K) key)) |
| 1104 |
> |
if (!inRange(key)) |
| 1105 |
|
return null; |
| 1106 |
|
return TreeMap.this.get(key); |
| 1107 |
|
} |
| 1113 |
|
} |
| 1114 |
|
|
| 1115 |
|
public V remove(Object key) { |
| 1116 |
< |
if (!inRange((K) key)) |
| 1116 |
> |
if (!inRange(key)) |
| 1117 |
|
return null; |
| 1118 |
|
return TreeMap.this.remove(key); |
| 1119 |
|
} |
| 1126 |
|
TreeMap.Entry<K,V> e = fromStart ? getFirstEntry() : getCeilingEntry(fromKey); |
| 1127 |
|
K first = key(e); |
| 1128 |
|
if (!toEnd && compare(first, toKey) >= 0) |
| 1129 |
< |
throw(new NoSuchElementException()); |
| 1129 |
> |
throw new NoSuchElementException(); |
| 1130 |
|
return first; |
| 1131 |
|
} |
| 1132 |
|
|
| 1134 |
|
TreeMap.Entry<K,V> e = toEnd ? getLastEntry() : getLowerEntry(toKey); |
| 1135 |
|
K last = key(e); |
| 1136 |
|
if (!fromStart && compare(last, fromKey) < 0) |
| 1137 |
< |
throw(new NoSuchElementException()); |
| 1137 |
> |
throw new NoSuchElementException(); |
| 1138 |
|
return last; |
| 1139 |
|
} |
| 1140 |
|
|
| 1141 |
|
public Map.Entry<K,V> firstEntry() { |
| 1142 |
< |
TreeMap.Entry<K,V> e = fromStart ? |
| 1142 |
> |
TreeMap.Entry<K,V> e = fromStart ? |
| 1143 |
|
getFirstEntry() : getCeilingEntry(fromKey); |
| 1144 |
|
if (e == null || (!toEnd && compare(e.key, toKey) >= 0)) |
| 1145 |
|
return null; |
| 1147 |
|
} |
| 1148 |
|
|
| 1149 |
|
public Map.Entry<K,V> lastEntry() { |
| 1150 |
< |
TreeMap.Entry<K,V> e = toEnd ? |
| 1150 |
> |
TreeMap.Entry<K,V> e = toEnd ? |
| 1151 |
|
getLastEntry() : getLowerEntry(toKey); |
| 1152 |
|
if (e == null || (!fromStart && compare(e.key, fromKey) < 0)) |
| 1153 |
|
return null; |
| 1155 |
|
} |
| 1156 |
|
|
| 1157 |
|
public Map.Entry<K,V> pollFirstEntry() { |
| 1158 |
< |
TreeMap.Entry<K,V> e = fromStart ? |
| 1158 |
> |
TreeMap.Entry<K,V> e = fromStart ? |
| 1159 |
|
getFirstEntry() : getCeilingEntry(fromKey); |
| 1160 |
< |
if (e == null || (!fromStart && compare(e.key, fromKey) < 0)) |
| 1160 |
> |
if (e == null || (!toEnd && compare(e.key, toKey) >= 0)) |
| 1161 |
|
return null; |
| 1162 |
< |
Map.Entry result = new AbstractMap.SimpleImmutableEntry(e); |
| 1162 |
> |
Map.Entry<K,V> result = new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 1163 |
|
deleteEntry(e); |
| 1164 |
|
return result; |
| 1165 |
|
} |
| 1166 |
|
|
| 1167 |
|
public Map.Entry<K,V> pollLastEntry() { |
| 1168 |
< |
TreeMap.Entry<K,V> e = toEnd ? |
| 1168 |
> |
TreeMap.Entry<K,V> e = toEnd ? |
| 1169 |
|
getLastEntry() : getLowerEntry(toKey); |
| 1170 |
< |
if (e == null || (!toEnd && compare(e.key, toKey) >= 0)) |
| 1170 |
> |
if (e == null || (!fromStart && compare(e.key, fromKey) < 0)) |
| 1171 |
|
return null; |
| 1172 |
< |
Map.Entry result = new AbstractMap.SimpleImmutableEntry(e); |
| 1172 |
> |
Map.Entry<K,V> result = new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 1173 |
|
deleteEntry(e); |
| 1174 |
|
return result; |
| 1175 |
|
} |
| 1184 |
|
|
| 1185 |
|
public Map.Entry<K,V> ceilingEntry(K key) { |
| 1186 |
|
TreeMap.Entry<K,V> e = subceiling(key); |
| 1187 |
< |
return e == null? null : new AbstractMap.SimpleImmutableEntry(e); |
| 1187 |
> |
return e == null? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 1188 |
|
} |
| 1189 |
|
|
| 1190 |
|
public K ceilingKey(K key) { |
| 1203 |
|
|
| 1204 |
|
public Map.Entry<K,V> higherEntry(K key) { |
| 1205 |
|
TreeMap.Entry<K,V> e = subhigher(key); |
| 1206 |
< |
return e == null? null : new AbstractMap.SimpleImmutableEntry(e); |
| 1206 |
> |
return e == null? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 1207 |
|
} |
| 1208 |
|
|
| 1209 |
|
public K higherKey(K key) { |
| 1221 |
|
|
| 1222 |
|
public Map.Entry<K,V> floorEntry(K key) { |
| 1223 |
|
TreeMap.Entry<K,V> e = subfloor(key); |
| 1224 |
< |
return e == null? null : new AbstractMap.SimpleImmutableEntry(e); |
| 1224 |
> |
return e == null? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 1225 |
|
} |
| 1226 |
|
|
| 1227 |
|
public K floorKey(K key) { |
| 1239 |
|
|
| 1240 |
|
public Map.Entry<K,V> lowerEntry(K key) { |
| 1241 |
|
TreeMap.Entry<K,V> e = sublower(key); |
| 1242 |
< |
return e == null? null : new AbstractMap.SimpleImmutableEntry(e); |
| 1242 |
> |
return e == null? null : new AbstractMap.SimpleImmutableEntry<K,V>(e); |
| 1243 |
|
} |
| 1244 |
|
|
| 1245 |
|
public K lowerKey(K key) { |
| 1247 |
|
return e == null? null : e.key; |
| 1248 |
|
} |
| 1249 |
|
|
| 1250 |
< |
private transient Set<Map.Entry<K,V>> entrySet = new EntrySetView(); |
| 1250 |
> |
private transient Set<Map.Entry<K,V>> entrySet = null; |
| 1251 |
|
|
| 1252 |
|
public Set<Map.Entry<K,V>> entrySet() { |
| 1253 |
< |
return entrySet; |
| 1253 |
> |
Set<Map.Entry<K,V>> es = entrySet; |
| 1254 |
> |
return (es != null)? es : (entrySet = new EntrySetView()); |
| 1255 |
|
} |
| 1256 |
|
|
| 1257 |
|
private class EntrySetView extends AbstractSet<Map.Entry<K,V>> { |
| 1308 |
|
} |
| 1309 |
|
|
| 1310 |
|
private transient Set<Map.Entry<K,V>> descendingEntrySetView = null; |
| 1311 |
< |
private transient Set<K> descendingKeySetView = null; |
| 1311 |
> |
private transient Set<K> descendingKeySetView = null; |
| 1312 |
|
|
| 1313 |
|
public Set<Map.Entry<K,V>> descendingEntrySet() { |
| 1314 |
|
Set<Map.Entry<K,V>> es = descendingEntrySetView; |
| 1315 |
< |
return (es != null) ? es : (descendingEntrySetView = new DescendingEntrySetView()); |
| 1315 |
> |
return (es != null) ? es : |
| 1316 |
> |
(descendingEntrySetView = new DescendingEntrySetView()); |
| 1317 |
|
} |
| 1318 |
|
|
| 1319 |
|
public Set<K> descendingKeySet() { |
| 1320 |
|
Set<K> ks = descendingKeySetView; |
| 1321 |
< |
return (ks != null) ? ks : (descendingKeySetView = new DescendingKeySetView()); |
| 1321 |
> |
return (ks != null) ? ks : |
| 1322 |
> |
(descendingKeySetView = new DescendingKeySetView()); |
| 1323 |
|
} |
| 1324 |
|
|
| 1325 |
|
private class DescendingEntrySetView extends EntrySetView { |
| 1334 |
|
public Iterator<K> iterator() { |
| 1335 |
|
return new Iterator<K>() { |
| 1336 |
|
private Iterator<Entry<K,V>> i = descendingEntrySet().iterator(); |
| 1337 |
< |
|
| 1337 |
> |
|
| 1338 |
|
public boolean hasNext() { return i.hasNext(); } |
| 1339 |
|
public K next() { return i.next().getKey(); } |
| 1340 |
|
public void remove() { i.remove(); } |
| 1341 |
|
}; |
| 1342 |
|
} |
| 1343 |
< |
|
| 1343 |
> |
|
| 1344 |
|
public int size() { |
| 1345 |
|
return SubMap.this.size(); |
| 1346 |
|
} |
| 1347 |
< |
|
| 1347 |
> |
|
| 1348 |
|
public boolean contains(Object k) { |
| 1349 |
|
return SubMap.this.containsKey(k); |
| 1350 |
|
} |
| 1351 |
|
} |
| 1352 |
|
|
| 1353 |
< |
|
| 1500 |
< |
public NavigableMap<K,V> subMap(K fromKey, K toKey) { |
| 1353 |
> |
public NavigableMap<K,V> navigableSubMap(K fromKey, K toKey) { |
| 1354 |
|
if (!inRange2(fromKey)) |
| 1355 |
|
throw new IllegalArgumentException("fromKey out of range"); |
| 1356 |
|
if (!inRange2(toKey)) |
| 1358 |
|
return new SubMap(fromKey, toKey); |
| 1359 |
|
} |
| 1360 |
|
|
| 1361 |
< |
public NavigableMap<K,V> headMap(K toKey) { |
| 1361 |
> |
public NavigableMap<K,V> navigableHeadMap(K toKey) { |
| 1362 |
|
if (!inRange2(toKey)) |
| 1363 |
|
throw new IllegalArgumentException("toKey out of range"); |
| 1364 |
|
return new SubMap(fromStart, fromKey, false, toKey); |
| 1365 |
|
} |
| 1366 |
|
|
| 1367 |
< |
public NavigableMap<K,V> tailMap(K fromKey) { |
| 1367 |
> |
public NavigableMap<K,V> navigableTailMap(K fromKey) { |
| 1368 |
|
if (!inRange2(fromKey)) |
| 1369 |
|
throw new IllegalArgumentException("fromKey out of range"); |
| 1370 |
|
return new SubMap(false, fromKey, toEnd, toKey); |
| 1371 |
|
} |
| 1372 |
|
|
| 1373 |
< |
private boolean inRange(K key) { |
| 1373 |
> |
public SortedMap<K,V> subMap(K fromKey, K toKey) { |
| 1374 |
> |
return navigableSubMap(fromKey, toKey); |
| 1375 |
> |
} |
| 1376 |
> |
|
| 1377 |
> |
public SortedMap<K,V> headMap(K toKey) { |
| 1378 |
> |
return navigableHeadMap(toKey); |
| 1379 |
> |
} |
| 1380 |
> |
|
| 1381 |
> |
public SortedMap<K,V> tailMap(K fromKey) { |
| 1382 |
> |
return navigableTailMap(fromKey); |
| 1383 |
> |
} |
| 1384 |
> |
|
| 1385 |
> |
private boolean inRange(Object key) { |
| 1386 |
|
return (fromStart || compare(key, fromKey) >= 0) && |
| 1387 |
|
(toEnd || compare(key, toKey) < 0); |
| 1388 |
|
} |
| 1389 |
|
|
| 1390 |
|
// This form allows the high endpoint (as well as all legit keys) |
| 1391 |
< |
private boolean inRange2(K key) { |
| 1391 |
> |
private boolean inRange2(Object key) { |
| 1392 |
|
return (fromStart || compare(key, fromKey) >= 0) && |
| 1393 |
|
(toEnd || compare(key, toKey) <= 0); |
| 1394 |
|
} |
| 1410 |
|
return next != null; |
| 1411 |
|
} |
| 1412 |
|
|
| 1413 |
< |
Entry<K,V> nextEntry() { |
| 1413 |
> |
Entry<K,V> nextEntry() { |
| 1414 |
|
if (next == null) |
| 1415 |
|
throw new NoSuchElementException(); |
| 1416 |
|
if (modCount != expectedModCount) |
| 1437 |
|
EntryIterator(Entry<K,V> first) { |
| 1438 |
|
super(first); |
| 1439 |
|
} |
| 1575 |
– |
|
| 1440 |
|
public Map.Entry<K,V> next() { |
| 1441 |
|
return nextEntry(); |
| 1442 |
|
} |
| 1481 |
|
} |
| 1482 |
|
} |
| 1483 |
|
|
| 1620 |
– |
|
| 1484 |
|
/** |
| 1485 |
|
* Base for Descending Iterators. |
| 1486 |
|
*/ |
| 1541 |
|
|
| 1542 |
|
} |
| 1543 |
|
|
| 1681 |
– |
|
| 1544 |
|
/** |
| 1545 |
|
* Compares two keys using the correct comparison method for this TreeMap. |
| 1546 |
|
*/ |
| 1547 |
< |
private int compare(K k1, K k2) { |
| 1548 |
< |
return (comparator==null ? ((Comparable</*-*/K>)k1).compareTo(k2) |
| 1549 |
< |
: comparator.compare((K)k1, (K)k2)); |
| 1547 |
> |
private int compare(Object k1, Object k2) { |
| 1548 |
> |
return comparator==null ? ((Comparable<? super K>)k1).compareTo((K)k2) |
| 1549 |
> |
: comparator.compare((K)k1, (K)k2); |
| 1550 |
|
} |
| 1551 |
|
|
| 1552 |
|
/** |
| 1553 |
< |
* Test two values for equality. Differs from o1.equals(o2) only in |
| 1553 |
> |
* Test two values for equality. Differs from o1.equals(o2) only in |
| 1554 |
|
* that it copes with <tt>null</tt> o1 properly. |
| 1555 |
|
*/ |
| 1556 |
|
private static boolean valEquals(Object o1, Object o2) { |
| 1586 |
|
/** |
| 1587 |
|
* Returns the key. |
| 1588 |
|
* |
| 1589 |
< |
* @return the key. |
| 1589 |
> |
* @return the key |
| 1590 |
|
*/ |
| 1591 |
|
public K getKey() { |
| 1592 |
|
return key; |
| 1595 |
|
/** |
| 1596 |
|
* Returns the value associated with the key. |
| 1597 |
|
* |
| 1598 |
< |
* @return the value associated with the key. |
| 1598 |
> |
* @return the value associated with the key |
| 1599 |
|
*/ |
| 1600 |
|
public V getValue() { |
| 1601 |
|
return value; |
| 1606 |
|
* value. |
| 1607 |
|
* |
| 1608 |
|
* @return the value associated with the key before this method was |
| 1609 |
< |
* called. |
| 1609 |
> |
* called |
| 1610 |
|
*/ |
| 1611 |
|
public V setValue(V value) { |
| 1612 |
|
V oldValue = this.value; |
| 1977 |
|
} |
| 1978 |
|
|
| 1979 |
|
/** Intended to be called only from TreeSet.addAll **/ |
| 1980 |
< |
void addAllForTreeSet(SortedSet<Map.Entry<K,V>> set, V defaultVal) { |
| 1980 |
> |
void addAllForTreeSet(SortedSet<? extends K> set, V defaultVal) { |
| 1981 |
|
try { |
| 1982 |
|
buildFromSorted(set.size(), set.iterator(), null, defaultVal); |
| 1983 |
|
} catch (java.io.IOException cannotHappen) { |
| 2002 |
|
* to calling this method. |
| 2003 |
|
* |
| 2004 |
|
* @param size the number of keys (or key-value pairs) to be read from |
| 2005 |
< |
* the iterator or stream. |
| 2005 |
> |
* the iterator or stream |
| 2006 |
|
* @param it If non-null, new entries are created from entries |
| 2007 |
|
* or keys read from this iterator. |
| 2008 |
|
* @param str If non-null, new entries are created from keys and |
| 2037 |
|
* @param level the current level of tree. Initial call should be 0. |
| 2038 |
|
* @param lo the first element index of this subtree. Initial should be 0. |
| 2039 |
|
* @param hi the last element index of this subtree. Initial should be |
| 2040 |
< |
* size-1. |
| 2040 |
> |
* size-1. |
| 2041 |
|
* @param redLevel the level at which nodes should be red. |
| 2042 |
|
* Must be equal to computeRedLevel for tree of this size. |
| 2043 |
|
*/ |
| 2121 |
|
level++; |
| 2122 |
|
return level; |
| 2123 |
|
} |
| 2262 |
– |
|
| 2124 |
|
} |
