@GwtCompatible public interface BiMap<K,V> extends 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)
Associates the specified value with the specified key in this map
(optional operation).
|
void |
putAll(Map<? extends K,? extends V> map)
Copies all of the mappings from the specified map to this map
(optional operation).
|
Set<V> |
values()
Returns a
Collection view of the values contained in this map. |
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size
@CanIgnoreReturnValue V put(K key, V value)
m.containsKey(k)
would return
true.)put
in interface Map<K,V>
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keyIllegalArgumentException
- 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.@CanIgnoreReturnValue 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
, or
null
if there was no previous entryvoid putAll(Map<? extends K,? extends V> map)
put(k, v)
on this map once
for each mapping from key k to value v in the
specified map. The behavior of this operation is undefined if the
specified map is modified while the operation is in progress.
Warning: the results of calling this method may vary depending on the iteration order
of map
.
putAll
in interface Map<K,V>
map
- mappings to be stored in this mapIllegalArgumentException
- if an attempt to put
any entry fails. Note that some
map entries may have been added to the bimap before the exception was thrown.Set<V> values()
Collection
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.
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.
Copyright © 2010–2019. All rights reserved.