TreeMap.java revision 15a062b16485b913fbca72ce5ebafb9e16aab284
1/* 2 * Copyright (C) 2014 The Android Open Source Project 3 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. 4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 5 * 6 * This code is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License version 2 only, as 8 * published by the Free Software Foundation. Oracle designates this 9 * particular file as subject to the "Classpath" exception as provided 10 * by Oracle in the LICENSE file that accompanied this code. 11 * 12 * This code is distributed in the hope that it will be useful, but WITHOUT 13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15 * version 2 for more details (a copy is included in the LICENSE file that 16 * accompanied this code). 17 * 18 * You should have received a copy of the GNU General Public License version 19 * 2 along with this work; if not, write to the Free Software Foundation, 20 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 21 * 22 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 23 * or visit www.oracle.com if you need additional information or have any 24 * questions. 25 */ 26 27package java.util; 28 29import java.io.Serializable; 30import java.util.function.BiConsumer; 31import java.util.function.BiFunction; 32import java.util.function.Consumer; 33 34/** 35 * A Red-Black tree based {@link NavigableMap} implementation. 36 * The map is sorted according to the {@linkplain Comparable natural 37 * ordering} of its keys, or by a {@link Comparator} provided at map 38 * creation time, depending on which constructor is used. 39 * 40 * <p>This implementation provides guaranteed log(n) time cost for the 41 * {@code containsKey}, {@code get}, {@code put} and {@code remove} 42 * operations. Algorithms are adaptations of those in Cormen, Leiserson, and 43 * Rivest's <em>Introduction to Algorithms</em>. 44 * 45 * <p>Note that the ordering maintained by a tree map, like any sorted map, and 46 * whether or not an explicit comparator is provided, must be <em>consistent 47 * with {@code equals}</em> if this sorted map is to correctly implement the 48 * {@code Map} interface. (See {@code Comparable} or {@code Comparator} for a 49 * precise definition of <em>consistent with equals</em>.) This is so because 50 * the {@code Map} interface is defined in terms of the {@code equals} 51 * operation, but a sorted map performs all key comparisons using its {@code 52 * compareTo} (or {@code compare}) method, so two keys that are deemed equal by 53 * this method are, from the standpoint of the sorted map, equal. The behavior 54 * of a sorted map <em>is</em> well-defined even if its ordering is 55 * inconsistent with {@code equals}; it just fails to obey the general contract 56 * of the {@code Map} interface. 57 * 58 * <p><strong>Note that this implementation is not synchronized.</strong> 59 * If multiple threads access a map concurrently, and at least one of the 60 * threads modifies the map structurally, it <em>must</em> be synchronized 61 * externally. (A structural modification is any operation that adds or 62 * deletes one or more mappings; merely changing the value associated 63 * with an existing key is not a structural modification.) This is 64 * typically accomplished by synchronizing on some object that naturally 65 * encapsulates the map. 66 * If no such object exists, the map should be "wrapped" using the 67 * {@link Collections#synchronizedSortedMap Collections.synchronizedSortedMap} 68 * method. This is best done at creation time, to prevent accidental 69 * unsynchronized access to the map: <pre> 70 * SortedMap m = Collections.synchronizedSortedMap(new TreeMap(...));</pre> 71 * 72 * <p>The iterators returned by the {@code iterator} method of the collections 73 * returned by all of this class's "collection view methods" are 74 * <em>fail-fast</em>: if the map is structurally modified at any time after 75 * the iterator is created, in any way except through the iterator's own 76 * {@code remove} method, the iterator will throw a {@link 77 * ConcurrentModificationException}. Thus, in the face of concurrent 78 * modification, the iterator fails quickly and cleanly, rather than risking 79 * arbitrary, non-deterministic behavior at an undetermined time in the future. 80 * 81 * <p>Note that the fail-fast behavior of an iterator cannot be guaranteed 82 * as it is, generally speaking, impossible to make any hard guarantees in the 83 * presence of unsynchronized concurrent modification. Fail-fast iterators 84 * throw {@code ConcurrentModificationException} on a best-effort basis. 85 * Therefore, it would be wrong to write a program that depended on this 86 * exception for its correctness: <em>the fail-fast behavior of iterators 87 * should be used only to detect bugs.</em> 88 * 89 * <p>All {@code Map.Entry} pairs returned by methods in this class 90 * and its views represent snapshots of mappings at the time they were 91 * produced. They do <strong>not</strong> support the {@code Entry.setValue} 92 * method. (Note however that it is possible to change mappings in the 93 * associated map using {@code put}.) 94 * 95 * <p>This class is a member of the 96 * <a href="{@docRoot}openjdk-redirect.html?v=8&path=/technotes/guides/collections/index.html"> 97 * Java Collections Framework</a>. 98 * 99 * @param <K> the type of keys maintained by this map 100 * @param <V> the type of mapped values 101 * 102 * @author Josh Bloch and Doug Lea 103 * @see Map 104 * @see HashMap 105 * @see Hashtable 106 * @see Comparable 107 * @see Comparator 108 * @see Collection 109 * @since 1.2 110 */ 111 112public class TreeMap<K,V> 113 extends AbstractMap<K,V> 114 implements NavigableMap<K,V>, Cloneable, java.io.Serializable 115{ 116 /** 117 * The comparator used to maintain order in this tree map, or 118 * null if it uses the natural ordering of its keys. 119 * 120 * @serial 121 */ 122 private final Comparator<? super K> comparator; 123 124 private transient TreeMapEntry<K,V> root = null; 125 126 /** 127 * The number of entries in the tree 128 */ 129 private transient int size = 0; 130 131 /** 132 * The number of structural modifications to the tree. 133 */ 134 private transient int modCount = 0; 135 136 /** 137 * Constructs a new, empty tree map, using the natural ordering of its 138 * keys. All keys inserted into the map must implement the {@link 139 * Comparable} interface. Furthermore, all such keys must be 140 * <em>mutually comparable</em>: {@code k1.compareTo(k2)} must not throw 141 * a {@code ClassCastException} for any keys {@code k1} and 142 * {@code k2} in the map. If the user attempts to put a key into the 143 * map that violates this constraint (for example, the user attempts to 144 * put a string key into a map whose keys are integers), the 145 * {@code put(Object key, Object value)} call will throw a 146 * {@code ClassCastException}. 147 */ 148 public TreeMap() { 149 comparator = null; 150 } 151 152 /** 153 * Constructs a new, empty tree map, ordered according to the given 154 * comparator. All keys inserted into the map must be <em>mutually 155 * comparable</em> by the given comparator: {@code comparator.compare(k1, 156 * k2)} must not throw a {@code ClassCastException} for any keys 157 * {@code k1} and {@code k2} in the map. If the user attempts to put 158 * a key into the map that violates this constraint, the {@code put(Object 159 * key, Object value)} call will throw a 160 * {@code ClassCastException}. 161 * 162 * @param comparator the comparator that will be used to order this map. 163 * If {@code null}, the {@linkplain Comparable natural 164 * ordering} of the keys will be used. 165 */ 166 public TreeMap(Comparator<? super K> comparator) { 167 this.comparator = comparator; 168 } 169 170 /** 171 * Constructs a new tree map containing the same mappings as the given 172 * map, ordered according to the <em>natural ordering</em> of its keys. 173 * All keys inserted into the new map must implement the {@link 174 * Comparable} interface. Furthermore, all such keys must be 175 * <em>mutually comparable</em>: {@code k1.compareTo(k2)} must not throw 176 * a {@code ClassCastException} for any keys {@code k1} and 177 * {@code k2} in the map. This method runs in n*log(n) time. 178 * 179 * @param m the map whose mappings are to be placed in this map 180 * @throws ClassCastException if the keys in m are not {@link Comparable}, 181 * or are not mutually comparable 182 * @throws NullPointerException if the specified map is null 183 */ 184 public TreeMap(Map<? extends K, ? extends V> m) { 185 comparator = null; 186 putAll(m); 187 } 188 189 /** 190 * Constructs a new tree map containing the same mappings and 191 * using the same ordering as the specified sorted map. This 192 * method runs in linear time. 193 * 194 * @param m the sorted map whose mappings are to be placed in this map, 195 * and whose comparator is to be used to sort this map 196 * @throws NullPointerException if the specified map is null 197 */ 198 public TreeMap(SortedMap<K, ? extends V> m) { 199 comparator = m.comparator(); 200 try { 201 buildFromSorted(m.size(), m.entrySet().iterator(), null, null); 202 } catch (java.io.IOException cannotHappen) { 203 } catch (ClassNotFoundException cannotHappen) { 204 } 205 } 206 207 208 // Query Operations 209 210 /** 211 * Returns the number of key-value mappings in this map. 212 * 213 * @return the number of key-value mappings in this map 214 */ 215 public int size() { 216 return size; 217 } 218 219 /** 220 * Returns {@code true} if this map contains a mapping for the specified 221 * key. 222 * 223 * @param key key whose presence in this map is to be tested 224 * @return {@code true} if this map contains a mapping for the 225 * specified key 226 * @throws ClassCastException if the specified key cannot be compared 227 * with the keys currently in the map 228 * @throws NullPointerException if the specified key is null 229 * and this map uses natural ordering, or its comparator 230 * does not permit null keys 231 */ 232 public boolean containsKey(Object key) { 233 return getEntry(key) != null; 234 } 235 236 /** 237 * Returns {@code true} if this map maps one or more keys to the 238 * specified value. More formally, returns {@code true} if and only if 239 * this map contains at least one mapping to a value {@code v} such 240 * that {@code (value==null ? v==null : value.equals(v))}. This 241 * operation will probably require time linear in the map size for 242 * most implementations. 243 * 244 * @param value value whose presence in this map is to be tested 245 * @return {@code true} if a mapping to {@code value} exists; 246 * {@code false} otherwise 247 * @since 1.2 248 */ 249 public boolean containsValue(Object value) { 250 for (TreeMapEntry<K,V> e = getFirstEntry(); e != null; e = successor(e)) 251 if (valEquals(value, e.value)) 252 return true; 253 return false; 254 } 255 256 /** 257 * Returns the value to which the specified key is mapped, 258 * or {@code null} if this map contains no mapping for the key. 259 * 260 * <p>More formally, if this map contains a mapping from a key 261 * {@code k} to a value {@code v} such that {@code key} compares 262 * equal to {@code k} according to the map's ordering, then this 263 * method returns {@code v}; otherwise it returns {@code null}. 264 * (There can be at most one such mapping.) 265 * 266 * <p>A return value of {@code null} does not <em>necessarily</em> 267 * indicate that the map contains no mapping for the key; it's also 268 * possible that the map explicitly maps the key to {@code null}. 269 * The {@link #containsKey containsKey} operation may be used to 270 * distinguish these two cases. 271 * 272 * @throws ClassCastException if the specified key cannot be compared 273 * with the keys currently in the map 274 * @throws NullPointerException if the specified key is null 275 * and this map uses natural ordering, or its comparator 276 * does not permit null keys 277 */ 278 public V get(Object key) { 279 TreeMapEntry<K,V> p = getEntry(key); 280 return (p==null ? null : p.value); 281 } 282 283 public Comparator<? super K> comparator() { 284 return comparator; 285 } 286 287 /** 288 * @throws NoSuchElementException {@inheritDoc} 289 */ 290 public K firstKey() { 291 return key(getFirstEntry()); 292 } 293 294 /** 295 * @throws NoSuchElementException {@inheritDoc} 296 */ 297 public K lastKey() { 298 return key(getLastEntry()); 299 } 300 301 /** 302 * Copies all of the mappings from the specified map to this map. 303 * These mappings replace any mappings that this map had for any 304 * of the keys currently in the specified map. 305 * 306 * @param map mappings to be stored in this map 307 * @throws ClassCastException if the class of a key or value in 308 * the specified map prevents it from being stored in this map 309 * @throws NullPointerException if the specified map is null or 310 * the specified map contains a null key and this map does not 311 * permit null keys 312 */ 313 public void putAll(Map<? extends K, ? extends V> map) { 314 int mapSize = map.size(); 315 if (size==0 && mapSize!=0 && map instanceof SortedMap) { 316 Comparator<?> c = ((SortedMap<?,?>)map).comparator(); 317 if (c == comparator || (c != null && c.equals(comparator))) { 318 ++modCount; 319 try { 320 buildFromSorted(mapSize, map.entrySet().iterator(), 321 null, null); 322 } catch (java.io.IOException cannotHappen) { 323 } catch (ClassNotFoundException cannotHappen) { 324 } 325 return; 326 } 327 } 328 super.putAll(map); 329 } 330 331 /** 332 * Returns this map's entry for the given key, or {@code null} if the map 333 * does not contain an entry for the key. 334 * 335 * @return this map's entry for the given key, or {@code null} if the map 336 * does not contain an entry for the key 337 * @throws ClassCastException if the specified key cannot be compared 338 * with the keys currently in the map 339 * @throws NullPointerException if the specified key is null 340 * and this map uses natural ordering, or its comparator 341 * does not permit null keys 342 */ 343 final TreeMapEntry<K,V> getEntry(Object key) { 344 // Offload comparator-based version for sake of performance 345 if (comparator != null) 346 return getEntryUsingComparator(key); 347 if (key == null) 348 throw new NullPointerException(); 349 @SuppressWarnings("unchecked") 350 Comparable<? super K> k = (Comparable<? super K>) key; 351 TreeMapEntry<K,V> p = root; 352 while (p != null) { 353 int cmp = k.compareTo(p.key); 354 if (cmp < 0) 355 p = p.left; 356 else if (cmp > 0) 357 p = p.right; 358 else 359 return p; 360 } 361 return null; 362 } 363 364 /** 365 * Version of getEntry using comparator. Split off from getEntry 366 * for performance. (This is not worth doing for most methods, 367 * that are less dependent on comparator performance, but is 368 * worthwhile here.) 369 */ 370 final TreeMapEntry<K,V> getEntryUsingComparator(Object key) { 371 @SuppressWarnings("unchecked") 372 K k = (K) key; 373 Comparator<? super K> cpr = comparator; 374 if (cpr != null) { 375 TreeMapEntry<K,V> p = root; 376 while (p != null) { 377 int cmp = cpr.compare(k, p.key); 378 if (cmp < 0) 379 p = p.left; 380 else if (cmp > 0) 381 p = p.right; 382 else 383 return p; 384 } 385 } 386 return null; 387 } 388 389 /** 390 * Gets the entry corresponding to the specified key; if no such entry 391 * exists, returns the entry for the least key greater than the specified 392 * key; if no such entry exists (i.e., the greatest key in the Tree is less 393 * than the specified key), returns {@code null}. 394 */ 395 final TreeMapEntry<K,V> getCeilingEntry(K key) { 396 TreeMapEntry<K,V> p = root; 397 while (p != null) { 398 int cmp = compare(key, p.key); 399 if (cmp < 0) { 400 if (p.left != null) 401 p = p.left; 402 else 403 return p; 404 } else if (cmp > 0) { 405 if (p.right != null) { 406 p = p.right; 407 } else { 408 TreeMapEntry<K,V> parent = p.parent; 409 TreeMapEntry<K,V> ch = p; 410 while (parent != null && ch == parent.right) { 411 ch = parent; 412 parent = parent.parent; 413 } 414 return parent; 415 } 416 } else 417 return p; 418 } 419 return null; 420 } 421 422 /** 423 * Gets the entry corresponding to the specified key; if no such entry 424 * exists, returns the entry for the greatest key less than the specified 425 * key; if no such entry exists, returns {@code null}. 426 */ 427 final TreeMapEntry<K,V> getFloorEntry(K key) { 428 TreeMapEntry<K,V> p = root; 429 while (p != null) { 430 int cmp = compare(key, p.key); 431 if (cmp > 0) { 432 if (p.right != null) 433 p = p.right; 434 else 435 return p; 436 } else if (cmp < 0) { 437 if (p.left != null) { 438 p = p.left; 439 } else { 440 TreeMapEntry<K,V> parent = p.parent; 441 TreeMapEntry<K,V> ch = p; 442 while (parent != null && ch == parent.left) { 443 ch = parent; 444 parent = parent.parent; 445 } 446 return parent; 447 } 448 } else 449 return p; 450 451 } 452 return null; 453 } 454 455 /** 456 * Gets the entry for the least key greater than the specified 457 * key; if no such entry exists, returns the entry for the least 458 * key greater than the specified key; if no such entry exists 459 * returns {@code null}. 460 */ 461 final TreeMapEntry<K,V> getHigherEntry(K key) { 462 TreeMapEntry<K,V> p = root; 463 while (p != null) { 464 int cmp = compare(key, p.key); 465 if (cmp < 0) { 466 if (p.left != null) 467 p = p.left; 468 else 469 return p; 470 } else { 471 if (p.right != null) { 472 p = p.right; 473 } else { 474 TreeMapEntry<K,V> parent = p.parent; 475 TreeMapEntry<K,V> ch = p; 476 while (parent != null && ch == parent.right) { 477 ch = parent; 478 parent = parent.parent; 479 } 480 return parent; 481 } 482 } 483 } 484 return null; 485 } 486 487 /** 488 * Returns the entry for the greatest key less than the specified key; if 489 * no such entry exists (i.e., the least key in the Tree is greater than 490 * the specified key), returns {@code null}. 491 */ 492 final TreeMapEntry<K,V> getLowerEntry(K key) { 493 TreeMapEntry<K,V> p = root; 494 while (p != null) { 495 int cmp = compare(key, p.key); 496 if (cmp > 0) { 497 if (p.right != null) 498 p = p.right; 499 else 500 return p; 501 } else { 502 if (p.left != null) { 503 p = p.left; 504 } else { 505 TreeMapEntry<K,V> parent = p.parent; 506 TreeMapEntry<K,V> ch = p; 507 while (parent != null && ch == parent.left) { 508 ch = parent; 509 parent = parent.parent; 510 } 511 return parent; 512 } 513 } 514 } 515 return null; 516 } 517 518 /** 519 * Associates the specified value with the specified key in this map. 520 * If the map previously contained a mapping for the key, the old 521 * value is replaced. 522 * 523 * @param key key with which the specified value is to be associated 524 * @param value value to be associated with the specified key 525 * 526 * @return the previous value associated with {@code key}, or 527 * {@code null} if there was no mapping for {@code key}. 528 * (A {@code null} return can also indicate that the map 529 * previously associated {@code null} with {@code key}.) 530 * @throws ClassCastException if the specified key cannot be compared 531 * with the keys currently in the map 532 * @throws NullPointerException if the specified key is null 533 * and this map uses natural ordering, or its comparator 534 * does not permit null keys 535 */ 536 public V put(K key, V value) { 537 TreeMapEntry<K,V> t = root; 538 if (t == null) { 539 // We could just call compare(key, key) for its side effect of checking the type and 540 // nullness of the input key. However, several applications seem to have written comparators 541 // that only expect to be called on elements that aren't equal to each other (after 542 // making assumptions about the domain of the map). Clearly, such comparators are bogus 543 // because get() would never work, but TreeSets are frequently used for sorting a set 544 // of distinct elements. 545 // 546 // As a temporary work around, we perform the null & instanceof checks by hand so that 547 // we can guarantee that elements are never compared against themselves. 548 // 549 // compare(key, key); 550 // 551 // **** THIS CHANGE WILL BE REVERTED IN A FUTURE ANDROID RELEASE **** 552 if (comparator != null) { 553 if (key == null) { 554 comparator.compare(key, key); 555 } 556 } else { 557 if (key == null) { 558 throw new NullPointerException("key == null"); 559 } else if (!(key instanceof Comparable)) { 560 throw new ClassCastException( 561 "Cannot cast" + key.getClass().getName() + " to Comparable."); 562 } 563 } 564 565 root = new TreeMapEntry<>(key, value, null); 566 size = 1; 567 modCount++; 568 return null; 569 } 570 int cmp; 571 TreeMapEntry<K,V> parent; 572 // split comparator and comparable paths 573 Comparator<? super K> cpr = comparator; 574 if (cpr != null) { 575 do { 576 parent = t; 577 cmp = cpr.compare(key, t.key); 578 if (cmp < 0) 579 t = t.left; 580 else if (cmp > 0) 581 t = t.right; 582 else 583 return t.setValue(value); 584 } while (t != null); 585 } 586 else { 587 if (key == null) 588 throw new NullPointerException(); 589 @SuppressWarnings("unchecked") 590 Comparable<? super K> k = (Comparable<? super K>) key; 591 do { 592 parent = t; 593 cmp = k.compareTo(t.key); 594 if (cmp < 0) 595 t = t.left; 596 else if (cmp > 0) 597 t = t.right; 598 else 599 return t.setValue(value); 600 } while (t != null); 601 } 602 TreeMapEntry<K,V> e = new TreeMapEntry<>(key, value, parent); 603 if (cmp < 0) 604 parent.left = e; 605 else 606 parent.right = e; 607 fixAfterInsertion(e); 608 size++; 609 modCount++; 610 return null; 611 } 612 613 /** 614 * Removes the mapping for this key from this TreeMap if present. 615 * 616 * @param key key for which mapping should be removed 617 * @return the previous value associated with {@code key}, or 618 * {@code null} if there was no mapping for {@code key}. 619 * (A {@code null} return can also indicate that the map 620 * previously associated {@code null} with {@code key}.) 621 * @throws ClassCastException if the specified key cannot be compared 622 * with the keys currently in the map 623 * @throws NullPointerException if the specified key is null 624 * and this map uses natural ordering, or its comparator 625 * does not permit null keys 626 */ 627 public V remove(Object key) { 628 TreeMapEntry<K,V> p = getEntry(key); 629 if (p == null) 630 return null; 631 632 V oldValue = p.value; 633 deleteEntry(p); 634 return oldValue; 635 } 636 637 /** 638 * Removes all of the mappings from this map. 639 * The map will be empty after this call returns. 640 */ 641 public void clear() { 642 modCount++; 643 size = 0; 644 root = null; 645 } 646 647 /** 648 * Returns a shallow copy of this {@code TreeMap} instance. (The keys and 649 * values themselves are not cloned.) 650 * 651 * @return a shallow copy of this map 652 */ 653 public Object clone() { 654 TreeMap<?,?> clone; 655 try { 656 clone = (TreeMap<?,?>) super.clone(); 657 } catch (CloneNotSupportedException e) { 658 throw new InternalError(e); 659 } 660 661 // Put clone into "virgin" state (except for comparator) 662 clone.root = null; 663 clone.size = 0; 664 clone.modCount = 0; 665 clone.entrySet = null; 666 clone.navigableKeySet = null; 667 clone.descendingMap = null; 668 669 // Initialize clone with our mappings 670 try { 671 clone.buildFromSorted(size, entrySet().iterator(), null, null); 672 } catch (java.io.IOException cannotHappen) { 673 } catch (ClassNotFoundException cannotHappen) { 674 } 675 676 return clone; 677 } 678 679 // NavigableMap API methods 680 681 /** 682 * @since 1.6 683 */ 684 public Map.Entry<K,V> firstEntry() { 685 return exportEntry(getFirstEntry()); 686 } 687 688 /** 689 * @since 1.6 690 */ 691 public Map.Entry<K,V> lastEntry() { 692 return exportEntry(getLastEntry()); 693 } 694 695 /** 696 * @since 1.6 697 */ 698 public Map.Entry<K,V> pollFirstEntry() { 699 TreeMapEntry<K,V> p = getFirstEntry(); 700 Map.Entry<K,V> result = exportEntry(p); 701 if (p != null) 702 deleteEntry(p); 703 return result; 704 } 705 706 /** 707 * @since 1.6 708 */ 709 public Map.Entry<K,V> pollLastEntry() { 710 TreeMapEntry<K,V> p = getLastEntry(); 711 Map.Entry<K,V> result = exportEntry(p); 712 if (p != null) 713 deleteEntry(p); 714 return result; 715 } 716 717 /** 718 * @throws ClassCastException {@inheritDoc} 719 * @throws NullPointerException if the specified key is null 720 * and this map uses natural ordering, or its comparator 721 * does not permit null keys 722 * @since 1.6 723 */ 724 public Map.Entry<K,V> lowerEntry(K key) { 725 return exportEntry(getLowerEntry(key)); 726 } 727 728 /** 729 * @throws ClassCastException {@inheritDoc} 730 * @throws NullPointerException if the specified key is null 731 * and this map uses natural ordering, or its comparator 732 * does not permit null keys 733 * @since 1.6 734 */ 735 public K lowerKey(K key) { 736 return keyOrNull(getLowerEntry(key)); 737 } 738 739 /** 740 * @throws ClassCastException {@inheritDoc} 741 * @throws NullPointerException if the specified key is null 742 * and this map uses natural ordering, or its comparator 743 * does not permit null keys 744 * @since 1.6 745 */ 746 public Map.Entry<K,V> floorEntry(K key) { 747 return exportEntry(getFloorEntry(key)); 748 } 749 750 /** 751 * @throws ClassCastException {@inheritDoc} 752 * @throws NullPointerException if the specified key is null 753 * and this map uses natural ordering, or its comparator 754 * does not permit null keys 755 * @since 1.6 756 */ 757 public K floorKey(K key) { 758 return keyOrNull(getFloorEntry(key)); 759 } 760 761 /** 762 * @throws ClassCastException {@inheritDoc} 763 * @throws NullPointerException if the specified key is null 764 * and this map uses natural ordering, or its comparator 765 * does not permit null keys 766 * @since 1.6 767 */ 768 public Map.Entry<K,V> ceilingEntry(K key) { 769 return exportEntry(getCeilingEntry(key)); 770 } 771 772 /** 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 ceilingKey(K key) { 780 return keyOrNull(getCeilingEntry(key)); 781 } 782 783 /** 784 * @throws ClassCastException {@inheritDoc} 785 * @throws NullPointerException if the specified key is null 786 * and this map uses natural ordering, or its comparator 787 * does not permit null keys 788 * @since 1.6 789 */ 790 public Map.Entry<K,V> higherEntry(K key) { 791 return exportEntry(getHigherEntry(key)); 792 } 793 794 /** 795 * @throws ClassCastException {@inheritDoc} 796 * @throws NullPointerException if the specified key is null 797 * and this map uses natural ordering, or its comparator 798 * does not permit null keys 799 * @since 1.6 800 */ 801 public K higherKey(K key) { 802 return keyOrNull(getHigherEntry(key)); 803 } 804 805 // Views 806 807 /** 808 * Fields initialized to contain an instance of the entry set view 809 * the first time this view is requested. Views are stateless, so 810 * there's no reason to create more than one. 811 */ 812 private transient EntrySet entrySet; 813 private transient KeySet<K> navigableKeySet; 814 private transient NavigableMap<K,V> descendingMap; 815 816 /** 817 * Returns a {@link Set} view of the keys contained in this map. 818 * 819 * <p>The set's iterator returns the keys in ascending order. 820 * The set's spliterator is 821 * <em><a href="Spliterator.html#binding">late-binding</a></em>, 822 * <em>fail-fast</em>, and additionally reports {@link Spliterator#SORTED} 823 * and {@link Spliterator#ORDERED} with an encounter order that is ascending 824 * key order. The spliterator's comparator (see 825 * {@link java.util.Spliterator#getComparator()}) is {@code null} if 826 * the tree map's comparator (see {@link #comparator()}) is {@code null}. 827 * Otherwise, the spliterator's comparator is the same as or imposes the 828 * same total ordering as the tree map's comparator. 829 * 830 * <p>The set is backed by the map, so changes to the map are 831 * reflected in the set, and vice-versa. If the map is modified 832 * while an iteration over the set is in progress (except through 833 * the iterator's own {@code remove} operation), the results of 834 * the iteration are undefined. The set supports element removal, 835 * which removes the corresponding mapping from the map, via the 836 * {@code Iterator.remove}, {@code Set.remove}, 837 * {@code removeAll}, {@code retainAll}, and {@code clear} 838 * operations. It does not support the {@code add} or {@code addAll} 839 * operations. 840 */ 841 public Set<K> keySet() { 842 return navigableKeySet(); 843 } 844 845 /** 846 * @since 1.6 847 */ 848 public NavigableSet<K> navigableKeySet() { 849 KeySet<K> nks = navigableKeySet; 850 return (nks != null) ? nks : (navigableKeySet = new KeySet<>(this)); 851 } 852 853 /** 854 * @since 1.6 855 */ 856 public NavigableSet<K> descendingKeySet() { 857 return descendingMap().navigableKeySet(); 858 } 859 860 /** 861 * Returns a {@link Collection} view of the values contained in this map. 862 * 863 * <p>The collection's iterator returns the values in ascending order 864 * of the corresponding keys. The collection's spliterator is 865 * <em><a href="Spliterator.html#binding">late-binding</a></em>, 866 * <em>fail-fast</em>, and additionally reports {@link Spliterator#ORDERED} 867 * with an encounter order that is ascending order of the corresponding 868 * keys. 869 * 870 * <p>The collection is backed by the map, so changes to the map are 871 * reflected in the collection, and vice-versa. If the map is 872 * modified while an iteration over the collection is in progress 873 * (except through the iterator's own {@code remove} operation), 874 * the results of the iteration are undefined. The collection 875 * supports element removal, which removes the corresponding 876 * mapping from the map, via the {@code Iterator.remove}, 877 * {@code Collection.remove}, {@code removeAll}, 878 * {@code retainAll} and {@code clear} operations. It does not 879 * support the {@code add} or {@code addAll} operations. 880 */ 881 public Collection<V> values() { 882 Collection<V> vs = values; 883 if (vs == null) { 884 vs = new Values(); 885 values = vs; 886 } 887 return vs; 888 } 889 890 /** 891 * Returns a {@link Set} view of the mappings contained in this map. 892 * 893 * <p>The set's iterator returns the entries in ascending key order. The 894 * sets's spliterator is 895 * <em><a href="Spliterator.html#binding">late-binding</a></em>, 896 * <em>fail-fast</em>, and additionally reports {@link Spliterator#SORTED} and 897 * {@link Spliterator#ORDERED} with an encounter order that is ascending key 898 * order. 899 * 900 * <p>The set is backed by the map, so changes to the map are 901 * reflected in the set, and vice-versa. If the map is modified 902 * while an iteration over the set is in progress (except through 903 * the iterator's own {@code remove} operation, or through the 904 * {@code setValue} operation on a map entry returned by the 905 * iterator) the results of the iteration are undefined. The set 906 * supports element removal, which removes the corresponding 907 * mapping from the map, via the {@code Iterator.remove}, 908 * {@code Set.remove}, {@code removeAll}, {@code retainAll} and 909 * {@code clear} operations. It does not support the 910 * {@code add} or {@code addAll} operations. 911 */ 912 public Set<Map.Entry<K,V>> entrySet() { 913 EntrySet es = entrySet; 914 return (es != null) ? es : (entrySet = new EntrySet()); 915 } 916 917 /** 918 * @since 1.6 919 */ 920 public NavigableMap<K, V> descendingMap() { 921 NavigableMap<K, V> km = descendingMap; 922 return (km != null) ? km : 923 (descendingMap = new DescendingSubMap<>(this, 924 true, null, true, 925 true, null, true)); 926 } 927 928 /** 929 * @throws ClassCastException {@inheritDoc} 930 * @throws NullPointerException if {@code fromKey} or {@code toKey} is 931 * null and this map uses natural ordering, or its comparator 932 * does not permit null keys 933 * @throws IllegalArgumentException {@inheritDoc} 934 * @since 1.6 935 */ 936 public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, 937 K toKey, boolean toInclusive) { 938 return new AscendingSubMap<>(this, 939 false, fromKey, fromInclusive, 940 false, toKey, toInclusive); 941 } 942 943 /** 944 * @throws ClassCastException {@inheritDoc} 945 * @throws NullPointerException if {@code toKey} is null 946 * and this map uses natural ordering, or its comparator 947 * does not permit null keys 948 * @throws IllegalArgumentException {@inheritDoc} 949 * @since 1.6 950 */ 951 public NavigableMap<K,V> headMap(K toKey, boolean inclusive) { 952 return new AscendingSubMap<>(this, 953 true, null, true, 954 false, toKey, inclusive); 955 } 956 957 /** 958 * @throws ClassCastException {@inheritDoc} 959 * @throws NullPointerException if {@code fromKey} is null 960 * and this map uses natural ordering, or its comparator 961 * does not permit null keys 962 * @throws IllegalArgumentException {@inheritDoc} 963 * @since 1.6 964 */ 965 public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) { 966 return new AscendingSubMap<>(this, 967 false, fromKey, inclusive, 968 true, null, true); 969 } 970 971 /** 972 * @throws ClassCastException {@inheritDoc} 973 * @throws NullPointerException if {@code fromKey} or {@code toKey} is 974 * null and this map uses natural ordering, or its comparator 975 * does not permit null keys 976 * @throws IllegalArgumentException {@inheritDoc} 977 */ 978 public SortedMap<K,V> subMap(K fromKey, K toKey) { 979 return subMap(fromKey, true, toKey, false); 980 } 981 982 /** 983 * @throws ClassCastException {@inheritDoc} 984 * @throws NullPointerException if {@code toKey} is null 985 * and this map uses natural ordering, or its comparator 986 * does not permit null keys 987 * @throws IllegalArgumentException {@inheritDoc} 988 */ 989 public SortedMap<K,V> headMap(K toKey) { 990 return headMap(toKey, false); 991 } 992 993 /** 994 * @throws ClassCastException {@inheritDoc} 995 * @throws NullPointerException if {@code fromKey} is null 996 * and this map uses natural ordering, or its comparator 997 * does not permit null keys 998 * @throws IllegalArgumentException {@inheritDoc} 999 */ 1000 public SortedMap<K,V> tailMap(K fromKey) { 1001 return tailMap(fromKey, true); 1002 } 1003 1004 @Override 1005 public boolean replace(K key, V oldValue, V newValue) { 1006 TreeMapEntry<K,V> p = getEntry(key); 1007 if (p!=null && Objects.equals(oldValue, p.value)) { 1008 p.value = newValue; 1009 return true; 1010 } 1011 return false; 1012 } 1013 1014 @Override 1015 public V replace(K key, V value) { 1016 TreeMapEntry<K,V> p = getEntry(key); 1017 if (p!=null) { 1018 V oldValue = p.value; 1019 p.value = value; 1020 return oldValue; 1021 } 1022 return null; 1023 } 1024 1025 @Override 1026 public void forEach(BiConsumer<? super K, ? super V> action) { 1027 Objects.requireNonNull(action); 1028 int expectedModCount = modCount; 1029 for (TreeMapEntry<K, V> e = getFirstEntry(); e != null; e = successor(e)) { 1030 action.accept(e.key, e.value); 1031 1032 if (expectedModCount != modCount) { 1033 throw new ConcurrentModificationException(); 1034 } 1035 } 1036 } 1037 1038 @Override 1039 public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) { 1040 Objects.requireNonNull(function); 1041 int expectedModCount = modCount; 1042 1043 for (TreeMapEntry<K, V> e = getFirstEntry(); e != null; e = successor(e)) { 1044 e.value = function.apply(e.key, e.value); 1045 1046 if (expectedModCount != modCount) { 1047 throw new ConcurrentModificationException(); 1048 } 1049 } 1050 } 1051 1052 // View class support 1053 1054 class Values extends AbstractCollection<V> { 1055 public Iterator<V> iterator() { 1056 return new ValueIterator(getFirstEntry()); 1057 } 1058 1059 public int size() { 1060 return TreeMap.this.size(); 1061 } 1062 1063 public boolean contains(Object o) { 1064 return TreeMap.this.containsValue(o); 1065 } 1066 1067 public boolean remove(Object o) { 1068 for (TreeMapEntry<K,V> e = getFirstEntry(); e != null; e = successor(e)) { 1069 if (valEquals(e.getValue(), o)) { 1070 deleteEntry(e); 1071 return true; 1072 } 1073 } 1074 return false; 1075 } 1076 1077 public void clear() { 1078 TreeMap.this.clear(); 1079 } 1080 1081 public Spliterator<V> spliterator() { 1082 return new ValueSpliterator<K,V>(TreeMap.this, null, null, 0, -1, 0); 1083 } 1084 } 1085 1086 class EntrySet extends AbstractSet<Map.Entry<K,V>> { 1087 public Iterator<Map.Entry<K,V>> iterator() { 1088 return new EntryIterator(getFirstEntry()); 1089 } 1090 1091 public boolean contains(Object o) { 1092 if (!(o instanceof Map.Entry)) 1093 return false; 1094 Map.Entry<?,?> entry = (Map.Entry<?,?>) o; 1095 Object value = entry.getValue(); 1096 TreeMapEntry<K,V> p = getEntry(entry.getKey()); 1097 return p != null && valEquals(p.getValue(), value); 1098 } 1099 1100 public boolean remove(Object o) { 1101 if (!(o instanceof Map.Entry)) 1102 return false; 1103 Map.Entry<?,?> entry = (Map.Entry<?,?>) o; 1104 Object value = entry.getValue(); 1105 TreeMapEntry<K,V> p = getEntry(entry.getKey()); 1106 if (p != null && valEquals(p.getValue(), value)) { 1107 deleteEntry(p); 1108 return true; 1109 } 1110 return false; 1111 } 1112 1113 public int size() { 1114 return TreeMap.this.size(); 1115 } 1116 1117 public void clear() { 1118 TreeMap.this.clear(); 1119 } 1120 1121 public Spliterator<Map.Entry<K,V>> spliterator() { 1122 return new EntrySpliterator<K,V>(TreeMap.this, null, null, 0, -1, 0); 1123 } 1124 } 1125 1126 /* 1127 * Unlike Values and EntrySet, the KeySet class is static, 1128 * delegating to a NavigableMap to allow use by SubMaps, which 1129 * outweighs the ugliness of needing type-tests for the following 1130 * Iterator methods that are defined appropriately in main versus 1131 * submap classes. 1132 */ 1133 1134 Iterator<K> keyIterator() { 1135 return new KeyIterator(getFirstEntry()); 1136 } 1137 1138 Iterator<K> descendingKeyIterator() { 1139 return new DescendingKeyIterator(getLastEntry()); 1140 } 1141 1142 static final class KeySet<E> extends AbstractSet<E> implements NavigableSet<E> { 1143 private final NavigableMap<E, ?> m; 1144 KeySet(NavigableMap<E,?> map) { m = map; } 1145 1146 public Iterator<E> iterator() { 1147 if (m instanceof TreeMap) 1148 return ((TreeMap<E,?>)m).keyIterator(); 1149 else 1150 return ((TreeMap.NavigableSubMap<E,?>)m).keyIterator(); 1151 } 1152 1153 public Iterator<E> descendingIterator() { 1154 if (m instanceof TreeMap) 1155 return ((TreeMap<E,?>)m).descendingKeyIterator(); 1156 else 1157 return ((TreeMap.NavigableSubMap<E,?>)m).descendingKeyIterator(); 1158 } 1159 1160 public int size() { return m.size(); } 1161 public boolean isEmpty() { return m.isEmpty(); } 1162 public boolean contains(Object o) { return m.containsKey(o); } 1163 public void clear() { m.clear(); } 1164 public E lower(E e) { return m.lowerKey(e); } 1165 public E floor(E e) { return m.floorKey(e); } 1166 public E ceiling(E e) { return m.ceilingKey(e); } 1167 public E higher(E e) { return m.higherKey(e); } 1168 public E first() { return m.firstKey(); } 1169 public E last() { return m.lastKey(); } 1170 public Comparator<? super E> comparator() { return m.comparator(); } 1171 public E pollFirst() { 1172 Map.Entry<E,?> e = m.pollFirstEntry(); 1173 return (e == null) ? null : e.getKey(); 1174 } 1175 public E pollLast() { 1176 Map.Entry<E,?> e = m.pollLastEntry(); 1177 return (e == null) ? null : e.getKey(); 1178 } 1179 public boolean remove(Object o) { 1180 int oldSize = size(); 1181 m.remove(o); 1182 return size() != oldSize; 1183 } 1184 public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, 1185 E toElement, boolean toInclusive) { 1186 return new KeySet<>(m.subMap(fromElement, fromInclusive, 1187 toElement, toInclusive)); 1188 } 1189 public NavigableSet<E> headSet(E toElement, boolean inclusive) { 1190 return new KeySet<>(m.headMap(toElement, inclusive)); 1191 } 1192 public NavigableSet<E> tailSet(E fromElement, boolean inclusive) { 1193 return new KeySet<>(m.tailMap(fromElement, inclusive)); 1194 } 1195 public SortedSet<E> subSet(E fromElement, E toElement) { 1196 return subSet(fromElement, true, toElement, false); 1197 } 1198 public SortedSet<E> headSet(E toElement) { 1199 return headSet(toElement, false); 1200 } 1201 public SortedSet<E> tailSet(E fromElement) { 1202 return tailSet(fromElement, true); 1203 } 1204 public NavigableSet<E> descendingSet() { 1205 return new KeySet<>(m.descendingMap()); 1206 } 1207 1208 public Spliterator<E> spliterator() { 1209 return keySpliteratorFor(m); 1210 } 1211 } 1212 1213 /** 1214 * Base class for TreeMap Iterators 1215 */ 1216 abstract class PrivateEntryIterator<T> implements Iterator<T> { 1217 TreeMapEntry<K,V> next; 1218 TreeMapEntry<K,V> lastReturned; 1219 int expectedModCount; 1220 1221 PrivateEntryIterator(TreeMapEntry<K,V> first) { 1222 expectedModCount = modCount; 1223 lastReturned = null; 1224 next = first; 1225 } 1226 1227 public final boolean hasNext() { 1228 return next != null; 1229 } 1230 1231 final TreeMapEntry<K,V> nextEntry() { 1232 TreeMapEntry<K,V> e = next; 1233 if (e == null) 1234 throw new NoSuchElementException(); 1235 if (modCount != expectedModCount) 1236 throw new ConcurrentModificationException(); 1237 next = successor(e); 1238 lastReturned = e; 1239 return e; 1240 } 1241 1242 final TreeMapEntry<K,V> prevEntry() { 1243 TreeMapEntry<K,V> e = next; 1244 if (e == null) 1245 throw new NoSuchElementException(); 1246 if (modCount != expectedModCount) 1247 throw new ConcurrentModificationException(); 1248 next = predecessor(e); 1249 lastReturned = e; 1250 return e; 1251 } 1252 1253 public void remove() { 1254 if (lastReturned == null) 1255 throw new IllegalStateException(); 1256 if (modCount != expectedModCount) 1257 throw new ConcurrentModificationException(); 1258 // deleted entries are replaced by their successors 1259 if (lastReturned.left != null && lastReturned.right != null) 1260 next = lastReturned; 1261 deleteEntry(lastReturned); 1262 expectedModCount = modCount; 1263 lastReturned = null; 1264 } 1265 } 1266 1267 final class EntryIterator extends PrivateEntryIterator<Map.Entry<K,V>> { 1268 EntryIterator(TreeMapEntry<K,V> first) { 1269 super(first); 1270 } 1271 public Map.Entry<K,V> next() { 1272 return nextEntry(); 1273 } 1274 } 1275 1276 final class ValueIterator extends PrivateEntryIterator<V> { 1277 ValueIterator(TreeMapEntry<K,V> first) { 1278 super(first); 1279 } 1280 public V next() { 1281 return nextEntry().value; 1282 } 1283 } 1284 1285 final class KeyIterator extends PrivateEntryIterator<K> { 1286 KeyIterator(TreeMapEntry<K,V> first) { 1287 super(first); 1288 } 1289 public K next() { 1290 return nextEntry().key; 1291 } 1292 } 1293 1294 final class DescendingKeyIterator extends PrivateEntryIterator<K> { 1295 DescendingKeyIterator(TreeMapEntry<K,V> first) { 1296 super(first); 1297 } 1298 public K next() { 1299 return prevEntry().key; 1300 } 1301 public void remove() { 1302 if (lastReturned == null) 1303 throw new IllegalStateException(); 1304 if (modCount != expectedModCount) 1305 throw new ConcurrentModificationException(); 1306 deleteEntry(lastReturned); 1307 lastReturned = null; 1308 expectedModCount = modCount; 1309 } 1310 } 1311 1312 // Little utilities 1313 1314 /** 1315 * Compares two keys using the correct comparison method for this TreeMap. 1316 */ 1317 @SuppressWarnings("unchecked") 1318 final int compare(Object k1, Object k2) { 1319 return comparator==null ? ((Comparable<? super K>)k1).compareTo((K)k2) 1320 : comparator.compare((K)k1, (K)k2); 1321 } 1322 1323 /** 1324 * Test two values for equality. Differs from o1.equals(o2) only in 1325 * that it copes with {@code null} o1 properly. 1326 */ 1327 static final boolean valEquals(Object o1, Object o2) { 1328 return (o1==null ? o2==null : o1.equals(o2)); 1329 } 1330 1331 /** 1332 * Return SimpleImmutableEntry for entry, or null if null 1333 */ 1334 static <K,V> Map.Entry<K,V> exportEntry(TreeMapEntry<K,V> e) { 1335 return (e == null) ? null : 1336 new AbstractMap.SimpleImmutableEntry<>(e); 1337 } 1338 1339 /** 1340 * Return key for entry, or null if null 1341 */ 1342 static <K,V> K keyOrNull(TreeMapEntry<K,V> e) { 1343 return (e == null) ? null : e.key; 1344 } 1345 1346 /** 1347 * Returns the key corresponding to the specified Entry. 1348 * @throws NoSuchElementException if the Entry is null 1349 */ 1350 static <K> K key(TreeMapEntry<K,?> e) { 1351 if (e==null) 1352 throw new NoSuchElementException(); 1353 return e.key; 1354 } 1355 1356 1357 // SubMaps 1358 1359 /** 1360 * Dummy value serving as unmatchable fence key for unbounded 1361 * SubMapIterators 1362 */ 1363 private static final Object UNBOUNDED = new Object(); 1364 1365 /** 1366 * @serial include 1367 */ 1368 abstract static class NavigableSubMap<K,V> extends AbstractMap<K,V> 1369 implements NavigableMap<K,V>, java.io.Serializable { 1370 // Android-changed: Explicitly add a serialVersionUID so that we're serialization 1371 // compatible with the Java-7 version of this class. Several new methods were added 1372 // in Java-8 but none of them have any bearing on the serialized format of the class 1373 // or require any additional state to be preserved. 1374 private static final long serialVersionUID = 2765629423043303731L; 1375 1376 /** 1377 * The backing map. 1378 */ 1379 final TreeMap<K,V> m; 1380 1381 /** 1382 * Endpoints are represented as triples (fromStart, lo, 1383 * loInclusive) and (toEnd, hi, hiInclusive). If fromStart is 1384 * true, then the low (absolute) bound is the start of the 1385 * backing map, and the other values are ignored. Otherwise, 1386 * if loInclusive is true, lo is the inclusive bound, else lo 1387 * is the exclusive bound. Similarly for the upper bound. 1388 */ 1389 final K lo, hi; 1390 final boolean fromStart, toEnd; 1391 final boolean loInclusive, hiInclusive; 1392 1393 NavigableSubMap(TreeMap<K,V> m, 1394 boolean fromStart, K lo, boolean loInclusive, 1395 boolean toEnd, K hi, boolean hiInclusive) { 1396 if (!fromStart && !toEnd) { 1397 if (m.compare(lo, hi) > 0) 1398 throw new IllegalArgumentException("fromKey > toKey"); 1399 } else { 1400 if (!fromStart) // type check 1401 m.compare(lo, lo); 1402 if (!toEnd) 1403 m.compare(hi, hi); 1404 } 1405 1406 this.m = m; 1407 this.fromStart = fromStart; 1408 this.lo = lo; 1409 this.loInclusive = loInclusive; 1410 this.toEnd = toEnd; 1411 this.hi = hi; 1412 this.hiInclusive = hiInclusive; 1413 } 1414 1415 // internal utilities 1416 1417 final boolean tooLow(Object key) { 1418 if (!fromStart) { 1419 int c = m.compare(key, lo); 1420 if (c < 0 || (c == 0 && !loInclusive)) 1421 return true; 1422 } 1423 return false; 1424 } 1425 1426 final boolean tooHigh(Object key) { 1427 if (!toEnd) { 1428 int c = m.compare(key, hi); 1429 if (c > 0 || (c == 0 && !hiInclusive)) 1430 return true; 1431 } 1432 return false; 1433 } 1434 1435 final boolean inRange(Object key) { 1436 return !tooLow(key) && !tooHigh(key); 1437 } 1438 1439 final boolean inClosedRange(Object key) { 1440 return (fromStart || m.compare(key, lo) >= 0) 1441 && (toEnd || m.compare(hi, key) >= 0); 1442 } 1443 1444 final boolean inRange(Object key, boolean inclusive) { 1445 return inclusive ? inRange(key) : inClosedRange(key); 1446 } 1447 1448 /* 1449 * Absolute versions of relation operations. 1450 * Subclasses map to these using like-named "sub" 1451 * versions that invert senses for descending maps 1452 */ 1453 1454 final TreeMapEntry<K,V> absLowest() { 1455 TreeMapEntry<K,V> e = 1456 (fromStart ? m.getFirstEntry() : 1457 (loInclusive ? m.getCeilingEntry(lo) : 1458 m.getHigherEntry(lo))); 1459 return (e == null || tooHigh(e.key)) ? null : e; 1460 } 1461 1462 final TreeMapEntry<K,V> absHighest() { 1463 TreeMapEntry<K,V> e = 1464 (toEnd ? m.getLastEntry() : 1465 (hiInclusive ? m.getFloorEntry(hi) : 1466 m.getLowerEntry(hi))); 1467 return (e == null || tooLow(e.key)) ? null : e; 1468 } 1469 1470 final TreeMapEntry<K,V> absCeiling(K key) { 1471 if (tooLow(key)) 1472 return absLowest(); 1473 TreeMapEntry<K,V> e = m.getCeilingEntry(key); 1474 return (e == null || tooHigh(e.key)) ? null : e; 1475 } 1476 1477 final TreeMapEntry<K,V> absHigher(K key) { 1478 if (tooLow(key)) 1479 return absLowest(); 1480 TreeMapEntry<K,V> e = m.getHigherEntry(key); 1481 return (e == null || tooHigh(e.key)) ? null : e; 1482 } 1483 1484 final TreeMapEntry<K,V> absFloor(K key) { 1485 if (tooHigh(key)) 1486 return absHighest(); 1487 TreeMapEntry<K,V> e = m.getFloorEntry(key); 1488 return (e == null || tooLow(e.key)) ? null : e; 1489 } 1490 1491 final TreeMapEntry<K,V> absLower(K key) { 1492 if (tooHigh(key)) 1493 return absHighest(); 1494 TreeMapEntry<K,V> e = m.getLowerEntry(key); 1495 return (e == null || tooLow(e.key)) ? null : e; 1496 } 1497 1498 /** Returns the absolute high fence for ascending traversal */ 1499 final TreeMapEntry<K,V> absHighFence() { 1500 return (toEnd ? null : (hiInclusive ? 1501 m.getHigherEntry(hi) : 1502 m.getCeilingEntry(hi))); 1503 } 1504 1505 /** Return the absolute low fence for descending traversal */ 1506 final TreeMapEntry<K,V> absLowFence() { 1507 return (fromStart ? null : (loInclusive ? 1508 m.getLowerEntry(lo) : 1509 m.getFloorEntry(lo))); 1510 } 1511 1512 // Abstract methods defined in ascending vs descending classes 1513 // These relay to the appropriate absolute versions 1514 1515 abstract TreeMapEntry<K,V> subLowest(); 1516 abstract TreeMapEntry<K,V> subHighest(); 1517 abstract TreeMapEntry<K,V> subCeiling(K key); 1518 abstract TreeMapEntry<K,V> subHigher(K key); 1519 abstract TreeMapEntry<K,V> subFloor(K key); 1520 abstract TreeMapEntry<K,V> subLower(K key); 1521 1522 /** Returns ascending iterator from the perspective of this submap */ 1523 abstract Iterator<K> keyIterator(); 1524 1525 abstract Spliterator<K> keySpliterator(); 1526 1527 /** Returns descending iterator from the perspective of this submap */ 1528 abstract Iterator<K> descendingKeyIterator(); 1529 1530 // public methods 1531 1532 public boolean isEmpty() { 1533 return (fromStart && toEnd) ? m.isEmpty() : entrySet().isEmpty(); 1534 } 1535 1536 public int size() { 1537 return (fromStart && toEnd) ? m.size() : entrySet().size(); 1538 } 1539 1540 public final boolean containsKey(Object key) { 1541 return inRange(key) && m.containsKey(key); 1542 } 1543 1544 public final V put(K key, V value) { 1545 if (!inRange(key)) 1546 throw new IllegalArgumentException("key out of range"); 1547 return m.put(key, value); 1548 } 1549 1550 public final V get(Object key) { 1551 return !inRange(key) ? null : m.get(key); 1552 } 1553 1554 public final V remove(Object key) { 1555 return !inRange(key) ? null : m.remove(key); 1556 } 1557 1558 public final Map.Entry<K,V> ceilingEntry(K key) { 1559 return exportEntry(subCeiling(key)); 1560 } 1561 1562 public final K ceilingKey(K key) { 1563 return keyOrNull(subCeiling(key)); 1564 } 1565 1566 public final Map.Entry<K,V> higherEntry(K key) { 1567 return exportEntry(subHigher(key)); 1568 } 1569 1570 public final K higherKey(K key) { 1571 return keyOrNull(subHigher(key)); 1572 } 1573 1574 public final Map.Entry<K,V> floorEntry(K key) { 1575 return exportEntry(subFloor(key)); 1576 } 1577 1578 public final K floorKey(K key) { 1579 return keyOrNull(subFloor(key)); 1580 } 1581 1582 public final Map.Entry<K,V> lowerEntry(K key) { 1583 return exportEntry(subLower(key)); 1584 } 1585 1586 public final K lowerKey(K key) { 1587 return keyOrNull(subLower(key)); 1588 } 1589 1590 public final K firstKey() { 1591 return key(subLowest()); 1592 } 1593 1594 public final K lastKey() { 1595 return key(subHighest()); 1596 } 1597 1598 public final Map.Entry<K,V> firstEntry() { 1599 return exportEntry(subLowest()); 1600 } 1601 1602 public final Map.Entry<K,V> lastEntry() { 1603 return exportEntry(subHighest()); 1604 } 1605 1606 public final Map.Entry<K,V> pollFirstEntry() { 1607 TreeMapEntry<K,V> e = subLowest(); 1608 Map.Entry<K,V> result = exportEntry(e); 1609 if (e != null) 1610 m.deleteEntry(e); 1611 return result; 1612 } 1613 1614 public final Map.Entry<K,V> pollLastEntry() { 1615 TreeMapEntry<K,V> e = subHighest(); 1616 Map.Entry<K,V> result = exportEntry(e); 1617 if (e != null) 1618 m.deleteEntry(e); 1619 return result; 1620 } 1621 1622 // Views 1623 transient NavigableMap<K,V> descendingMapView; 1624 transient EntrySetView entrySetView; 1625 transient KeySet<K> navigableKeySetView; 1626 1627 public final NavigableSet<K> navigableKeySet() { 1628 KeySet<K> nksv = navigableKeySetView; 1629 return (nksv != null) ? nksv : 1630 (navigableKeySetView = new TreeMap.KeySet<>(this)); 1631 } 1632 1633 public final Set<K> keySet() { 1634 return navigableKeySet(); 1635 } 1636 1637 public NavigableSet<K> descendingKeySet() { 1638 return descendingMap().navigableKeySet(); 1639 } 1640 1641 public final SortedMap<K,V> subMap(K fromKey, K toKey) { 1642 return subMap(fromKey, true, toKey, false); 1643 } 1644 1645 public final SortedMap<K,V> headMap(K toKey) { 1646 return headMap(toKey, false); 1647 } 1648 1649 public final SortedMap<K,V> tailMap(K fromKey) { 1650 return tailMap(fromKey, true); 1651 } 1652 1653 // View classes 1654 1655 abstract class EntrySetView extends AbstractSet<Map.Entry<K,V>> { 1656 private transient int size = -1, sizeModCount; 1657 1658 public int size() { 1659 if (fromStart && toEnd) 1660 return m.size(); 1661 if (size == -1 || sizeModCount != m.modCount) { 1662 sizeModCount = m.modCount; 1663 size = 0; 1664 Iterator<?> i = iterator(); 1665 while (i.hasNext()) { 1666 size++; 1667 i.next(); 1668 } 1669 } 1670 return size; 1671 } 1672 1673 public boolean isEmpty() { 1674 TreeMapEntry<K,V> n = absLowest(); 1675 return n == null || tooHigh(n.key); 1676 } 1677 1678 public boolean contains(Object o) { 1679 if (!(o instanceof Map.Entry)) 1680 return false; 1681 Map.Entry<?,?> entry = (Map.Entry<?,?>) o; 1682 Object key = entry.getKey(); 1683 if (!inRange(key)) 1684 return false; 1685 TreeMapEntry<?, ?> node = m.getEntry(key); 1686 return node != null && 1687 valEquals(node.getValue(), entry.getValue()); 1688 } 1689 1690 public boolean remove(Object o) { 1691 if (!(o instanceof Map.Entry)) 1692 return false; 1693 Map.Entry<?,?> entry = (Map.Entry<?,?>) o; 1694 Object key = entry.getKey(); 1695 if (!inRange(key)) 1696 return false; 1697 TreeMapEntry<K,V> node = m.getEntry(key); 1698 if (node!=null && valEquals(node.getValue(), 1699 entry.getValue())) { 1700 m.deleteEntry(node); 1701 return true; 1702 } 1703 return false; 1704 } 1705 } 1706 1707 /** 1708 * Iterators for SubMaps 1709 */ 1710 abstract class SubMapIterator<T> implements Iterator<T> { 1711 TreeMapEntry<K,V> lastReturned; 1712 TreeMapEntry<K,V> next; 1713 final Object fenceKey; 1714 int expectedModCount; 1715 1716 SubMapIterator(TreeMapEntry<K,V> first, 1717 TreeMapEntry<K,V> fence) { 1718 expectedModCount = m.modCount; 1719 lastReturned = null; 1720 next = first; 1721 fenceKey = fence == null ? UNBOUNDED : fence.key; 1722 } 1723 1724 public final boolean hasNext() { 1725 return next != null && next.key != fenceKey; 1726 } 1727 1728 final TreeMapEntry<K,V> nextEntry() { 1729 TreeMapEntry<K,V> e = next; 1730 if (e == null || e.key == fenceKey) 1731 throw new NoSuchElementException(); 1732 if (m.modCount != expectedModCount) 1733 throw new ConcurrentModificationException(); 1734 next = successor(e); 1735 lastReturned = e; 1736 return e; 1737 } 1738 1739 final TreeMapEntry<K,V> prevEntry() { 1740 TreeMapEntry<K,V> e = next; 1741 if (e == null || e.key == fenceKey) 1742 throw new NoSuchElementException(); 1743 if (m.modCount != expectedModCount) 1744 throw new ConcurrentModificationException(); 1745 next = predecessor(e); 1746 lastReturned = e; 1747 return e; 1748 } 1749 1750 final void removeAscending() { 1751 if (lastReturned == null) 1752 throw new IllegalStateException(); 1753 if (m.modCount != expectedModCount) 1754 throw new ConcurrentModificationException(); 1755 // deleted entries are replaced by their successors 1756 if (lastReturned.left != null && lastReturned.right != null) 1757 next = lastReturned; 1758 m.deleteEntry(lastReturned); 1759 lastReturned = null; 1760 expectedModCount = m.modCount; 1761 } 1762 1763 final void removeDescending() { 1764 if (lastReturned == null) 1765 throw new IllegalStateException(); 1766 if (m.modCount != expectedModCount) 1767 throw new ConcurrentModificationException(); 1768 m.deleteEntry(lastReturned); 1769 lastReturned = null; 1770 expectedModCount = m.modCount; 1771 } 1772 1773 } 1774 1775 final class SubMapEntryIterator extends SubMapIterator<Map.Entry<K,V>> { 1776 SubMapEntryIterator(TreeMapEntry<K,V> first, 1777 TreeMapEntry<K,V> fence) { 1778 super(first, fence); 1779 } 1780 public Map.Entry<K,V> next() { 1781 return nextEntry(); 1782 } 1783 public void remove() { 1784 removeAscending(); 1785 } 1786 } 1787 1788 final class DescendingSubMapEntryIterator extends SubMapIterator<Map.Entry<K,V>> { 1789 DescendingSubMapEntryIterator(TreeMapEntry<K,V> last, 1790 TreeMapEntry<K,V> fence) { 1791 super(last, fence); 1792 } 1793 1794 public Map.Entry<K,V> next() { 1795 return prevEntry(); 1796 } 1797 public void remove() { 1798 removeDescending(); 1799 } 1800 } 1801 1802 // Implement minimal Spliterator as KeySpliterator backup 1803 final class SubMapKeyIterator extends SubMapIterator<K> 1804 implements Spliterator<K> { 1805 SubMapKeyIterator(TreeMapEntry<K,V> first, 1806 TreeMapEntry<K,V> fence) { 1807 super(first, fence); 1808 } 1809 public K next() { 1810 return nextEntry().key; 1811 } 1812 public void remove() { 1813 removeAscending(); 1814 } 1815 public Spliterator<K> trySplit() { 1816 return null; 1817 } 1818 public void forEachRemaining(Consumer<? super K> action) { 1819 while (hasNext()) 1820 action.accept(next()); 1821 } 1822 public boolean tryAdvance(Consumer<? super K> action) { 1823 if (hasNext()) { 1824 action.accept(next()); 1825 return true; 1826 } 1827 return false; 1828 } 1829 public long estimateSize() { 1830 return Long.MAX_VALUE; 1831 } 1832 public int characteristics() { 1833 return Spliterator.DISTINCT | Spliterator.ORDERED | 1834 Spliterator.SORTED; 1835 } 1836 public final Comparator<? super K> getComparator() { 1837 return NavigableSubMap.this.comparator(); 1838 } 1839 } 1840 1841 final class DescendingSubMapKeyIterator extends SubMapIterator<K> 1842 implements Spliterator<K> { 1843 DescendingSubMapKeyIterator(TreeMapEntry<K,V> last, 1844 TreeMapEntry<K,V> fence) { 1845 super(last, fence); 1846 } 1847 public K next() { 1848 return prevEntry().key; 1849 } 1850 public void remove() { 1851 removeDescending(); 1852 } 1853 public Spliterator<K> trySplit() { 1854 return null; 1855 } 1856 public void forEachRemaining(Consumer<? super K> action) { 1857 while (hasNext()) 1858 action.accept(next()); 1859 } 1860 public boolean tryAdvance(Consumer<? super K> action) { 1861 if (hasNext()) { 1862 action.accept(next()); 1863 return true; 1864 } 1865 return false; 1866 } 1867 public long estimateSize() { 1868 return Long.MAX_VALUE; 1869 } 1870 public int characteristics() { 1871 return Spliterator.DISTINCT | Spliterator.ORDERED; 1872 } 1873 } 1874 } 1875 1876 /** 1877 * @serial include 1878 */ 1879 static final class AscendingSubMap<K,V> extends NavigableSubMap<K,V> { 1880 private static final long serialVersionUID = 912986545866124060L; 1881 1882 AscendingSubMap(TreeMap<K,V> m, 1883 boolean fromStart, K lo, boolean loInclusive, 1884 boolean toEnd, K hi, boolean hiInclusive) { 1885 super(m, fromStart, lo, loInclusive, toEnd, hi, hiInclusive); 1886 } 1887 1888 public Comparator<? super K> comparator() { 1889 return m.comparator(); 1890 } 1891 1892 public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, 1893 K toKey, boolean toInclusive) { 1894 if (!inRange(fromKey, fromInclusive)) 1895 throw new IllegalArgumentException("fromKey out of range"); 1896 if (!inRange(toKey, toInclusive)) 1897 throw new IllegalArgumentException("toKey out of range"); 1898 return new AscendingSubMap<>(m, 1899 false, fromKey, fromInclusive, 1900 false, toKey, toInclusive); 1901 } 1902 1903 public NavigableMap<K,V> headMap(K toKey, boolean inclusive) { 1904 /* Android-changed BEGIN 1905 Fix for edge cases 1906 if (!inRange(toKey, inclusive)) */ 1907 if (!inRange(toKey) && !(!toEnd && m.compare(toKey, hi) == 0 && 1908 !hiInclusive && !inclusive)) 1909 /* Android-changed END */ 1910 throw new IllegalArgumentException("toKey out of range"); 1911 return new AscendingSubMap<>(m, 1912 fromStart, lo, loInclusive, 1913 false, toKey, inclusive); 1914 } 1915 1916 public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) { 1917 /* Android-changed BEGIN 1918 Fix for edge cases 1919 if (!inRange(fromKey, inclusive)) */ 1920 if (!inRange(fromKey) && !(!fromStart && m.compare(fromKey, lo) == 0 && 1921 !loInclusive && !inclusive)) 1922 /* Android-changed END */ 1923 throw new IllegalArgumentException("fromKey out of range"); 1924 return new AscendingSubMap<>(m, 1925 false, fromKey, inclusive, 1926 toEnd, hi, hiInclusive); 1927 } 1928 1929 public NavigableMap<K,V> descendingMap() { 1930 NavigableMap<K,V> mv = descendingMapView; 1931 return (mv != null) ? mv : 1932 (descendingMapView = 1933 new DescendingSubMap<>(m, 1934 fromStart, lo, loInclusive, 1935 toEnd, hi, hiInclusive)); 1936 } 1937 1938 Iterator<K> keyIterator() { 1939 return new SubMapKeyIterator(absLowest(), absHighFence()); 1940 } 1941 1942 Spliterator<K> keySpliterator() { 1943 return new SubMapKeyIterator(absLowest(), absHighFence()); 1944 } 1945 1946 Iterator<K> descendingKeyIterator() { 1947 return new DescendingSubMapKeyIterator(absHighest(), absLowFence()); 1948 } 1949 1950 final class AscendingEntrySetView extends EntrySetView { 1951 public Iterator<Map.Entry<K,V>> iterator() { 1952 return new SubMapEntryIterator(absLowest(), absHighFence()); 1953 } 1954 } 1955 1956 public Set<Map.Entry<K,V>> entrySet() { 1957 EntrySetView es = entrySetView; 1958 return (es != null) ? es : (entrySetView = new AscendingEntrySetView()); 1959 } 1960 1961 TreeMapEntry<K,V> subLowest() { return absLowest(); } 1962 TreeMapEntry<K,V> subHighest() { return absHighest(); } 1963 TreeMapEntry<K,V> subCeiling(K key) { return absCeiling(key); } 1964 TreeMapEntry<K,V> subHigher(K key) { return absHigher(key); } 1965 TreeMapEntry<K,V> subFloor(K key) { return absFloor(key); } 1966 TreeMapEntry<K,V> subLower(K key) { return absLower(key); } 1967 } 1968 1969 /** 1970 * @serial include 1971 */ 1972 static final class DescendingSubMap<K,V> extends NavigableSubMap<K,V> { 1973 private static final long serialVersionUID = 912986545866120460L; 1974 DescendingSubMap(TreeMap<K,V> m, 1975 boolean fromStart, K lo, boolean loInclusive, 1976 boolean toEnd, K hi, boolean hiInclusive) { 1977 super(m, fromStart, lo, loInclusive, toEnd, hi, hiInclusive); 1978 } 1979 1980 private final Comparator<? super K> reverseComparator = 1981 Collections.reverseOrder(m.comparator); 1982 1983 public Comparator<? super K> comparator() { 1984 return reverseComparator; 1985 } 1986 1987 public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, 1988 K toKey, boolean toInclusive) { 1989 if (!inRange(fromKey, fromInclusive)) 1990 throw new IllegalArgumentException("fromKey out of range"); 1991 if (!inRange(toKey, toInclusive)) 1992 throw new IllegalArgumentException("toKey out of range"); 1993 return new DescendingSubMap<>(m, 1994 false, toKey, toInclusive, 1995 false, fromKey, fromInclusive); 1996 } 1997 1998 public NavigableMap<K,V> headMap(K toKey, boolean inclusive) { 1999 /* Android-changed BEGIN 2000 Fix for edge cases 2001 if (!inRange(toKey, inclusive)) */ 2002 if (!inRange(toKey) && !(!fromStart && m.compare(toKey, lo) == 0 && 2003 !loInclusive && !inclusive)) 2004 /* Android-changed END */ 2005 throw new IllegalArgumentException("toKey out of range"); 2006 return new DescendingSubMap<>(m, 2007 false, toKey, inclusive, 2008 toEnd, hi, hiInclusive); 2009 } 2010 2011 public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) { 2012 /* Android-changed BEGIN 2013 Fix for edge cases 2014 if (!inRange(fromKey, inclusive)) */ 2015 if (!inRange(fromKey) && !(!toEnd && m.compare(fromKey, hi) == 0 && 2016 !hiInclusive && !inclusive)) 2017 /* Android-changed END */ 2018 throw new IllegalArgumentException("fromKey out of range"); 2019 return new DescendingSubMap<>(m, 2020 fromStart, lo, loInclusive, 2021 false, fromKey, inclusive); 2022 } 2023 2024 public NavigableMap<K,V> descendingMap() { 2025 NavigableMap<K,V> mv = descendingMapView; 2026 return (mv != null) ? mv : 2027 (descendingMapView = 2028 new AscendingSubMap<>(m, 2029 fromStart, lo, loInclusive, 2030 toEnd, hi, hiInclusive)); 2031 } 2032 2033 Iterator<K> keyIterator() { 2034 return new DescendingSubMapKeyIterator(absHighest(), absLowFence()); 2035 } 2036 2037 Spliterator<K> keySpliterator() { 2038 return new DescendingSubMapKeyIterator(absHighest(), absLowFence()); 2039 } 2040 2041 Iterator<K> descendingKeyIterator() { 2042 return new SubMapKeyIterator(absLowest(), absHighFence()); 2043 } 2044 2045 final class DescendingEntrySetView extends EntrySetView { 2046 public Iterator<Map.Entry<K,V>> iterator() { 2047 return new DescendingSubMapEntryIterator(absHighest(), absLowFence()); 2048 } 2049 } 2050 2051 public Set<Map.Entry<K,V>> entrySet() { 2052 EntrySetView es = entrySetView; 2053 return (es != null) ? es : (entrySetView = new DescendingEntrySetView()); 2054 } 2055 2056 TreeMapEntry<K,V> subLowest() { return absHighest(); } 2057 TreeMapEntry<K,V> subHighest() { return absLowest(); } 2058 TreeMapEntry<K,V> subCeiling(K key) { return absFloor(key); } 2059 TreeMapEntry<K,V> subHigher(K key) { return absLower(key); } 2060 TreeMapEntry<K,V> subFloor(K key) { return absCeiling(key); } 2061 TreeMapEntry<K,V> subLower(K key) { return absHigher(key); } 2062 } 2063 2064 /** 2065 * This class exists solely for the sake of serialization 2066 * compatibility with previous releases of TreeMap that did not 2067 * support NavigableMap. It translates an old-version SubMap into 2068 * a new-version AscendingSubMap. This class is never otherwise 2069 * used. 2070 * 2071 * @serial include 2072 */ 2073 private class SubMap extends AbstractMap<K,V> 2074 implements SortedMap<K,V>, java.io.Serializable { 2075 private static final long serialVersionUID = -6520786458950516097L; 2076 private boolean fromStart = false, toEnd = false; 2077 private K fromKey, toKey; 2078 private Object readResolve() { 2079 return new AscendingSubMap<>(TreeMap.this, 2080 fromStart, fromKey, true, 2081 toEnd, toKey, false); 2082 } 2083 public Set<Map.Entry<K,V>> entrySet() { throw new InternalError(); } 2084 public K lastKey() { throw new InternalError(); } 2085 public K firstKey() { throw new InternalError(); } 2086 public SortedMap<K,V> subMap(K fromKey, K toKey) { throw new InternalError(); } 2087 public SortedMap<K,V> headMap(K toKey) { throw new InternalError(); } 2088 public SortedMap<K,V> tailMap(K fromKey) { throw new InternalError(); } 2089 public Comparator<? super K> comparator() { throw new InternalError(); } 2090 } 2091 2092 2093 // Red-black mechanics 2094 2095 private static final boolean RED = false; 2096 private static final boolean BLACK = true; 2097 2098 /** 2099 * Node in the Tree. Doubles as a means to pass key-value pairs back to 2100 * user (see Map.Entry). 2101 */ 2102 /* 2103 * Android-changed BEGIN 2104 * TreeMapEntry should not be renamed, specifically it must not 2105 * be called "Entry" because that would hide Map.Entry and break 2106 * source compatibility with earlier versions of Android. 2107 * See LinkedHashMap$LinkedHashMapEntry for more details. 2108 * Android-changed END 2109 */ 2110 static final class TreeMapEntry<K,V> implements Map.Entry<K,V> { 2111 K key; 2112 V value; 2113 TreeMapEntry<K,V> left; 2114 TreeMapEntry<K,V> right; 2115 TreeMapEntry<K,V> parent; 2116 boolean color = BLACK; 2117 2118 /** 2119 * Make a new cell with given key, value, and parent, and with 2120 * {@code null} child links, and BLACK color. 2121 */ 2122 TreeMapEntry(K key, V value, TreeMapEntry<K,V> parent) { 2123 this.key = key; 2124 this.value = value; 2125 this.parent = parent; 2126 } 2127 2128 /** 2129 * Returns the key. 2130 * 2131 * @return the key 2132 */ 2133 public K getKey() { 2134 return key; 2135 } 2136 2137 /** 2138 * Returns the value associated with the key. 2139 * 2140 * @return the value associated with the key 2141 */ 2142 public V getValue() { 2143 return value; 2144 } 2145 2146 /** 2147 * Replaces the value currently associated with the key with the given 2148 * value. 2149 * 2150 * @return the value associated with the key before this method was 2151 * called 2152 */ 2153 public V setValue(V value) { 2154 V oldValue = this.value; 2155 this.value = value; 2156 return oldValue; 2157 } 2158 2159 public boolean equals(Object o) { 2160 if (!(o instanceof Map.Entry)) 2161 return false; 2162 Map.Entry<?,?> e = (Map.Entry<?,?>)o; 2163 2164 return valEquals(key,e.getKey()) && valEquals(value,e.getValue()); 2165 } 2166 2167 public int hashCode() { 2168 int keyHash = (key==null ? 0 : key.hashCode()); 2169 int valueHash = (value==null ? 0 : value.hashCode()); 2170 return keyHash ^ valueHash; 2171 } 2172 2173 public String toString() { 2174 return key + "=" + value; 2175 } 2176 } 2177 2178 /** 2179 * Returns the first Entry in the TreeMap (according to the TreeMap's 2180 * key-sort function). Returns null if the TreeMap is empty. 2181 */ 2182 final TreeMapEntry<K,V> getFirstEntry() { 2183 TreeMapEntry<K,V> p = root; 2184 if (p != null) 2185 while (p.left != null) 2186 p = p.left; 2187 return p; 2188 } 2189 2190 /** 2191 * Returns the last Entry in the TreeMap (according to the TreeMap's 2192 * key-sort function). Returns null if the TreeMap is empty. 2193 */ 2194 final TreeMapEntry<K,V> getLastEntry() { 2195 TreeMapEntry<K,V> p = root; 2196 if (p != null) 2197 while (p.right != null) 2198 p = p.right; 2199 return p; 2200 } 2201 2202 /** 2203 * Returns the successor of the specified Entry, or null if no such. 2204 */ 2205 static <K,V> TreeMapEntry<K,V> successor(TreeMapEntry<K,V> t) { 2206 if (t == null) 2207 return null; 2208 else if (t.right != null) { 2209 TreeMapEntry<K,V> p = t.right; 2210 while (p.left != null) 2211 p = p.left; 2212 return p; 2213 } else { 2214 TreeMapEntry<K,V> p = t.parent; 2215 TreeMapEntry<K,V> ch = t; 2216 while (p != null && ch == p.right) { 2217 ch = p; 2218 p = p.parent; 2219 } 2220 return p; 2221 } 2222 } 2223 2224 /** 2225 * Returns the predecessor of the specified Entry, or null if no such. 2226 */ 2227 static <K,V> TreeMapEntry<K,V> predecessor(TreeMapEntry<K,V> t) { 2228 if (t == null) 2229 return null; 2230 else if (t.left != null) { 2231 TreeMapEntry<K,V> p = t.left; 2232 while (p.right != null) 2233 p = p.right; 2234 return p; 2235 } else { 2236 TreeMapEntry<K,V> p = t.parent; 2237 TreeMapEntry<K,V> ch = t; 2238 while (p != null && ch == p.left) { 2239 ch = p; 2240 p = p.parent; 2241 } 2242 return p; 2243 } 2244 } 2245 2246 /** 2247 * Balancing operations. 2248 * 2249 * Implementations of rebalancings during insertion and deletion are 2250 * slightly different than the CLR version. Rather than using dummy 2251 * nilnodes, we use a set of accessors that deal properly with null. They 2252 * are used to avoid messiness surrounding nullness checks in the main 2253 * algorithms. 2254 */ 2255 2256 private static <K,V> boolean colorOf(TreeMapEntry<K,V> p) { 2257 return (p == null ? BLACK : p.color); 2258 } 2259 2260 private static <K,V> TreeMapEntry<K,V> parentOf(TreeMapEntry<K,V> p) { 2261 return (p == null ? null: p.parent); 2262 } 2263 2264 private static <K,V> void setColor(TreeMapEntry<K,V> p, boolean c) { 2265 if (p != null) 2266 p.color = c; 2267 } 2268 2269 private static <K,V> TreeMapEntry<K,V> leftOf(TreeMapEntry<K,V> p) { 2270 return (p == null) ? null: p.left; 2271 } 2272 2273 private static <K,V> TreeMapEntry<K,V> rightOf(TreeMapEntry<K,V> p) { 2274 return (p == null) ? null: p.right; 2275 } 2276 2277 /** From CLR */ 2278 private void rotateLeft(TreeMapEntry<K,V> p) { 2279 if (p != null) { 2280 TreeMapEntry<K,V> r = p.right; 2281 p.right = r.left; 2282 if (r.left != null) 2283 r.left.parent = p; 2284 r.parent = p.parent; 2285 if (p.parent == null) 2286 root = r; 2287 else if (p.parent.left == p) 2288 p.parent.left = r; 2289 else 2290 p.parent.right = r; 2291 r.left = p; 2292 p.parent = r; 2293 } 2294 } 2295 2296 /** From CLR */ 2297 private void rotateRight(TreeMapEntry<K,V> p) { 2298 if (p != null) { 2299 TreeMapEntry<K,V> l = p.left; 2300 p.left = l.right; 2301 if (l.right != null) l.right.parent = p; 2302 l.parent = p.parent; 2303 if (p.parent == null) 2304 root = l; 2305 else if (p.parent.right == p) 2306 p.parent.right = l; 2307 else p.parent.left = l; 2308 l.right = p; 2309 p.parent = l; 2310 } 2311 } 2312 2313 /** From CLR */ 2314 private void fixAfterInsertion(TreeMapEntry<K,V> x) { 2315 x.color = RED; 2316 2317 while (x != null && x != root && x.parent.color == RED) { 2318 if (parentOf(x) == leftOf(parentOf(parentOf(x)))) { 2319 TreeMapEntry<K,V> y = rightOf(parentOf(parentOf(x))); 2320 if (colorOf(y) == RED) { 2321 setColor(parentOf(x), BLACK); 2322 setColor(y, BLACK); 2323 setColor(parentOf(parentOf(x)), RED); 2324 x = parentOf(parentOf(x)); 2325 } else { 2326 if (x == rightOf(parentOf(x))) { 2327 x = parentOf(x); 2328 rotateLeft(x); 2329 } 2330 setColor(parentOf(x), BLACK); 2331 setColor(parentOf(parentOf(x)), RED); 2332 rotateRight(parentOf(parentOf(x))); 2333 } 2334 } else { 2335 TreeMapEntry<K,V> y = leftOf(parentOf(parentOf(x))); 2336 if (colorOf(y) == RED) { 2337 setColor(parentOf(x), BLACK); 2338 setColor(y, BLACK); 2339 setColor(parentOf(parentOf(x)), RED); 2340 x = parentOf(parentOf(x)); 2341 } else { 2342 if (x == leftOf(parentOf(x))) { 2343 x = parentOf(x); 2344 rotateRight(x); 2345 } 2346 setColor(parentOf(x), BLACK); 2347 setColor(parentOf(parentOf(x)), RED); 2348 rotateLeft(parentOf(parentOf(x))); 2349 } 2350 } 2351 } 2352 root.color = BLACK; 2353 } 2354 2355 /** 2356 * Delete node p, and then rebalance the tree. 2357 */ 2358 private void deleteEntry(TreeMapEntry<K,V> p) { 2359 modCount++; 2360 size--; 2361 2362 // If strictly internal, copy successor's element to p and then make p 2363 // point to successor. 2364 if (p.left != null && p.right != null) { 2365 TreeMapEntry<K,V> s = successor(p); 2366 p.key = s.key; 2367 p.value = s.value; 2368 p = s; 2369 } // p has 2 children 2370 2371 // Start fixup at replacement node, if it exists. 2372 TreeMapEntry<K,V> replacement = (p.left != null ? p.left : p.right); 2373 2374 if (replacement != null) { 2375 // Link replacement to parent 2376 replacement.parent = p.parent; 2377 if (p.parent == null) 2378 root = replacement; 2379 else if (p == p.parent.left) 2380 p.parent.left = replacement; 2381 else 2382 p.parent.right = replacement; 2383 2384 // Null out links so they are OK to use by fixAfterDeletion. 2385 p.left = p.right = p.parent = null; 2386 2387 // Fix replacement 2388 if (p.color == BLACK) 2389 fixAfterDeletion(replacement); 2390 } else if (p.parent == null) { // return if we are the only node. 2391 root = null; 2392 } else { // No children. Use self as phantom replacement and unlink. 2393 if (p.color == BLACK) 2394 fixAfterDeletion(p); 2395 2396 if (p.parent != null) { 2397 if (p == p.parent.left) 2398 p.parent.left = null; 2399 else if (p == p.parent.right) 2400 p.parent.right = null; 2401 p.parent = null; 2402 } 2403 } 2404 } 2405 2406 /** From CLR */ 2407 private void fixAfterDeletion(TreeMapEntry<K,V> x) { 2408 while (x != root && colorOf(x) == BLACK) { 2409 if (x == leftOf(parentOf(x))) { 2410 TreeMapEntry<K,V> sib = rightOf(parentOf(x)); 2411 2412 if (colorOf(sib) == RED) { 2413 setColor(sib, BLACK); 2414 setColor(parentOf(x), RED); 2415 rotateLeft(parentOf(x)); 2416 sib = rightOf(parentOf(x)); 2417 } 2418 2419 if (colorOf(leftOf(sib)) == BLACK && 2420 colorOf(rightOf(sib)) == BLACK) { 2421 setColor(sib, RED); 2422 x = parentOf(x); 2423 } else { 2424 if (colorOf(rightOf(sib)) == BLACK) { 2425 setColor(leftOf(sib), BLACK); 2426 setColor(sib, RED); 2427 rotateRight(sib); 2428 sib = rightOf(parentOf(x)); 2429 } 2430 setColor(sib, colorOf(parentOf(x))); 2431 setColor(parentOf(x), BLACK); 2432 setColor(rightOf(sib), BLACK); 2433 rotateLeft(parentOf(x)); 2434 x = root; 2435 } 2436 } else { // symmetric 2437 TreeMapEntry<K,V> sib = leftOf(parentOf(x)); 2438 2439 if (colorOf(sib) == RED) { 2440 setColor(sib, BLACK); 2441 setColor(parentOf(x), RED); 2442 rotateRight(parentOf(x)); 2443 sib = leftOf(parentOf(x)); 2444 } 2445 2446 if (colorOf(rightOf(sib)) == BLACK && 2447 colorOf(leftOf(sib)) == BLACK) { 2448 setColor(sib, RED); 2449 x = parentOf(x); 2450 } else { 2451 if (colorOf(leftOf(sib)) == BLACK) { 2452 setColor(rightOf(sib), BLACK); 2453 setColor(sib, RED); 2454 rotateLeft(sib); 2455 sib = leftOf(parentOf(x)); 2456 } 2457 setColor(sib, colorOf(parentOf(x))); 2458 setColor(parentOf(x), BLACK); 2459 setColor(leftOf(sib), BLACK); 2460 rotateRight(parentOf(x)); 2461 x = root; 2462 } 2463 } 2464 } 2465 2466 setColor(x, BLACK); 2467 } 2468 2469 private static final long serialVersionUID = 919286545866124006L; 2470 2471 /** 2472 * Save the state of the {@code TreeMap} instance to a stream (i.e., 2473 * serialize it). 2474 * 2475 * @serialData The <em>size</em> of the TreeMap (the number of key-value 2476 * mappings) is emitted (int), followed by the key (Object) 2477 * and value (Object) for each key-value mapping represented 2478 * by the TreeMap. The key-value mappings are emitted in 2479 * key-order (as determined by the TreeMap's Comparator, 2480 * or by the keys' natural ordering if the TreeMap has no 2481 * Comparator). 2482 */ 2483 private void writeObject(java.io.ObjectOutputStream s) 2484 throws java.io.IOException { 2485 // Write out the Comparator and any hidden stuff 2486 s.defaultWriteObject(); 2487 2488 // Write out size (number of Mappings) 2489 s.writeInt(size); 2490 2491 // Write out keys and values (alternating) 2492 for (Iterator<Map.Entry<K,V>> i = entrySet().iterator(); i.hasNext(); ) { 2493 Map.Entry<K,V> e = i.next(); 2494 s.writeObject(e.getKey()); 2495 s.writeObject(e.getValue()); 2496 } 2497 } 2498 2499 /** 2500 * Reconstitute the {@code TreeMap} instance from a stream (i.e., 2501 * deserialize it). 2502 */ 2503 private void readObject(final java.io.ObjectInputStream s) 2504 throws java.io.IOException, ClassNotFoundException { 2505 // Read in the Comparator and any hidden stuff 2506 s.defaultReadObject(); 2507 2508 // Read in size 2509 int size = s.readInt(); 2510 2511 buildFromSorted(size, null, s, null); 2512 } 2513 2514 /** Intended to be called only from TreeSet.readObject */ 2515 void readTreeSet(int size, java.io.ObjectInputStream s, V defaultVal) 2516 throws java.io.IOException, ClassNotFoundException { 2517 buildFromSorted(size, null, s, defaultVal); 2518 } 2519 2520 /** Intended to be called only from TreeSet.addAll */ 2521 void addAllForTreeSet(SortedSet<? extends K> set, V defaultVal) { 2522 try { 2523 buildFromSorted(set.size(), set.iterator(), null, defaultVal); 2524 } catch (java.io.IOException cannotHappen) { 2525 } catch (ClassNotFoundException cannotHappen) { 2526 } 2527 } 2528 2529 2530 /** 2531 * Linear time tree building algorithm from sorted data. Can accept keys 2532 * and/or values from iterator or stream. This leads to too many 2533 * parameters, but seems better than alternatives. The four formats 2534 * that this method accepts are: 2535 * 2536 * 1) An iterator of Map.Entries. (it != null, defaultVal == null). 2537 * 2) An iterator of keys. (it != null, defaultVal != null). 2538 * 3) A stream of alternating serialized keys and values. 2539 * (it == null, defaultVal == null). 2540 * 4) A stream of serialized keys. (it == null, defaultVal != null). 2541 * 2542 * It is assumed that the comparator of the TreeMap is already set prior 2543 * to calling this method. 2544 * 2545 * @param size the number of keys (or key-value pairs) to be read from 2546 * the iterator or stream 2547 * @param it If non-null, new entries are created from entries 2548 * or keys read from this iterator. 2549 * @param str If non-null, new entries are created from keys and 2550 * possibly values read from this stream in serialized form. 2551 * Exactly one of it and str should be non-null. 2552 * @param defaultVal if non-null, this default value is used for 2553 * each value in the map. If null, each value is read from 2554 * iterator or stream, as described above. 2555 * @throws java.io.IOException propagated from stream reads. This cannot 2556 * occur if str is null. 2557 * @throws ClassNotFoundException propagated from readObject. 2558 * This cannot occur if str is null. 2559 */ 2560 private void buildFromSorted(int size, Iterator<?> it, 2561 java.io.ObjectInputStream str, 2562 V defaultVal) 2563 throws java.io.IOException, ClassNotFoundException { 2564 this.size = size; 2565 root = buildFromSorted(0, 0, size-1, computeRedLevel(size), 2566 it, str, defaultVal); 2567 } 2568 2569 /** 2570 * Recursive "helper method" that does the real work of the 2571 * previous method. Identically named parameters have 2572 * identical definitions. Additional parameters are documented below. 2573 * It is assumed that the comparator and size fields of the TreeMap are 2574 * already set prior to calling this method. (It ignores both fields.) 2575 * 2576 * @param level the current level of tree. Initial call should be 0. 2577 * @param lo the first element index of this subtree. Initial should be 0. 2578 * @param hi the last element index of this subtree. Initial should be 2579 * size-1. 2580 * @param redLevel the level at which nodes should be red. 2581 * Must be equal to computeRedLevel for tree of this size. 2582 */ 2583 @SuppressWarnings("unchecked") 2584 private final TreeMapEntry<K,V> buildFromSorted(int level, int lo, int hi, 2585 int redLevel, 2586 Iterator<?> it, 2587 java.io.ObjectInputStream str, 2588 V defaultVal) 2589 throws java.io.IOException, ClassNotFoundException { 2590 /* 2591 * Strategy: The root is the middlemost element. To get to it, we 2592 * have to first recursively construct the entire left subtree, 2593 * so as to grab all of its elements. We can then proceed with right 2594 * subtree. 2595 * 2596 * The lo and hi arguments are the minimum and maximum 2597 * indices to pull out of the iterator or stream for current subtree. 2598 * They are not actually indexed, we just proceed sequentially, 2599 * ensuring that items are extracted in corresponding order. 2600 */ 2601 2602 if (hi < lo) return null; 2603 2604 int mid = (lo + hi) >>> 1; 2605 2606 TreeMapEntry<K,V> left = null; 2607 if (lo < mid) 2608 left = buildFromSorted(level+1, lo, mid - 1, redLevel, 2609 it, str, defaultVal); 2610 2611 // extract key and/or value from iterator or stream 2612 K key; 2613 V value; 2614 if (it != null) { 2615 if (defaultVal==null) { 2616 Map.Entry<?,?> entry = (Map.Entry<?,?>)it.next(); 2617 key = (K)entry.getKey(); 2618 value = (V)entry.getValue(); 2619 } else { 2620 key = (K)it.next(); 2621 value = defaultVal; 2622 } 2623 } else { // use stream 2624 key = (K) str.readObject(); 2625 value = (defaultVal != null ? defaultVal : (V) str.readObject()); 2626 } 2627 2628 TreeMapEntry<K,V> middle = new TreeMapEntry<>(key, value, null); 2629 2630 // color nodes in non-full bottommost level red 2631 if (level == redLevel) 2632 middle.color = RED; 2633 2634 if (left != null) { 2635 middle.left = left; 2636 left.parent = middle; 2637 } 2638 2639 if (mid < hi) { 2640 TreeMapEntry<K,V> right = buildFromSorted(level+1, mid+1, hi, redLevel, 2641 it, str, defaultVal); 2642 middle.right = right; 2643 right.parent = middle; 2644 } 2645 2646 return middle; 2647 } 2648 2649 /** 2650 * Find the level down to which to assign all nodes BLACK. This is the 2651 * last `full' level of the complete binary tree produced by 2652 * buildTree. The remaining nodes are colored RED. (This makes a `nice' 2653 * set of color assignments wrt future insertions.) This level number is 2654 * computed by finding the number of splits needed to reach the zeroeth 2655 * node. (The answer is ~lg(N), but in any case must be computed by same 2656 * quick O(lg(N)) loop.) 2657 */ 2658 private static int computeRedLevel(int sz) { 2659 int level = 0; 2660 for (int m = sz - 1; m >= 0; m = m / 2 - 1) 2661 level++; 2662 return level; 2663 } 2664 2665 /** 2666 * Currently, we support Spliterator-based versions only for the 2667 * full map, in either plain of descending form, otherwise relying 2668 * on defaults because size estimation for submaps would dominate 2669 * costs. The type tests needed to check these for key views are 2670 * not very nice but avoid disrupting existing class 2671 * structures. Callers must use plain default spliterators if this 2672 * returns null. 2673 */ 2674 static <K> Spliterator<K> keySpliteratorFor(NavigableMap<K,?> m) { 2675 if (m instanceof TreeMap) { 2676 @SuppressWarnings("unchecked") TreeMap<K,Object> t = 2677 (TreeMap<K,Object>) m; 2678 return t.keySpliterator(); 2679 } 2680 if (m instanceof DescendingSubMap) { 2681 @SuppressWarnings("unchecked") DescendingSubMap<K,?> dm = 2682 (DescendingSubMap<K,?>) m; 2683 TreeMap<K,?> tm = dm.m; 2684 if (dm == tm.descendingMap) { 2685 @SuppressWarnings("unchecked") TreeMap<K,Object> t = 2686 (TreeMap<K,Object>) tm; 2687 return t.descendingKeySpliterator(); 2688 } 2689 } 2690 @SuppressWarnings("unchecked") NavigableSubMap<K,?> sm = 2691 (NavigableSubMap<K,?>) m; 2692 return sm.keySpliterator(); 2693 } 2694 2695 final Spliterator<K> keySpliterator() { 2696 return new KeySpliterator<K,V>(this, null, null, 0, -1, 0); 2697 } 2698 2699 final Spliterator<K> descendingKeySpliterator() { 2700 return new DescendingKeySpliterator<K,V>(this, null, null, 0, -2, 0); 2701 } 2702 2703 /** 2704 * Base class for spliterators. Iteration starts at a given 2705 * origin and continues up to but not including a given fence (or 2706 * null for end). At top-level, for ascending cases, the first 2707 * split uses the root as left-fence/right-origin. From there, 2708 * right-hand splits replace the current fence with its left 2709 * child, also serving as origin for the split-off spliterator. 2710 * Left-hands are symmetric. Descending versions place the origin 2711 * at the end and invert ascending split rules. This base class 2712 * is non-commital about directionality, or whether the top-level 2713 * spliterator covers the whole tree. This means that the actual 2714 * split mechanics are located in subclasses. Some of the subclass 2715 * trySplit methods are identical (except for return types), but 2716 * not nicely factorable. 2717 * 2718 * Currently, subclass versions exist only for the full map 2719 * (including descending keys via its descendingMap). Others are 2720 * possible but currently not worthwhile because submaps require 2721 * O(n) computations to determine size, which substantially limits 2722 * potential speed-ups of using custom Spliterators versus default 2723 * mechanics. 2724 * 2725 * To boostrap initialization, external constructors use 2726 * negative size estimates: -1 for ascend, -2 for descend. 2727 */ 2728 static class TreeMapSpliterator<K,V> { 2729 final TreeMap<K,V> tree; 2730 TreeMapEntry<K,V> current; // traverser; initially first node in range 2731 TreeMapEntry<K,V> fence; // one past last, or null 2732 int side; // 0: top, -1: is a left split, +1: right 2733 int est; // size estimate (exact only for top-level) 2734 int expectedModCount; // for CME checks 2735 2736 TreeMapSpliterator(TreeMap<K,V> tree, 2737 TreeMapEntry<K,V> origin, TreeMapEntry<K,V> fence, 2738 int side, int est, int expectedModCount) { 2739 this.tree = tree; 2740 this.current = origin; 2741 this.fence = fence; 2742 this.side = side; 2743 this.est = est; 2744 this.expectedModCount = expectedModCount; 2745 } 2746 2747 final int getEstimate() { // force initialization 2748 int s; TreeMap<K,V> t; 2749 if ((s = est) < 0) { 2750 if ((t = tree) != null) { 2751 current = (s == -1) ? t.getFirstEntry() : t.getLastEntry(); 2752 s = est = t.size; 2753 expectedModCount = t.modCount; 2754 } 2755 else 2756 s = est = 0; 2757 } 2758 return s; 2759 } 2760 2761 public final long estimateSize() { 2762 return (long)getEstimate(); 2763 } 2764 } 2765 2766 static final class KeySpliterator<K,V> 2767 extends TreeMapSpliterator<K,V> 2768 implements Spliterator<K> { 2769 KeySpliterator(TreeMap<K,V> tree, 2770 TreeMapEntry<K,V> origin, TreeMapEntry<K,V> fence, 2771 int side, int est, int expectedModCount) { 2772 super(tree, origin, fence, side, est, expectedModCount); 2773 } 2774 2775 public KeySpliterator<K,V> trySplit() { 2776 if (est < 0) 2777 getEstimate(); // force initialization 2778 int d = side; 2779 TreeMapEntry<K,V> e = current, f = fence, 2780 s = ((e == null || e == f) ? null : // empty 2781 (d == 0) ? tree.root : // was top 2782 (d > 0) ? e.right : // was right 2783 (d < 0 && f != null) ? f.left : // was left 2784 null); 2785 if (s != null && s != e && s != f && 2786 tree.compare(e.key, s.key) < 0) { // e not already past s 2787 side = 1; 2788 return new KeySpliterator<> 2789 (tree, e, current = s, -1, est >>>= 1, expectedModCount); 2790 } 2791 return null; 2792 } 2793 2794 public void forEachRemaining(Consumer<? super K> action) { 2795 if (action == null) 2796 throw new NullPointerException(); 2797 if (est < 0) 2798 getEstimate(); // force initialization 2799 TreeMapEntry<K,V> f = fence, e, p, pl; 2800 if ((e = current) != null && e != f) { 2801 current = f; // exhaust 2802 do { 2803 action.accept(e.key); 2804 if ((p = e.right) != null) { 2805 while ((pl = p.left) != null) 2806 p = pl; 2807 } 2808 else { 2809 while ((p = e.parent) != null && e == p.right) 2810 e = p; 2811 } 2812 } while ((e = p) != null && e != f); 2813 if (tree.modCount != expectedModCount) 2814 throw new ConcurrentModificationException(); 2815 } 2816 } 2817 2818 public boolean tryAdvance(Consumer<? super K> action) { 2819 TreeMapEntry<K,V> e; 2820 if (action == null) 2821 throw new NullPointerException(); 2822 if (est < 0) 2823 getEstimate(); // force initialization 2824 if ((e = current) == null || e == fence) 2825 return false; 2826 current = successor(e); 2827 action.accept(e.key); 2828 if (tree.modCount != expectedModCount) 2829 throw new ConcurrentModificationException(); 2830 return true; 2831 } 2832 2833 public int characteristics() { 2834 return (side == 0 ? Spliterator.SIZED : 0) | 2835 Spliterator.DISTINCT | Spliterator.SORTED | Spliterator.ORDERED; 2836 } 2837 2838 public final Comparator<? super K> getComparator() { 2839 return tree.comparator; 2840 } 2841 2842 } 2843 2844 static final class DescendingKeySpliterator<K,V> 2845 extends TreeMapSpliterator<K,V> 2846 implements Spliterator<K> { 2847 DescendingKeySpliterator(TreeMap<K,V> tree, 2848 TreeMapEntry<K,V> origin, TreeMapEntry<K,V> fence, 2849 int side, int est, int expectedModCount) { 2850 super(tree, origin, fence, side, est, expectedModCount); 2851 } 2852 2853 public DescendingKeySpliterator<K,V> trySplit() { 2854 if (est < 0) 2855 getEstimate(); // force initialization 2856 int d = side; 2857 TreeMapEntry<K,V> e = current, f = fence, 2858 s = ((e == null || e == f) ? null : // empty 2859 (d == 0) ? tree.root : // was top 2860 (d < 0) ? e.left : // was left 2861 (d > 0 && f != null) ? f.right : // was right 2862 null); 2863 if (s != null && s != e && s != f && 2864 tree.compare(e.key, s.key) > 0) { // e not already past s 2865 side = 1; 2866 return new DescendingKeySpliterator<> 2867 (tree, e, current = s, -1, est >>>= 1, expectedModCount); 2868 } 2869 return null; 2870 } 2871 2872 public void forEachRemaining(Consumer<? super K> action) { 2873 if (action == null) 2874 throw new NullPointerException(); 2875 if (est < 0) 2876 getEstimate(); // force initialization 2877 TreeMapEntry<K,V> f = fence, e, p, pr; 2878 if ((e = current) != null && e != f) { 2879 current = f; // exhaust 2880 do { 2881 action.accept(e.key); 2882 if ((p = e.left) != null) { 2883 while ((pr = p.right) != null) 2884 p = pr; 2885 } 2886 else { 2887 while ((p = e.parent) != null && e == p.left) 2888 e = p; 2889 } 2890 } while ((e = p) != null && e != f); 2891 if (tree.modCount != expectedModCount) 2892 throw new ConcurrentModificationException(); 2893 } 2894 } 2895 2896 public boolean tryAdvance(Consumer<? super K> action) { 2897 TreeMapEntry<K,V> e; 2898 if (action == null) 2899 throw new NullPointerException(); 2900 if (est < 0) 2901 getEstimate(); // force initialization 2902 if ((e = current) == null || e == fence) 2903 return false; 2904 current = predecessor(e); 2905 action.accept(e.key); 2906 if (tree.modCount != expectedModCount) 2907 throw new ConcurrentModificationException(); 2908 return true; 2909 } 2910 2911 public int characteristics() { 2912 return (side == 0 ? Spliterator.SIZED : 0) | 2913 Spliterator.DISTINCT | Spliterator.ORDERED; 2914 } 2915 } 2916 2917 static final class ValueSpliterator<K,V> 2918 extends TreeMapSpliterator<K,V> 2919 implements Spliterator<V> { 2920 ValueSpliterator(TreeMap<K,V> tree, 2921 TreeMapEntry<K,V> origin, TreeMapEntry<K,V> fence, 2922 int side, int est, int expectedModCount) { 2923 super(tree, origin, fence, side, est, expectedModCount); 2924 } 2925 2926 public ValueSpliterator<K,V> trySplit() { 2927 if (est < 0) 2928 getEstimate(); // force initialization 2929 int d = side; 2930 TreeMapEntry<K,V> e = current, f = fence, 2931 s = ((e == null || e == f) ? null : // empty 2932 (d == 0) ? tree.root : // was top 2933 (d > 0) ? e.right : // was right 2934 (d < 0 && f != null) ? f.left : // was left 2935 null); 2936 if (s != null && s != e && s != f && 2937 tree.compare(e.key, s.key) < 0) { // e not already past s 2938 side = 1; 2939 return new ValueSpliterator<> 2940 (tree, e, current = s, -1, est >>>= 1, expectedModCount); 2941 } 2942 return null; 2943 } 2944 2945 public void forEachRemaining(Consumer<? super V> action) { 2946 if (action == null) 2947 throw new NullPointerException(); 2948 if (est < 0) 2949 getEstimate(); // force initialization 2950 TreeMapEntry<K,V> f = fence, e, p, pl; 2951 if ((e = current) != null && e != f) { 2952 current = f; // exhaust 2953 do { 2954 action.accept(e.value); 2955 if ((p = e.right) != null) { 2956 while ((pl = p.left) != null) 2957 p = pl; 2958 } 2959 else { 2960 while ((p = e.parent) != null && e == p.right) 2961 e = p; 2962 } 2963 } while ((e = p) != null && e != f); 2964 if (tree.modCount != expectedModCount) 2965 throw new ConcurrentModificationException(); 2966 } 2967 } 2968 2969 public boolean tryAdvance(Consumer<? super V> action) { 2970 TreeMapEntry<K,V> e; 2971 if (action == null) 2972 throw new NullPointerException(); 2973 if (est < 0) 2974 getEstimate(); // force initialization 2975 if ((e = current) == null || e == fence) 2976 return false; 2977 current = successor(e); 2978 action.accept(e.value); 2979 if (tree.modCount != expectedModCount) 2980 throw new ConcurrentModificationException(); 2981 return true; 2982 } 2983 2984 public int characteristics() { 2985 return (side == 0 ? Spliterator.SIZED : 0) | Spliterator.ORDERED; 2986 } 2987 } 2988 2989 static final class EntrySpliterator<K,V> 2990 extends TreeMapSpliterator<K,V> 2991 implements Spliterator<Map.Entry<K,V>> { 2992 EntrySpliterator(TreeMap<K,V> tree, 2993 TreeMapEntry<K,V> origin, TreeMapEntry<K,V> fence, 2994 int side, int est, int expectedModCount) { 2995 super(tree, origin, fence, side, est, expectedModCount); 2996 } 2997 2998 public EntrySpliterator<K,V> trySplit() { 2999 if (est < 0) 3000 getEstimate(); // force initialization 3001 int d = side; 3002 TreeMapEntry<K,V> e = current, f = fence, 3003 s = ((e == null || e == f) ? null : // empty 3004 (d == 0) ? tree.root : // was top 3005 (d > 0) ? e.right : // was right 3006 (d < 0 && f != null) ? f.left : // was left 3007 null); 3008 if (s != null && s != e && s != f && 3009 tree.compare(e.key, s.key) < 0) { // e not already past s 3010 side = 1; 3011 return new EntrySpliterator<> 3012 (tree, e, current = s, -1, est >>>= 1, expectedModCount); 3013 } 3014 return null; 3015 } 3016 3017 public void forEachRemaining(Consumer<? super Map.Entry<K, V>> action) { 3018 if (action == null) 3019 throw new NullPointerException(); 3020 if (est < 0) 3021 getEstimate(); // force initialization 3022 TreeMapEntry<K,V> f = fence, e, p, pl; 3023 if ((e = current) != null && e != f) { 3024 current = f; // exhaust 3025 do { 3026 action.accept(e); 3027 if ((p = e.right) != null) { 3028 while ((pl = p.left) != null) 3029 p = pl; 3030 } 3031 else { 3032 while ((p = e.parent) != null && e == p.right) 3033 e = p; 3034 } 3035 } while ((e = p) != null && e != f); 3036 if (tree.modCount != expectedModCount) 3037 throw new ConcurrentModificationException(); 3038 } 3039 } 3040 3041 public boolean tryAdvance(Consumer<? super Map.Entry<K,V>> action) { 3042 TreeMapEntry<K,V> e; 3043 if (action == null) 3044 throw new NullPointerException(); 3045 if (est < 0) 3046 getEstimate(); // force initialization 3047 if ((e = current) == null || e == fence) 3048 return false; 3049 current = successor(e); 3050 action.accept(e); 3051 if (tree.modCount != expectedModCount) 3052 throw new ConcurrentModificationException(); 3053 return true; 3054 } 3055 3056 public int characteristics() { 3057 return (side == 0 ? Spliterator.SIZED : 0) | 3058 Spliterator.DISTINCT | Spliterator.SORTED | Spliterator.ORDERED; 3059 } 3060 3061 @Override 3062 public Comparator<Map.Entry<K, V>> getComparator() { 3063 // Adapt or create a key-based comparator 3064 if (tree.comparator != null) { 3065 return Map.Entry.comparingByKey(tree.comparator); 3066 } 3067 else { 3068 return (Comparator<Map.Entry<K, V>> & Serializable) (e1, e2) -> { 3069 @SuppressWarnings("unchecked") 3070 Comparable<? super K> k1 = (Comparable<? super K>) e1.getKey(); 3071 return k1.compareTo(e2.getKey()); 3072 }; 3073 } 3074 } 3075 } 3076} 3077