Package com.google.common.collect
Class HashBiMap<K,V>
- 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>
public final class HashBiMap<K,V> extends Maps.IteratorBasedAbstractMap<K,V> implements BiMap<K,V>, java.io.Serializable
ABiMap
backed by two hash tables. This implementation allows null keys and values. AHashBiMap
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
-
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)
Returnstrue
if this BiMap contains an entry whose value is equal tovalue
(or, equivalently, if this inverse view contains a key that is equal tovalue
).static <K,V>
HashBiMap<K,V>create()
Returns a new, emptyHashBiMap
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 frommap
.private HashBiMap.BiEntry<K,V>[]
createTable(int length)
private void
delete(HashBiMap.BiEntry<K,V> entry)
Finds and removesentry
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 ofput
that silently removes any existing entry with the valuevalue
before proceeding with theBiMap.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
-
-
-
-
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
@CheckForNull private transient HashBiMap.BiEntry<K,V> firstInKeyInsertionOrder
-
lastInKeyInsertionOrder
@CheckForNull private transient HashBiMap.BiEntry<K,V> lastInKeyInsertionOrder
-
size
private transient int size
-
mask
private transient int mask
-
modCount
private transient int modCount
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
create
public static <K,V> HashBiMap<K,V> create()
Returns a new, emptyHashBiMap
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 frommap
. 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 removesentry
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, @CheckForNull HashBiMap.BiEntry<K,V> oldEntryForKey)
-
seekByKey
@CheckForNull private HashBiMap.BiEntry<K,V> seekByKey(@CheckForNull java.lang.Object key, int keyHash)
-
seekByValue
@CheckForNull private HashBiMap.BiEntry<K,V> seekByValue(@CheckForNull java.lang.Object value, int valueHash)
-
containsKey
public boolean containsKey(@CheckForNull java.lang.Object key)
-
containsValue
public boolean containsValue(@CheckForNull java.lang.Object value)
Returnstrue
if this BiMap contains an entry whose value is equal tovalue
(or, equivalently, if this inverse view contains a key that is equal tovalue
).Due to the property that values in a BiMap are unique, this will tend to execute in faster-than-linear time.
-
get
@CheckForNull public V get(@CheckForNull java.lang.Object key)
-
forcePut
@CheckForNull public V forcePut(K key, V value)
Description copied from interface:BiMap
An alternate form ofput
that silently removes any existing entry with the valuevalue
before proceeding with theBiMap.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 interfaceBiMap<K,V>
- Parameters:
key
- the key with which the specified value is to be associatedvalue
- 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, thenforcePut
, likeput
, returnsnull
both if the key is absent and if it is present with a null value.)
-
rehashIfNecessary
private void rehashIfNecessary()
-
createTable
private HashBiMap.BiEntry<K,V>[] createTable(int length)
-
remove
@CheckForNull public V remove(@CheckForNull java.lang.Object key)
-
clear
public void clear()
-
size
public int size()
-
keySet
public java.util.Set<K> keySet()
-
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 theCollection
specified in theMap
interface.
-
entryIterator
java.util.Iterator<java.util.Map.Entry<K,V>> entryIterator()
- Specified by:
entryIterator
in classMaps.IteratorBasedAbstractMap<K,V>
-
replaceAll
public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
-
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.
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
- Throws:
java.io.IOException
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-