@GwtCompatible public final class HashBiMap<K,V> extends AbstractMap<K,V> implements BiMap<K,V>, 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 .
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Removes all of the mappings from this map (optional operation).
|
boolean |
containsKey(Object key)
Returns true if this map contains a mapping for the specified
key.
|
boolean |
containsValue(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(Map<? extends K,? extends V> map)
Constructs a new bimap containing initial values from
map. |
Set<Map.Entry<K,V>> |
entrySet()
Returns a
Set view of the mappings contained in this map. |
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. |
V |
get(Object key)
Returns the value to which the specified key is mapped,
or
null if this map contains no mapping for the key. |
BiMap<V,K> |
inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its
associated key.
|
Set<K> |
keySet()
Returns a
Set view of the keys contained in this map. |
V |
put(K key,
V value)
Associates the specified value with the specified key in this map
(optional operation).
|
V |
remove(Object key)
Removes the mapping for a key from this map if it is present
(optional operation).
|
int |
size()
Returns the number of key-value mappings in this map.
|
Set<V> |
values()
Returns a
Collection view of the values contained in this map. |
clone, equals, hashCode, isEmpty, putAll, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAllpublic 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 entriesIllegalArgumentException - if the specified expected size is negativepublic static <K,V> HashBiMap<K,V> create(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 int size()
java.util.AbstractMappublic boolean containsKey(@NullableDecl Object key)
java.util.AbstractMapcontainsKey in interface Map<K,V>containsKey in class AbstractMap<K,V>key - key whose presence in this map is to be testedpublic boolean containsValue(@NullableDecl Object value)
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.
containsValue in interface Map<K,V>containsValue in class AbstractMap<K,V>value - the object to search for in the values of this BiMap@NullableDecl public V get(@NullableDecl Object key)
java.util.AbstractMapnull if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
k to a value v such that (key==null ? k==null :
key.equals(k)), then this method returns v; otherwise
it returns null. (There can be at most one such mapping.)
If this map permits null values, then a return value of
null does not necessarily indicate that the map
contains no mapping for the key; it's also possible that the map
explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
@CanIgnoreReturnValue public V put(@NullableDecl K key, @NullableDecl V value)
java.util.AbstractMapm.containsKey(k) would return
true.)put in interface BiMap<K,V>put in interface Map<K,V>put in class AbstractMap<K,V>key - key with which the specified value is to be associatedvalue - value to be associated with the specified key@CanIgnoreReturnValue @NullableDecl public V forcePut(@NullableDecl K key, @NullableDecl V value)
BiMapput 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 entry@CanIgnoreReturnValue @NullableDecl public V remove(@NullableDecl Object key)
java.util.AbstractMap(key==null ? k==null : key.equals(k)), that mapping
is removed. (The map can contain at most one such mapping.)
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.
The map will not contain a mapping for the specified key once the call returns.
public void clear()
java.util.AbstractMappublic Set<K> keySet()
java.util.AbstractMapSet view of the keys contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.public Set<V> values()
java.util.AbstractMapCollection view of the values contained in this map.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.public Set<Map.Entry<K,V>> entrySet()
java.util.MapSet view of the mappings contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation, or through the
setValue operation on a map entry returned by the
iterator) the results of the iteration are undefined. The set
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Set.remove, removeAll, retainAll and
clear operations. It does not support the
add or addAll operations.public BiMap<V,K> inverse()
BiMapNote:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.
Copyright © 2010–2019. All rights reserved.