Class: java.util.TreeMap<K, V>

A Red-Black tree based java.util.NavigableMap implementation. The map is sorted according to the natural ordering of its keys, or by a java.util.Comparator provided at map creation time, depending on which constructor is used.

This implementation provides guaranteed log(n) time cost for the containsKey, get, put and remove operations. Algorithms are adaptations of those in Cormen, Leiserson, and Rivest's Introduction to Algorithms.

Note that the ordering maintained by a sorted map (whether or not an explicit comparator is provided) must be consistent with equals if this sorted map is to correctly implement the Map interface. (See Comparable or Comparator for a precise definition of consistent with equals.) This is so because the Map interface is defined in terms of the equals operation, but a map performs all key comparisons using its compareTo (or compare) method, so two keys that are deemed equal by this method are, from the standpoint of the sorted map, equal. The behavior of a sorted map is well-defined even if its ordering is inconsistent with equals; it just fails to obey the general contract of the Map interface.

Note that this implementation is not synchronized. If multiple threads access a map concurrently, and at least one of the threads modifies the map structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more mappings; merely changing the value associated with an existing key is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the map. If no such object exists, the map should be "wrapped" using the Collections.synchronizedSortedMap method. This is best done at creation time, to prevent accidental unsynchronized access to the map: 

   SortedMap m = Collections.synchronizedSortedMap(new TreeMap(...));

The iterators returned by the iterator method of the collections returned by all of this class's "collection view methods" are fail-fast: if the map is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove method, the iterator will throw a java.util.ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

All Map.Entry pairs returned by methods in this class and its views represent snapshots of mappings at the time they were produced. They do not support the Entry.setValue method. (Note however that it is possible to change mappings in the associated map using put.)

This class is a member of the Java Collections Framework.

Authors:
@author Josh Bloch and Doug Lea
Parameters:
@param <K> the type of keys maintained by this map
@param <V> the type of mapped values
See:
@see java.util.Map
@see java.util.HashMap
@see java.util.Hashtable
@see Comparable
@see java.util.Comparator
@see java.util.Collection
Since:
@since 1.2

Inheritance

Superclass tree: Implements:

