Class HashBiMap<K,​V>

  • All Implemented Interfaces:
    BiMap<K,​V>, java.io.Serializable, java.util.Map<K,​V>

    @GwtCompatible(emulated=true)
    public final class HashBiMap<K,​V>
    extends Maps.IteratorBasedAbstractMap<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
    See Also:
    Serialized Form
    • Constructor Detail

      • HashBiMap

        private HashBiMap​(int expectedSize)
    • Method Detail

      • create

        public static <K,​V> HashBiMap<K,​V> create()
        Returns a new, empty HashBiMap with the default initial capacity (16).
      • create

        public static <K,​V> 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,​V> 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.
      • init

        private void init​(int expectedSize)
      • delete

        private void delete​(HashBiMap.BiEntry<K,​V> entry)
        Finds and removes entry from the bucket linked lists in both the key-to-value direction and the value-to-key direction.
      • seekByKey

        private HashBiMap.BiEntry<K,​V> seekByKey​(java.lang.Object key,
                                                       int keyHash)
      • seekByValue

        private HashBiMap.BiEntry<K,​V> seekByValue​(java.lang.Object value,
                                                         int valueHash)
      • containsKey

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

        public boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface java.util.Map<K,​V>
        Overrides:
        containsValue in class java.util.AbstractMap<K,​V>
      • get

        public V get​(java.lang.Object key)
        Specified by:
        get in interface java.util.Map<K,​V>
        Overrides:
        get in class java.util.AbstractMap<K,​V>
      • put

        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 java.util.Map<K,​V>
        Overrides:
        put in class java.util.AbstractMap<K,​V>
      • put

        private V put​(K key,
                      V value,
                      boolean force)
      • forcePut

        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 which was previously associated with the key, which may be null, or null if there was no previous entry
      • putInverse

        private K putInverse​(V value,
                             K key,
                             boolean force)
      • rehashIfNecessary

        private void rehashIfNecessary()
      • remove

        public V remove​(java.lang.Object key)
        Specified by:
        remove in interface java.util.Map<K,​V>
        Overrides:
        remove in class java.util.AbstractMap<K,​V>
      • keySet

        public java.util.Set<K> keySet()
        Specified by:
        keySet in interface java.util.Map<K,​V>
        Overrides:
        keySet in class java.util.AbstractMap<K,​V>
      • 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,​V>
        Specified by:
        values in interface java.util.Map<K,​V>
        Overrides:
        values in class java.util.AbstractMap<K,​V>
      • forEach

        public void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)
        Specified by:
        forEach in interface java.util.Map<K,​V>
      • replaceAll

        public void replaceAll​(java.util.function.BiFunction<? super K,​? super V,​? extends V> function)
        Specified by:
        replaceAll in interface java.util.Map<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
      • writeObject

        @GwtIncompatible
        private void writeObject​(java.io.ObjectOutputStream stream)
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • readObject

        @GwtIncompatible
        private void readObject​(java.io.ObjectInputStream stream)
                         throws java.io.IOException,
                                java.lang.ClassNotFoundException
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException