java.lang.Object
- java.util.AbstractMap<K,V>
- - com.google.common.collect.Maps.IteratorBasedAbstractMap<K,V>
  - - com.google.common.collect.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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`HashBiMap.BiEntry<K,V>`
`private class`	`HashBiMap.Inverse`
`private static class`	`HashBiMap.InverseSerializedForm<K,V>`
`(package private) class`	`HashBiMap.Itr<T>`
`private class`	`HashBiMap.KeySet`

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>

Field Summary

Fields
Modifier and Type	Field	Description
`private HashBiMap.BiEntry<K,V>`	`firstInKeyInsertionOrder`
`private HashBiMap.BiEntry<K,V>[]`	`hashTableKToV`
`private HashBiMap.BiEntry<K,V>[]`	`hashTableVToK`
`private BiMap<V,K>`	`inverse`
`private HashBiMap.BiEntry<K,V>`	`lastInKeyInsertionOrder`
`private static double`	`LOAD_FACTOR`
`private int`	`mask`
`private int`	`modCount`
`private static long`	`serialVersionUID`
`private int`	`size`

Constructor Summary

Constructors
Modifier Constructor Description

private HashBiMap(int expectedSize)

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,V> HashBiMap<K,V>`	`create()`	Returns a new, empty `HashBiMap` with the default initial capacity (16).
`static <K,V> HashBiMap<K,V>`	`create(int expectedSize)`	Constructs a new, empty bimap with the specified expected size.
`static <K,V> HashBiMap<K,V>`	`create(java.util.Map<? extends K,? extends V> map)`	Constructs a new bimap containing initial values from `map`.
`private HashBiMap.BiEntry<K,V>[]`	`createTable(int length)`
`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.
`(package private) java.util.Iterator<java.util.Map.Entry<K,V>>`	`entryIterator()`
`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.
`void`	`forEach(java.util.function.BiConsumer<? super K,? super V> action)`
`V`	`get(java.lang.Object key)`
`private void`	`init(int expectedSize)`
`private void`	`insert(HashBiMap.BiEntry<K,V> entry, HashBiMap.BiEntry<K,V> oldEntryForKey)`
`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)`
`private V`	`put(K key, V value, boolean force)`
`private K`	`putInverse(V value, K key, boolean force)`
`private void`	`readObject(java.io.ObjectInputStream stream)`
`private void`	`rehashIfNecessary()`
`V`	`remove(java.lang.Object key)`
`void`	`replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)`
`private HashBiMap.BiEntry<K,V>`	`seekByKey(java.lang.Object key, int keyHash)`
`private HashBiMap.BiEntry<K,V>`	`seekByValue(java.lang.Object value, int valueHash)`
`int`	`size()`
`java.util.Set<V>`	`values()`
`private void`	`writeObject(java.io.ObjectOutputStream stream)`

Methods inherited from class com.google.common.collect.Maps.IteratorBasedAbstractMap
entrySet, entrySpliterator, forEachEntry

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, entrySet, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace

- Field Detail
  - LOAD_FACTOR
```
private static final double LOAD_FACTOR
```
    See Also:
    
    Constant Field Values
  - hashTableKToV
```
private transient HashBiMap.BiEntry<K,V>[] hashTableKToV
```
  - hashTableVToK
```
private transient HashBiMap.BiEntry<K,V>[] hashTableVToK
```
  - firstInKeyInsertionOrder
```
private transient HashBiMap.BiEntry<K,V> firstInKeyInsertionOrder
```
  - lastInKeyInsertionOrder
```
private transient HashBiMap.BiEntry<K,V> lastInKeyInsertionOrder
```
  - size
```
private transient int size
```
  - mask
```
private transient int mask
```
  - modCount
```
private transient int modCount
```
  - inverse
```
private transient BiMap<V,K> inverse
```
  - serialVersionUID
```
@GwtIncompatible
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- 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.
  - insert
```
private void insert(HashBiMap.BiEntry<K,V> entry,
                    HashBiMap.BiEntry<K,V> oldEntryForKey)
```
  - 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)
```
    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,V>
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<K,V>
    
    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
  - 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()
```
  - createTable
```
private HashBiMap.BiEntry<K,V>[] createTable(int length)
```
  - 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>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K,V>
    
    Overrides:
    
    clear in class Maps.IteratorBasedAbstractMap<K,V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<K,V>
    
    Specified by:
    
    size in class Maps.IteratorBasedAbstractMap<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>
  - entryIterator
```
java.util.Iterator<java.util.Map.Entry<K,V>> entryIterator()
```
    Specified by:
    
    entryIterator in class Maps.IteratorBasedAbstractMap<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

Class HashBiMap<K,​V>

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.common.collect.Maps.IteratorBasedAbstractMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

Field Detail

LOAD_FACTOR

hashTableKToV

hashTableVToK

firstInKeyInsertionOrder

lastInKeyInsertionOrder

size

mask

modCount

inverse

serialVersionUID

Constructor Detail

HashBiMap

Method Detail

create

create

create

init

delete

insert

seekByKey

seekByValue

containsKey

containsValue

get

put

put

forcePut

putInverse

rehashIfNecessary

createTable

remove

clear

size

keySet

values

entryIterator

forEach

replaceAll

inverse

writeObject

readObject

Class HashBiMap<K,V>