Methods

  • TreeMaptop

    public TreeMap()
    Constructs a new, empty tree map, using the natural ordering of its keys. All keys inserted into the map must implement the Comparable interface. Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) must not throw a ClassCastException for any keys k1 and k2 in the map. If the user attempts to put a key into the map that violates this constraint (for example, the user attempts to put a string key into a map whose keys are integers), the put(Object key, Object value) call will throw a ClassCastException.
    Related Links:
    Google Code Search
    Stack Overflow

  • TreeMaptop

    public TreeMap(Comparator<? super K> comparator)
    Constructs a new, empty tree map, ordered according to the given comparator. All keys inserted into the map must be mutually comparable by the given comparator: comparator.compare(k1, k2) must not throw a ClassCastException for any keys k1 and k2 in the map. If the user attempts to put a key into the map that violates this constraint, the put(Object key, Object value) call will throw a ClassCastException.
    Parameters:
    @param comparator the comparator that will be used to order this map. If null, the natural ordering of the keys will be used.
    Related Links:
    Google Code Search
    Stack Overflow

  • TreeMaptop

    public TreeMap(Map<? extends K, ? extends V> m)
    Constructs a new tree map containing the same mappings as the given map, ordered according to the natural ordering of its keys. All keys inserted into the new map must implement the Comparable interface. Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) must not throw a ClassCastException for any keys k1 and k2 in the map. This method runs in n*log(n) time.
    Parameters:
    @param m the map whose mappings are to be placed in this map
    Exceptions:
    @throws ClassCastException if the keys in m are not Comparable , or are not mutually comparable
    @throws NullPointerException if the specified map is null
    Related Links:
    Google Code Search
    Stack Overflow

  • TreeMaptop

    public TreeMap(SortedMap<K, ? extends V> m)
    Constructs a new tree map containing the same mappings and using the same ordering as the specified sorted map. This method runs in linear time.
    Parameters:
    @param m the sorted map whose mappings are to be placed in this map, and whose comparator is to be used to sort this map
    Exceptions:
    @throws NullPointerException if the specified map is null
    Related Links:
    Google Code Search
    Stack Overflow

  • addAllForTreeSettop

    void addAllForTreeSet(SortedSet<? extends K> set, V defaultVal)
    Intended to be called only from TreeSet.addAll
    Related Links:
    Google Code Search
    Stack Overflow

  • buildFromSortedtop

    final private TreeMap.Entry<K, V> buildFromSorted(int level, int lo, int hi, int redLevel, Iterator it, ObjectInputStream str, V defaultVal) throws IOException, ClassNotFoundException
    Recursive "helper method" that does the real work of the previous method. Identically named parameters have identical definitions. Additional parameters are documented below. It is assumed that the comparator and size fields of the TreeMap are already set prior to calling this method. (It ignores both fields.)
    Parameters:
    @param level the current level of tree. Initial call should be 0.
    @param lo the first element index of this subtree. Initial should be 0.
    @param hi the last element index of this subtree. Initial should be size-1.
    @param redLevel the level at which nodes should be red. Must be equal to computeRedLevel for tree of this size.
    Related Links:
    Google Code Search
    Stack Overflow

  • buildFromSortedtop

    private void buildFromSorted(int size, Iterator it, ObjectInputStream str, V defaultVal) throws IOException, ClassNotFoundException
    Linear time tree building algorithm from sorted data. Can accept keys and/or values from iterator or stream. This leads to too many parameters, but seems better than alternatives. The four formats that this method accepts are: 1) An iterator of Map.Entries. (it != null, defaultVal == null). 2) An iterator of keys. (it != null, defaultVal != null). 3) A stream of alternating serialized keys and values. (it == null, defaultVal == null). 4) A stream of serialized keys. (it == null, defaultVal != null). It is assumed that the comparator of the TreeMap is already set prior to calling this method.
    Parameters:
    @param size the number of keys (or key-value pairs) to be read from the iterator or stream
    @param it If non-null, new entries are created from entries or keys read from this iterator.
    @param str If non-null, new entries are created from keys and possibly values read from this stream in serialized form. Exactly one of it and str should be non-null.
    @param defaultVal if non-null, this default value is used for each value in the map. If null, each value is read from iterator or stream, as described above.
    Exceptions:
    @throws IOException propagated from stream reads. This cannot occur if str is null.
    @throws ClassNotFoundException propagated from readObject. This cannot occur if str is null.
    Related Links:
    Google Code Search
    Stack Overflow

  • ceilingEntrytop

    public Map.Entry<K, V> ceilingEntry(K key)
    Returns a key-value mapping associated with the least key greater than or equal to the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return an entry with the least key greater than or equal to key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    ceilingEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • ceilingKeytop

    public K ceilingKey(K key)
    Returns the least key greater than or equal to the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return the least key greater than or equal to key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    ceilingKey from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • cleartop

    public void clear()
    Removes all of the mappings from this map. The map will be empty after this call returns.
    Specified by:
    clear from Map<K, V>
    Override hierarchy:
    clear from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • clonetop

    public Object clone()
    Returns a shallow copy of this TreeMap instance. (The keys and values themselves are not cloned.)
    Return:
    @return a shallow copy of this map
    Override hierarchy:
    clone from AbstractMap<K, V>
    clone from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • colorOftop

    static private <K, V> boolean colorOf(TreeMap.Entry<K, V> p)
    Balancing operations. Implementations of rebalancings during insertion and deletion are slightly different than the CLR version. Rather than using dummy nilnodes, we use a set of accessors that deal properly with null. They are used to avoid messiness surrounding nullness checks in the main algorithms.
    Related Links:
    Google Code Search
    Stack Overflow

  • comparatortop

    public Comparator<? super K> comparator()
    Returns the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys.
    Return:
    @return the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys
    Specified by:
    comparator from SortedMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • comparetop

    final int compare(Object k1, Object k2)
    Compares two keys using the correct comparison method for this TreeMap.
    Related Links:
    Google Code Search
    Stack Overflow

  • computeRedLeveltop

    static private int computeRedLevel(int sz)
    Find the level down to which to assign all nodes BLACK. This is the last `full' level of the complete binary tree produced by buildTree. The remaining nodes are colored RED. (This makes a `nice' set of color assignments wrt future insertions.) This level number is computed by finding the number of splits needed to reach the zeroeth node. (The answer is ~lg(N), but in any case must be computed by same quick O(lg(N)) loop.)
    Related Links:
    Google Code Search
    Stack Overflow

  • containsKeytop

    public boolean containsKey(Object key)
    Returns true if this map contains a mapping for the specified key.
    Parameters:
    @param key key whose presence in this map is to be tested
    Return:
    @return true if this map contains a mapping for the specified key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Specified by:
    containsKey from Map<K, V>
    Override hierarchy:
    containsKey from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • containsValuetop

    public boolean containsValue(Object value)
    Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations.
    Parameters:
    @param value value whose presence in this map is to be tested
    Return:
    @return true if a mapping to value exists; false otherwise
    Since:
    @since 1.2
    Specified by:
    containsValue from Map<K, V>
    Override hierarchy:
    containsValue from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • deleteEntrytop

    private void deleteEntry(TreeMap.Entry<K, V> p)
    Delete node p, and then rebalance the tree.
    Related Links:
    Google Code Search
    Stack Overflow

  • descendingKeyIteratortop

    Iterator<K> descendingKeyIterator()
    Related Links:
    Google Code Search
    Stack Overflow

  • descendingKeySettop

    public NavigableSet<K> descendingKeySet()
    Returns a reverse order java.util.NavigableSet view of the keys contained in this map. The set's iterator returns the keys in descending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    Return:
    @return a reverse order navigable set view of the keys in this map
    Since:
    @since 1.6
    Specified by:
    descendingKeySet from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • descendingMaptop

    public NavigableMap<K, V> descendingMap()
    Returns a reverse order view of the mappings contained in this map. The descending map is backed by this map, so changes to the map are reflected in the descending map, and vice-versa. If either map is modified while an iteration over a collection view of either map is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

    The returned map has an ordering equivalent to Collections.reverseOrder(comparator()). The expression m.descendingMap().descendingMap() returns a view of m essentially equivalent to m.

    Return:
    @return a reverse order view of this map
    Since:
    @since 1.6
    Specified by:
    descendingMap from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • entrySettop

    public Set<Map.Entry<K, V>> entrySet()
    Returns a java.util.Set view of the mappings contained in this map. The set's iterator returns the entries in ascending key order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    Return:
    @return a set view of the mappings contained in this map, sorted in ascending key order
    Specified by:
    entrySet from SortedMap<K, V>
    entrySet from Map<K, V>
    Override hierarchy:
    entrySet from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • exportEntrytop

    static <K, V> Map.Entry<K, V> exportEntry(TreeMap.Entry<K, V> e)
    Return SimpleImmutableEntry for entry, or null if null
    Related Links:
    Google Code Search
    Stack Overflow

  • firstEntrytop

    public Map.Entry<K, V> firstEntry()
    Returns a key-value mapping associated with the least key in this map, or null if the map is empty.
    Return:
    @return an entry with the least key, or null if this map is empty
    Since:
    @since 1.6
    Specified by:
    firstEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • firstKeytop

    public K firstKey()
    Returns the first (lowest) key currently in this map.
    Return:
    @return the first (lowest) key currently in this map
    Exceptions:
    @throws NoSuchElementException if this map is empty
    Specified by:
    firstKey from SortedMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • fixAfterDeletiontop

    private void fixAfterDeletion(TreeMap.Entry<K, V> x)
    From CLR
    Related Links:
    Google Code Search
    Stack Overflow

  • fixAfterInsertiontop

    private void fixAfterInsertion(TreeMap.Entry<K, V> x)
    From CLR
    Related Links:
    Google Code Search
    Stack Overflow

  • floorEntrytop

    public Map.Entry<K, V> floorEntry(K key)
    Returns a key-value mapping associated with the greatest key less than or equal to the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return an entry with the greatest key less than or equal to key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    floorEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • floorKeytop

    public K floorKey(K key)
    Returns the greatest key less than or equal to the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return the greatest key less than or equal to key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    floorKey from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • gettop

    public V get(Object key)
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

    More formally, if this map contains a mapping from a key k to a value v such that key compares equal to k according to the map's ordering, then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

    A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

    Parameters:
    @param key the key whose associated value is to be returned
    Return:
    @return the value to which the specified key is mapped, or null if this map contains no mapping for the key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Specified by:
    get from Map<K, V>
    Override hierarchy:
    get from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • getCeilingEntrytop

    final TreeMap.Entry<K, V> getCeilingEntry(K key)
    Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists (i.e., the greatest key in the Tree is less than the specified key), returns null.
    Related Links:
    Google Code Search
    Stack Overflow

  • getEntrytop

    final TreeMap.Entry<K, V> getEntry(Object key)
    Returns this map's entry for the given key, or null if the map does not contain an entry for the key.
    Return:
    @return this map's entry for the given key, or null if the map does not contain an entry for the key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Related Links:
    Google Code Search
    Stack Overflow

  • getEntryUsingComparatortop

    final TreeMap.Entry<K, V> getEntryUsingComparator(Object key)
    Version of getEntry using comparator. Split off from getEntry for performance. (This is not worth doing for most methods, that are less dependent on comparator performance, but is worthwhile here.)
    Related Links:
    Google Code Search
    Stack Overflow

  • getFirstEntrytop

    final TreeMap.Entry<K, V> getFirstEntry()
    Returns the first Entry in the TreeMap (according to the TreeMap's key-sort function). Returns null if the TreeMap is empty.
    Related Links:
    Google Code Search
    Stack Overflow

  • getFloorEntrytop

    final TreeMap.Entry<K, V> getFloorEntry(K key)
    Gets the entry corresponding to the specified key; if no such entry exists, returns the entry for the greatest key less than the specified key; if no such entry exists, returns null.
    Related Links:
    Google Code Search
    Stack Overflow

  • getHigherEntrytop

    final TreeMap.Entry<K, V> getHigherEntry(K key)
    Gets the entry for the least key greater than the specified key; if no such entry exists, returns the entry for the least key greater than the specified key; if no such entry exists returns null.
    Related Links:
    Google Code Search
    Stack Overflow

  • getLastEntrytop

    final TreeMap.Entry<K, V> getLastEntry()
    Returns the last Entry in the TreeMap (according to the TreeMap's key-sort function). Returns null if the TreeMap is empty.
    Related Links:
    Google Code Search
    Stack Overflow

  • getLowerEntrytop

    final TreeMap.Entry<K, V> getLowerEntry(K key)
    Returns the entry for the greatest key less than the specified key; if no such entry exists (i.e., the least key in the Tree is greater than the specified key), returns null.
    Related Links:
    Google Code Search
    Stack Overflow

  • headMaptop

    public SortedMap<K, V> headMap(K toKey)
    Returns a view of the portion of this map whose keys are strictly less than toKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

    The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

    Equivalent to headMap(toKey, false).

    Parameters:
    @param toKey high endpoint (exclusive) of the keys in the returned map
    Return:
    @return a view of the portion of this map whose keys are strictly less than toKey
    Exceptions:
    @throws ClassCastException if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable ). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
    @throws NullPointerException if toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    @throws IllegalArgumentException if this map itself has a restricted range, and toKey lies outside the bounds of the range
    Specified by:
    headMap from NavigableMap<K, V>
    headMap from SortedMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • headMaptop

    public NavigableMap<K, V> headMap(K toKey, boolean inclusive)
    Returns a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

    The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

    Parameters:
    @param toKey high endpoint of the keys in the returned map
    @param inclusive true if the high endpoint is to be included in the returned view
    Return:
    @return a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey
    Exceptions:
    @throws ClassCastException if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable ). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
    @throws NullPointerException if toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    @throws IllegalArgumentException if this map itself has a restricted range, and toKey lies outside the bounds of the range
    Since:
    @since 1.6
    Specified by:
    headMap from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • higherEntrytop

    public Map.Entry<K, V> higherEntry(K key)
    Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return an entry with the least key greater than key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    higherEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • higherKeytop

    public K higherKey(K key)
    Returns the least key strictly greater than the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return the least key greater than key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    higherKey from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • keytop

    static <K> K key(TreeMap.Entry<?> e)
    Returns the key corresponding to the specified Entry.
    Exceptions:
    @throws NoSuchElementException if the Entry is null
    Related Links:
    Google Code Search
    Stack Overflow

  • keyIteratortop

    Iterator<K> keyIterator()
    Related Links:
    Google Code Search
    Stack Overflow

  • keyOrNulltop

    static <K, V> K keyOrNull(TreeMap.Entry<K, V> e)
    Return key for entry, or null if null
    Related Links:
    Google Code Search
    Stack Overflow

  • keySettop

    public Set<K> keySet()
    Returns a java.util.Set view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    Return:
    @return a set view of the keys contained in this map, sorted in ascending order
    Specified by:
    keySet from SortedMap<K, V>
    keySet from Map<K, V>
    Override hierarchy:
    keySet from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • lastEntrytop

    public Map.Entry<K, V> lastEntry()
    Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
    Return:
    @return an entry with the greatest key, or null if this map is empty
    Since:
    @since 1.6
    Specified by:
    lastEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • lastKeytop

    public K lastKey()
    Returns the last (highest) key currently in this map.
    Return:
    @return the last (highest) key currently in this map
    Exceptions:
    @throws NoSuchElementException if this map is empty
    Specified by:
    lastKey from SortedMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • leftOftop

    static private <K, V> TreeMap.Entry<K, V> leftOf(TreeMap.Entry<K, V> p)
    Related Links:
    Google Code Search
    Stack Overflow

  • lowerEntrytop

    public Map.Entry<K, V> lowerEntry(K key)
    Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return an entry with the greatest key less than key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    lowerEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • lowerKeytop

    public K lowerKey(K key)
    Returns the greatest key strictly less than the given key, or null if there is no such key.
    Parameters:
    @param key the key
    Return:
    @return the greatest key less than key , or null if there is no such key
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Since:
    @since 1.6
    Specified by:
    lowerKey from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • navigableKeySettop

    public NavigableSet<K> navigableKeySet()
    Returns a java.util.NavigableSet view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    Return:
    @return a navigable set view of the keys in this map
    Since:
    @since 1.6
    Specified by:
    navigableKeySet from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • parentOftop

    static private <K, V> TreeMap.Entry<K, V> parentOf(TreeMap.Entry<K, V> p)
    Related Links:
    Google Code Search
    Stack Overflow

  • pollFirstEntrytop

    public Map.Entry<K, V> pollFirstEntry()
    Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.
    Return:
    @return the removed first entry of this map, or null if this map is empty
    Since:
    @since 1.6
    Specified by:
    pollFirstEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • pollLastEntrytop

    public Map.Entry<K, V> pollLastEntry()
    Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
    Return:
    @return the removed last entry of this map, or null if this map is empty
    Since:
    @since 1.6
    Specified by:
    pollLastEntry from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • predecessortop

    static <K, V> TreeMap.Entry<K, V> predecessor(TreeMap.Entry<K, V> t)
    Returns the predecessor of the specified Entry, or null if no such.
    Related Links:
    Google Code Search
    Stack Overflow

  • puttop

    public V put(K key, V value)
    Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced.
    Parameters:
    @param key key with which the specified value is to be associated
    @param value value to be associated with the specified key
    Return:
    @return the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Specified by:
    put from Map<K, V>
    Override hierarchy:
    put from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • putAlltop

    public void putAll(Map<? extends K, ? extends V> map)
    Copies all of the mappings from the specified map to this map. These mappings replace any mappings that this map had for any of the keys currently in the specified map.
    Parameters:
    @param map mappings to be stored in this map
    Exceptions:
    @throws ClassCastException if the class of a key or value in the specified map prevents it from being stored in this map
    @throws NullPointerException if the specified map is null or the specified map contains a null key and this map does not permit null keys
    Specified by:
    putAll from Map<K, V>
    Override hierarchy:
    putAll from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • readObjecttop

    private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException
    Reconstitute the TreeMap instance from a stream (i.e., deserialize it).
    Related Links:
    Google Code Search
    Stack Overflow

  • readTreeSettop

    void readTreeSet(int size, ObjectInputStream s, V defaultVal) throws IOException, ClassNotFoundException
    Intended to be called only from TreeSet.readObject
    Related Links:
    Google Code Search
    Stack Overflow

  • removetop

    public V remove(Object key)
    Removes the mapping for this key from this TreeMap if present.
    Parameters:
    @param key key for which mapping should be removed
    Return:
    @return the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)
    Exceptions:
    @throws ClassCastException if the specified key cannot be compared with the keys currently in the map
    @throws NullPointerException if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys
    Specified by:
    remove from Map<K, V>
    Override hierarchy:
    remove from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • rightOftop

    static private <K, V> TreeMap.Entry<K, V> rightOf(TreeMap.Entry<K, V> p)
    Related Links:
    Google Code Search
    Stack Overflow

  • rotateLefttop

    private void rotateLeft(TreeMap.Entry<K, V> p)
    From CLR
    Related Links:
    Google Code Search
    Stack Overflow

  • rotateRighttop

    private void rotateRight(TreeMap.Entry<K, V> p)
    From CLR
    Related Links:
    Google Code Search
    Stack Overflow

  • setColortop

    static private <K, V> void setColor(TreeMap.Entry<K, V> p, boolean c)
    Related Links:
    Google Code Search
    Stack Overflow

  • sizetop

    public int size()
    Returns the number of key-value mappings in this map.
    Return:
    @return the number of key-value mappings in this map
    Specified by:
    size from Map<K, V>
    Override hierarchy:
    size from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • subMaptop

    public SortedMap<K, V> subMap(K fromKey, K toKey)
    Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned map is empty.) The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

    The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

    Equivalent to subMap(fromKey, true, toKey, false).

    Parameters:
    @param fromKey low endpoint (inclusive) of the keys in the returned map
    @param toKey high endpoint (exclusive) of the keys in the returned map
    Return:
    @return a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive
    Exceptions:
    @throws ClassCastException if fromKey and toKey cannot be compared to one another using this map's comparator (or, if the map has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromKey or toKey cannot be compared to keys currently in the map.
    @throws NullPointerException if fromKey or toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    @throws IllegalArgumentException if fromKey is greater than toKey; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range
    Specified by:
    subMap from NavigableMap<K, V>
    subMap from SortedMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • subMaptop

    public NavigableMap<K, V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
    Returns a view of the portion of this map whose keys range from fromKey to toKey. If fromKey and toKey are equal, the returned map is empty unless fromExclusive and toExclusive are both true. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

    The returned map will throw an IllegalArgumentException on an attempt to insert a key outside of its range, or to construct a submap either of whose endpoints lie outside its range.

    Parameters:
    @param fromKey low endpoint of the keys in the returned map
    @param fromInclusive true if the low endpoint is to be included in the returned view
    @param toKey high endpoint of the keys in the returned map
    @param toInclusive true if the high endpoint is to be included in the returned view
    Return:
    @return a view of the portion of this map whose keys range from fromKey to toKey
    Exceptions:
    @throws ClassCastException if fromKey and toKey cannot be compared to one another using this map's comparator (or, if the map has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromKey or toKey cannot be compared to keys currently in the map.
    @throws NullPointerException if fromKey or toKey is null and this map uses natural ordering, or its comparator does not permit null keys
    @throws IllegalArgumentException if fromKey is greater than toKey ; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range
    Since:
    @since 1.6
    Specified by:
    subMap from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • successortop

    static <K, V> TreeMap.Entry<K, V> successor(TreeMap.Entry<K, V> t)
    Returns the successor of the specified Entry, or null if no such.
    Related Links:
    Google Code Search
    Stack Overflow

  • tailMaptop

    public SortedMap<K, V> tailMap(K fromKey)
    Returns a view of the portion of this map whose keys are greater than or equal to fromKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

    The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

    Equivalent to tailMap(fromKey, true).

    Parameters:
    @param fromKey low endpoint (inclusive) of the keys in the returned map
    Return:
    @return a view of the portion of this map whose keys are greater than or equal to fromKey
    Exceptions:
    @throws ClassCastException if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable ). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
    @throws NullPointerException if fromKey is null and this map uses natural ordering, or its comparator does not permit null keys
    @throws IllegalArgumentException if this map itself has a restricted range, and fromKey lies outside the bounds of the range
    Specified by:
    tailMap from NavigableMap<K, V>
    tailMap from SortedMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • tailMaptop

    public NavigableMap<K, V> tailMap(K fromKey, boolean inclusive)
    Returns a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

    The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

    Parameters:
    @param fromKey low endpoint of the keys in the returned map
    @param inclusive true if the low endpoint is to be included in the returned view
    Return:
    @return a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey
    Exceptions:
    @throws ClassCastException if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable ). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
    @throws NullPointerException if fromKey is null and this map uses natural ordering, or its comparator does not permit null keys
    @throws IllegalArgumentException if this map itself has a restricted range, and fromKey lies outside the bounds of the range
    Since:
    @since 1.6
    Specified by:
    tailMap from NavigableMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • valEqualstop

    static final boolean valEquals(Object o1, Object o2)
    Test two values for equality. Differs from o1.equals(o2) only in that it copes with null o1 properly.
    Related Links:
    Google Code Search
    Stack Overflow

  • valuestop

    public Collection<V> values()
    Returns a java.util.Collection view of the values contained in this map. The collection's iterator returns the values in ascending order of the corresponding keys. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    Return:
    @return a collection view of the values contained in this map, sorted in ascending key order
    Specified by:
    values from SortedMap<K, V>
    values from Map<K, V>
    Override hierarchy:
    values from AbstractMap<K, V>
    Related Links:
    Google Code Search
    Stack Overflow

  • writeObjecttop

    private void writeObject(ObjectOutputStream s) throws IOException
    Save the state of the TreeMap instance to a stream (i.e., serialize it).
    Misc:
    @serialData The size of the TreeMap (the number of key-value mappings) is emitted (int), followed by the key (Object) and value (Object) for each key-value mapping represented by the TreeMap. The key-value mappings are emitted in key-order (as determined by the TreeMap's Comparator, or by the keys' natural ordering if the TreeMap has no Comparator).
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • BLACK

    static final private boolean BLACK = true

  • RED

    static final private boolean RED = false

  • UNBOUNDED

    static final private Object UNBOUNDED
    Dummy value serving as unmatchable fence key for unbounded SubMapIterators

  • comparator

    final private Comparator<? super K> comparator
    The comparator used to maintain order in this tree map, or null if it uses the natural ordering of its keys.

  • descendingMap

    transient private NavigableMap<K, V> descendingMap

  • entrySet

    transient private TreeMap<K, V>.EntrySet entrySet
    Fields initialized to contain an instance of the entry set view the first time this view is requested. Views are stateless, so there's no reason to create more than one.

  • modCount

    transient private int modCount
    The number of structural modifications to the tree.

  • navigableKeySet

    transient private TreeMap.KeySet<K> navigableKeySet

  • root

    transient private TreeMap.Entry<K, V> root

  • serialVersionUID

    static final private long serialVersionUID = 919286545866124006

  • size

    transient private int size
    The number of entries in the tree