Class LinkedTreeMap<K,V>

java.lang.Object
java.util.AbstractMap<K,V>
com.google.gson.internal.LinkedTreeMap<K,V>
All Implemented Interfaces:
Serializable, Map<K,V>

public final class LinkedTreeMap<K,V> extends AbstractMap<K,V> implements Serializable
A map of comparable keys to values. Unlike TreeMap, this class uses insertion order for iteration order. Comparison order is only used as an optimization for efficient insertion and removal.

This implementation was derived from Android 4.1's TreeMap class.

See Also:
  • Field Details

  • Constructor Details

    • LinkedTreeMap

      public LinkedTreeMap()
      Create a natural order, empty tree map whose keys must be mutually comparable and non-null, and whose values can be null.
    • LinkedTreeMap

      public LinkedTreeMap(boolean allowNullValues)
      Create a natural order, empty tree map whose keys must be mutually comparable and non-null.
      Parameters:
      allowNullValues - whether null is allowed as entry value
    • LinkedTreeMap

      public LinkedTreeMap(Comparator<? super K> comparator, boolean allowNullValues)
      Create a tree map ordered by comparator. This map's keys may only be null if comparator permits.
      Parameters:
      comparator - the comparator to order elements with, or null to use the natural ordering.
      allowNullValues - whether null is allowed as entry value
  • Method Details

    • size

      public int size()
      Specified by:
      size in interface Map<K,V>
      Overrides:
      size in class AbstractMap<K,V>
    • get

      public V get(Object key)
      Specified by:
      get in interface Map<K,V>
      Overrides:
      get in class AbstractMap<K,V>
    • containsKey

      public boolean containsKey(Object key)
      Specified by:
      containsKey in interface Map<K,V>
      Overrides:
      containsKey in class AbstractMap<K,V>
    • put

      public V put(K key, V value)
      Specified by:
      put in interface Map<K,V>
      Overrides:
      put in class AbstractMap<K,V>
    • clear

      public void clear()
      Specified by:
      clear in interface Map<K,V>
      Overrides:
      clear in class AbstractMap<K,V>
    • remove

      public V remove(Object key)
      Specified by:
      remove in interface Map<K,V>
      Overrides:
      remove in class AbstractMap<K,V>
    • find

      LinkedTreeMap.Node<K,V> find(K key, boolean create)
      Returns the node at or adjacent to the given key, creating it if requested.
      Throws:
      ClassCastException - if key and the tree's keys aren't mutually comparable.
    • findByObject

      LinkedTreeMap.Node<K,V> findByObject(Object key)
    • findByEntry

      LinkedTreeMap.Node<K,V> findByEntry(Map.Entry<?,?> entry)
      Returns this map's entry that has the same key and value as entry, or null if this map has no such entry.

      This method uses the comparator for key equality rather than equals. If this map's comparator isn't consistent with equals (such as String.CASE_INSENSITIVE_ORDER), then remove() and contains() will violate the collections API.

    • equal

      private boolean equal(Object a, Object b)
    • removeInternal

      void removeInternal(LinkedTreeMap.Node<K,V> node, boolean unlink)
      Removes node from this tree, rearranging the tree's structure as necessary.
      Parameters:
      unlink - true to also unlink this node from the iteration linked list.
    • removeInternalByKey

      LinkedTreeMap.Node<K,V> removeInternalByKey(Object key)
    • replaceInParent

      private void replaceInParent(LinkedTreeMap.Node<K,V> node, LinkedTreeMap.Node<K,V> replacement)
    • rebalance

      private void rebalance(LinkedTreeMap.Node<K,V> unbalanced, boolean insert)
      Rebalances the tree by making any AVL rotations necessary between the newly-unbalanced node and the tree's root.
      Parameters:
      insert - true if the node was unbalanced by an insert; false if it was by a removal.
    • rotateLeft

      private void rotateLeft(LinkedTreeMap.Node<K,V> root)
      Rotates the subtree so that its root's right child is the new root.
    • rotateRight

      private void rotateRight(LinkedTreeMap.Node<K,V> root)
      Rotates the subtree so that its root's left child is the new root.
    • entrySet

      public Set<Map.Entry<K,V>> entrySet()
      Specified by:
      entrySet in interface Map<K,V>
      Specified by:
      entrySet in class AbstractMap<K,V>
    • keySet

      public Set<K> keySet()
      Specified by:
      keySet in interface Map<K,V>
      Overrides:
      keySet in class AbstractMap<K,V>
    • writeReplace

      private Object writeReplace() throws ObjectStreamException
      If somebody is unlucky enough to have to serialize one of these, serialize it as a LinkedHashMap so that they won't need Gson on the other side to deserialize it. Using serialization defeats our DoS defence, so most apps shouldn't use it.
      Throws:
      ObjectStreamException
    • readObject

      private void readObject(ObjectInputStream in) throws IOException
      Throws:
      IOException