Package com.google.common.collect

Class HashBiMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

  • All Implemented Interfaces:
    BiMap<K,​V>, java.io.Serializable, java.util.Map<K,​V>
    @GwtCompatible
public final class HashBiMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
extends java.util.AbstractMap<K,​V>
implements BiMap<K,​V>, java.io.Serializable
    A BiMap backed by two hash tables. This implementation allows null keys and values. A HashBiMap and its inverse are both serializable.

    This implementation guarantees insertion-based iteration order of its keys.

    See the Guava User Guide article on BiMap .

    Since:
    2.0
    Author:
    Louis Wasserman, Mike Bostock
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()  
      boolean containsKey​(java.lang.Object key)  
      boolean containsValue​(java.lang.Object value)
      Returns true if this BiMap contains an entry whose value is equal to value (or, equivalently, if this inverse view contains a key that is equal to value).
      static <K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      HashBiMap<K,​V>      		 create()
      Returns a new, empty HashBiMap with the default initial capacity (16).
      static <K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      HashBiMap<K,​V>      		 create​(int expectedSize)
      Constructs a new, empty bimap with the specified expected size.
      static <K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      HashBiMap<K,​V>      		 create​(java.util.Map<? extends K,​? extends V> map)
      Constructs a new bimap containing initial values from map.
      java.util.Set<java.util.Map.Entry<K,​V>> entrySet()  
      V forcePut​(K key, V value)
      An alternate form of put that silently removes any existing entry with the value value before proceeding with the BiMap.put(K, V) operation.
      V get​(java.lang.Object key)  
      BiMap<V,​K> inverse()
      Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.
      java.util.Set<K> keySet()  
      V put​(K key, V value)
      V remove​(java.lang.Object key)  
      int size()  
      java.util.Set<V> values()

      • Methods inherited from class java.util.AbstractMap

        clone, equals, hashCode, isEmpty, putAll, toString

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.common.collect.BiMap

        putAll

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Method Detail

      • create

        public static <K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object> HashBiMap<K,​V> create()
        Returns a new, empty HashBiMap with the default initial capacity (16).

      • create

        public static <K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object> HashBiMap<K,​V> create​(int expectedSize)
        Constructs a new, empty bimap with the specified expected size.
        Parameters:
        expectedSize - the expected number of entries
        Throws:
        java.lang.IllegalArgumentException - if the specified expected size is negative

      • create

        public static <K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object> HashBiMap<K,​V> create​(java.util.Map<? extends K,​? extends V> map)
        Constructs a new bimap containing initial values from map. The bimap is created with an initial capacity sufficient to hold the mappings in the specified map.

      • size

        public int size()
        Specified by:
        size in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        size in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

      • containsKey

        public boolean containsKey​(@CheckForNull
                           java.lang.Object key)
        Specified by:
        containsKey in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        containsKey in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

      • containsValue

        public boolean containsValue​(@CheckForNull
                             java.lang.Object value)
        Returns true if this BiMap contains an entry whose value is equal to value (or, equivalently, if this inverse view contains a key that is equal to value).

        Due to the property that values in a BiMap are unique, this will tend to execute in faster-than-linear time.

        Specified by:
        containsValue in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        containsValue in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Parameters:
        value - the object to search for in the values of this BiMap
        Returns:
        true if a mapping exists from a key to the specified value

      • forcePut

        @CanIgnoreReturnValue
@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 extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        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.)

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        clear in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

      • keySet

        public java.util.Set<K> keySet()
        Specified by:
        keySet in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        keySet in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

      • values

        public java.util.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 extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        values in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        values in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

      • entrySet

        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        Specified by:
        entrySet in interface java.util.Map<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        entrySet in class java.util.AbstractMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

      • 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 extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Returns:
        the inverse view of this bimap