Class AbstractBiMap<K,V>

All Implemented Interfaces:
BiMap<K,V>, Serializable, Map<K,V>
Direct Known Subclasses:
AbstractBiMap.Inverse, EnumBiMap, EnumHashBiMap

abstract class AbstractBiMap<K,V> extends ForwardingMap<K,V> implements BiMap<K,V>, Serializable
A general-purpose bimap implementation using any two backing Map instances.

Note that this class contains equals() calls that keep it from supporting IdentityHashMap backing maps.

  • Field Details

    • delegate

      private transient Map<K,V> delegate
    • inverse

      transient AbstractBiMap<V,K> inverse
    • keySet

      @CheckForNull private transient Set<K> keySet
    • valueSet

      @CheckForNull private transient Set<V> valueSet
    • entrySet

      @CheckForNull private transient Set<Map.Entry<K,V>> entrySet
    • serialVersionUID

      private static final long serialVersionUID
      See Also:
  • Constructor Details

    • AbstractBiMap

      AbstractBiMap(Map<K,V> forward, Map<V,K> backward)
      Package-private constructor for creating a map-backed bimap.
    • AbstractBiMap

      private AbstractBiMap(Map<K,V> backward, AbstractBiMap<V,K> forward)
      Private constructor for inverse bimap.
  • Method Details

    • delegate

      protected Map<K,V> delegate()
      Description copied from class: ForwardingObject
      Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.
      Specified by:
      delegate in class ForwardingMap<K,V>
    • checkKey

      K checkKey(K key)
      Returns its input, or throws an exception if this is not a valid key.
    • checkValue

      V checkValue(V value)
      Returns its input, or throws an exception if this is not a valid value.
    • setDelegates

      void setDelegates(Map<K,V> forward, Map<V,K> backward)
      Specifies the delegate maps going in each direction. Called by the constructor and by subclasses during deserialization.
    • makeInverse

      AbstractBiMap<V,K> makeInverse(Map<V,K> backward)
    • setInverse

      void setInverse(AbstractBiMap<V,K> inverse)
    • containsValue

      public boolean containsValue(@CheckForNull Object value)
      Specified by:
      containsValue in interface Map<K,V>
      Overrides:
      containsValue in class ForwardingMap<K,V>
    • put

      @CheckForNull public V put(K key, V value)
      Description copied from interface: BiMap
      Specified by:
      put in interface BiMap<K,V>
      Specified by:
      put in interface Map<K,V>
      Overrides:
      put in class ForwardingMap<K,V>
    • forcePut

      @CheckForNull public V forcePut(K key, V value)
      Description copied from interface: BiMap
      An alternate form of put that silently removes any existing entry with the value value before proceeding with the BiMap.put(K, V) operation. If the bimap previously contained the provided key-value mapping, this method has no effect.

      Note that a successful call to this method could cause the size of the bimap to increase by one, stay the same, or even decrease by one.

      Warning: If an existing entry with this value is removed, the key for that entry is discarded and not returned.

      Specified by:
      forcePut in interface BiMap<K,V>
      Parameters:
      key - the key with which the specified value is to be associated
      value - the value to be associated with the specified key
      Returns:
      the value that was previously associated with the key, or null if there was no previous entry. (If the bimap contains null values, then forcePut, like put, returns null both if the key is absent and if it is present with a null value.)
    • putInBothMaps

      @CheckForNull private V putInBothMaps(K key, V value, boolean force)
    • updateInverseMap

      private void updateInverseMap(K key, boolean containedKey, @CheckForNull V oldValue, V newValue)
    • remove

      @CheckForNull public V remove(@CheckForNull Object key)
      Specified by:
      remove in interface Map<K,V>
      Overrides:
      remove in class ForwardingMap<K,V>
    • removeFromBothMaps

      private V removeFromBothMaps(@CheckForNull Object key)
    • removeFromInverseMap

      private void removeFromInverseMap(V oldValue)
    • putAll

      public void putAll(Map<? extends K,? extends V> map)
      Description copied from interface: BiMap

      Warning: the results of calling this method may vary depending on the iteration order of map.

      Specified by:
      putAll in interface BiMap<K,V>
      Specified by:
      putAll in interface Map<K,V>
      Overrides:
      putAll in class ForwardingMap<K,V>
    • replaceAll

      public void replaceAll(BiFunction<? super K,? super V,? extends V> function)
      Specified by:
      replaceAll in interface Map<K,V>
    • clear

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

      public BiMap<V,K> inverse()
      Description copied from interface: BiMap
      Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key. The two bimaps are backed by the same data; any changes to one will appear in the other.

      Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.

      Specified by:
      inverse in interface BiMap<K,V>
      Returns:
      the inverse view of this bimap
    • keySet

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

      public Set<V> values()
      Description copied from interface: BiMap

      Because a bimap has unique values, this method returns a Set, instead of the Collection specified in the Map interface.

      Specified by:
      values in interface BiMap<K,V>
      Specified by:
      values in interface Map<K,V>
      Overrides:
      values in class ForwardingMap<K,V>
    • entrySet

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

      Iterator<Map.Entry<K,V>> entrySetIterator()