@GwtCompatible(emulated=true) public final class HashBiMap<K,V> extends java.util.AbstractMap<K,V> implements BiMap<K,V>, java.io.Serializable
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
.
Modifier and Type | Method and Description |
---|---|
void |
clear() |
boolean |
containsKey(@Nullable java.lang.Object key) |
boolean |
containsValue(@Nullable java.lang.Object 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 . |
java.util.Set<java.util.Map.Entry<K,V>> |
entrySet() |
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(@Nullable java.lang.Object key) |
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) |
V |
remove(@Nullable java.lang.Object key) |
void |
replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function) |
int |
size() |
java.util.Set<V> |
values() |
clone, equals, hashCode, isEmpty, putAll, toString
public static <K,V> HashBiMap<K,V> create()
HashBiMap
with the default initial capacity (16).public static <K,V> HashBiMap<K,V> create(int expectedSize)
expectedSize
- the expected number of entriesjava.lang.IllegalArgumentException
- if the specified expected size is negativepublic static <K,V> HashBiMap<K,V> create(java.util.Map<? extends K,? extends V> map)
map
. The bimap is created with an
initial capacity sufficient to hold the mappings in the specified map.public boolean containsKey(@Nullable java.lang.Object key)
public boolean containsValue(@Nullable java.lang.Object value)
@CanIgnoreReturnValue public V forcePut(K key, V value)
BiMap
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.
forcePut
in interface BiMap<K,V>
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified keynull
, or
null
if there was no previous entrypublic java.util.Set<V> values()
BiMap
Because a bimap has unique values, this method returns a Set
, instead of the Collection
specified in the Map
interface.
public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
public BiMap<V,K> inverse()
BiMap
Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
entrySet
in interface java.util.Map<K,V>
entrySet
in class java.util.AbstractMap<K,V>
Copyright © 2010–2019 JBoss by Red Hat. All rights reserved.