Package com.google.common.collect
Class ImmutableBiMap<K,V>
java.lang.Object
com.google.common.collect.ImmutableMap<K,V>
com.google.common.collect.ImmutableBiMap<K,V>
- All Implemented Interfaces:
BiMap<K,
,V> Serializable
,Map<K,
V>
@GwtCompatible(serializable=true,
emulated=true)
public abstract class ImmutableBiMap<K,V>
extends ImmutableMap<K,V>
implements BiMap<K,V>
A
BiMap
whose contents will never change, with many other important properties detailed
at ImmutableCollection
.- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A builder for creating immutable bimap instances, especiallypublic static final
bimaps ("constant bimaps"). -
Method Summary
Modifier and TypeMethodDescriptionstatic <K,
V> ImmutableBiMap.Builder <K, V> builder()
Returns a new builder.static <K,
V> ImmutableBiMap <K, V> Returns an immutable bimap containing the given entries.static <K,
V> ImmutableBiMap <K, V> Returns an immutable bimap containing the same entries asmap
.Deprecated.Unsupported operation.abstract ImmutableBiMap
<V, K> inverse()
Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.static <K,
V> ImmutableBiMap <K, V> of()
Returns the empty bimap.static <K,
V> ImmutableBiMap <K, V> of
(K k1, V v1) Returns an immutable bimap containing a single entry.static <K,
V> ImmutableBiMap <K, V> of
(K k1, V v1, K k2, V v2) Returns an immutable map containing the given entries, in order.static <K,
V> ImmutableBiMap <K, V> of
(K k1, V v1, K k2, V v2, K k3, V v3) Returns an immutable map containing the given entries, in order.static <K,
V> ImmutableBiMap <K, V> of
(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) Returns an immutable map containing the given entries, in order.static <K,
V> ImmutableBiMap <K, V> of
(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5) Returns an immutable map containing the given entries, in order.values()
Returns an immutable set of the values in this map.Methods inherited from class com.google.common.collect.ImmutableMap
asMultimap, clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size
-
Method Details
-
of
Returns the empty bimap. -
of
Returns an immutable bimap containing a single entry. -
of
Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException
- if duplicate keys or values are added
-
of
Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException
- if duplicate keys or values are added
-
of
Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException
- if duplicate keys or values are added
-
of
public static <K,V> ImmutableBiMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5) Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException
- if duplicate keys or values are added
-
builder
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableBiMap.Builder
constructor. -
copyOf
Returns an immutable bimap containing the same entries asmap
. Ifmap
somehow contains entries with duplicate keys (for example, if it is aSortedMap
whose comparator is not consistent with equals), the results of this method are undefined.Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.
- Throws:
IllegalArgumentException
- if two keys have the same valueNullPointerException
- if any key or value inmap
is null
-
copyOf
@Beta public static <K,V> ImmutableBiMap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries) Returns an immutable bimap containing the given entries.- Throws:
IllegalArgumentException
- if two keys have the same value or two values have the same keyNullPointerException
- if any key, value, or entry is null- Since:
- 19.0
-
inverse
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.
The inverse of an
ImmutableBiMap
is anotherImmutableBiMap
. -
values
Returns an immutable set of the values in this map. The values are in the same order as the parameters used to build this map. -
forcePut
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the bimap unmodified.- 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 - Throws:
UnsupportedOperationException
- always
-