public interface BiMap<K,V>
extends java.util.Map<K,V>
See the Guava User Guide article on BiMap.
| Modifier and Type | Method and Description |
|---|---|
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 put(K, V) operation. |
BiMap<V,K> |
inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its
associated key.
|
V |
put(K key,
V value) |
void |
putAll(java.util.Map<? extends K,? extends V> map) |
java.util.Set<V> |
values() |
@CheckForNull V put(K key, V value)
put in interface java.util.Map<K,V>java.lang.IllegalArgumentException - if the given value is already bound to a different key in this
bimap. The bimap will remain unmodified in this event. To avoid this exception, call forcePut(K, V) instead.@CheckForNull V forcePut(K key, V value)
put that silently removes any existing entry with the value value before proceeding with the 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.
key - the key with which the specified value is to be associatedvalue - the value to be associated with the specified keynull if there was no
previous entry. (If the bimap contains null values, then forcePut, like put, returns null both if the key is absent and if it is present with a null
value.)void putAll(java.util.Map<? extends K,? extends V> map)
Warning: the results of calling this method may vary depending on the iteration order
of map.
java.util.Set<V> values()
Because a bimap has unique values, this method returns a Set, instead of the Collection specified in the Map interface.
BiMap<V,K> inverse()
Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.