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> Serializable
,Map<K,
V>
public final class HashBiMap<K,V>
extends Maps.IteratorBasedAbstractMap<K,V>
implements BiMap<K,V>, 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
private final class
private static final class
private class
private final class
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,
V>, AbstractMap.SimpleImmutableEntry<K, V> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate HashBiMap.BiEntry
<K, V> private HashBiMap.BiEntry<K,
V>[] private HashBiMap.BiEntry<K,
V>[] private HashBiMap.BiEntry
<K, V> private static final double
private int
private int
private static final long
private int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
boolean
containsKey
(Object key) boolean
containsValue
(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> 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.An alternate form ofput
that silently removes any existing entry with the valuevalue
before proceeding with theBiMap.put(K, V)
operation.void
forEach
(BiConsumer<? super K, ? super V> action) private void
init
(int expectedSize) private void
insert
(HashBiMap.BiEntry<K, V> entry, HashBiMap.BiEntry<K, V> oldEntryForKey) inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.keySet()
private V
private K
putInverse
(V value, K key, boolean force) private void
readObject
(ObjectInputStream stream) private void
void
replaceAll
(BiFunction<? super K, ? super V, ? extends V> function) private HashBiMap.BiEntry
<K, V> private HashBiMap.BiEntry
<K, V> seekByValue
(Object value, int valueHash) int
size()
values()
private void
writeObject
(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 java.util.Map
compute, computeIfAbsent, computeIfPresent, entrySet, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace
-
Field Details
-
LOAD_FACTOR
private static final double LOAD_FACTOR- See Also:
-
hashTableKToV
-
hashTableVToK
-
firstInKeyInsertionOrder
-
lastInKeyInsertionOrder
-
size
private transient int size -
mask
private transient int mask -
modCount
private transient int modCount -
inverse
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
HashBiMap
private HashBiMap(int expectedSize)
-
-
Method Details
-
create
Returns a new, emptyHashBiMap
with the default initial capacity (16). -
create
Constructs a new, empty bimap with the specified expected size.- Parameters:
expectedSize
- the expected number of entries- Throws:
IllegalArgumentException
- if the specified expected size is negative
-
create
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
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
-
seekByValue
-
containsKey
- Specified by:
containsKey
in interfaceMap<K,
V> - Overrides:
containsKey
in classAbstractMap<K,
V>
-
containsValue
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.
- Specified by:
containsValue
in interfaceMap<K,
V> - Overrides:
containsValue
in classAbstractMap<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
-
put
Description copied from interface:BiMap
-
put
-
forcePut
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.)
-
putInverse
-
rehashIfNecessary
private void rehashIfNecessary() -
createTable
-
remove
-
clear
public void clear() -
size
public int size() -
keySet
-
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
- Specified by:
entryIterator
in classMaps.IteratorBasedAbstractMap<K,
V>
-
forEach
-
replaceAll
- Specified by:
replaceAll
in interfaceMap<K,
V>
-
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
- Throws:
IOException
-
readObject
- Throws:
IOException
ClassNotFoundException
-