Package com.google.common.collect
Class HashBiMap<K,V>
java.lang.Object
java.util.AbstractMap<K,V>
com.google.common.collect.HashBiMap<K,V>
- All Implemented Interfaces:
BiMap<K,
,V> Serializable
,Map<K,
V>
@GwtCompatible(emulated=true)
public final class HashBiMap<K,V>
extends AbstractMap<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 classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,
V>, AbstractMap.SimpleImmutableEntry<K, V> -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
boolean
containsKey
(Object key) boolean
containsValue
(Object value) 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
.entrySet()
An alternate form ofput
that silently removes any existing entry with the valuevalue
before proceeding with theBiMap.put(K, V)
operation.inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.keySet()
int
size()
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 java.util.Map
compute, computeIfAbsent, computeIfPresent, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll
-
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. -
containsKey
- Specified by:
containsKey
in interfaceMap<K,
V> - Overrides:
containsKey
in classAbstractMap<K,
V>
-
containsValue
- Specified by:
containsValue
in interfaceMap<K,
V> - Overrides:
containsValue
in classAbstractMap<K,
V>
-
get
-
put
Description copied from interface:BiMap
-
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 which was previously associated with the key, which may
be
null
, ornull
if there was no previous entry
-
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. -
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.
-
entrySet
- Specified by:
entrySet
in interfaceMap<K,
V> - Specified by:
entrySet
in classAbstractMap<K,
V>
-