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>
ABiMap
whose contents will never change, with many other important properties detailed atImmutableCollection
.- Since:
- 2.0
- Author:
- Jared Levy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableBiMap.Builder<K,V>
A builder for creating immutable bimap instances, especiallypublic static final
bimaps ("constant bimaps").
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <K,V>
ImmutableBiMap.Builder<K,V>builder()
Returns a new builder.static <K,V>
ImmutableBiMap.Builder<K,V>builderWithExpectedSize(int expectedSize)
Returns a new builder, expecting the specified number of entries to be added.static <K,V>
ImmutableBiMap<K,V>copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
Returns an immutable bimap containing the given entries.static <K,V>
ImmutableBiMap<K,V>copyOf(Map<? extends K,? extends V> map)
Returns an immutable bimap containing the same entries asmap
.V
forcePut(K key, V value)
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.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, K k6, V v6)
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, K k6, V v6, K k7, V v7)
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, K k6, V v6, K k7, V v7, K k8, V v8)
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, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
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, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
Returns an immutable map containing the given entries, in order.static <K,V>
ImmutableBiMap<K,V>ofEntries(Map.Entry<? extends K,? extends V>... entries)
Returns an immutable map containing the given entries, in order.static <T extends @Nullable Object,K,V>
Collector<T,?,ImmutableBiMap<K,V>>toImmutableBiMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableBiMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T extends @Nullable Object,K,V>
Collector<T,?,ImmutableMap<K,V>>toImmutableMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
static <T extends @Nullable Object,K,V>
Collector<T,?,ImmutableMap<K,V>>toImmutableMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction, BinaryOperator<V> mergeFunction)
Deprecated.ImmutableSet<V>
values()
Returns an immutable set of the values in this map, in the same order they appear inImmutableMap.entrySet
.-
Methods inherited from class com.google.common.collect.ImmutableMap
asMultimap, clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, 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 Detail
-
toImmutableBiMap
public static <T extends @Nullable Object,K,V> Collector<T,?,ImmutableBiMap<K,V>> toImmutableBiMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableBiMap
whose keys and values are the result of applying the provided mapping functions to the input elements. Entries appear in the resultImmutableBiMap
in encounter order.If the mapped keys or values contain duplicates (according to
Object.equals(Object)
, anIllegalArgumentException
is thrown when the collection operation is performed. (This differs from theCollector
returned byCollectors.toMap(Function, Function)
, which throws anIllegalStateException
.)- Since:
- 21.0
-
of
public static <K,V> ImmutableBiMap<K,V> of()
Returns the empty bimap.Performance note: the instance returned is a singleton.
- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Returns:
- an empty
Map
-
of
public static <K,V> ImmutableBiMap<K,V> of(K k1, V v1)
Returns an immutable bimap containing a single entry.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the mapping's keyv1
- the mapping's value- Returns:
- a
Map
containing the specified mapping
-
of
public 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.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's value- Returns:
- a
Map
containing the specified mappings - 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)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's value- Returns:
- a
Map
containing the specified mappings - 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)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's value- Returns:
- a
Map
containing the specified mappings - 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.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's valuek5
- the fifth mapping's keyv5
- the fifth mapping's value- Returns:
- a
Map
containing the specified mappings - 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, K k6, V v6)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's valuek5
- the fifth mapping's keyv5
- the fifth mapping's valuek6
- the sixth mapping's keyv6
- the sixth mapping's value- Returns:
- a
Map
containing the specified mappings - Throws:
IllegalArgumentException
- if duplicate keys or values are added- Since:
- 31.0
-
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, K k6, V v6, K k7, V v7)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's valuek5
- the fifth mapping's keyv5
- the fifth mapping's valuek6
- the sixth mapping's keyv6
- the sixth mapping's valuek7
- the seventh mapping's keyv7
- the seventh mapping's value- Returns:
- a
Map
containing the specified mappings - Throws:
IllegalArgumentException
- if duplicate keys or values are added- Since:
- 31.0
-
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, K k6, V v6, K k7, V v7, K k8, V v8)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's valuek5
- the fifth mapping's keyv5
- the fifth mapping's valuek6
- the sixth mapping's keyv6
- the sixth mapping's valuek7
- the seventh mapping's keyv7
- the seventh mapping's valuek8
- the eighth mapping's keyv8
- the eighth mapping's value- Returns:
- a
Map
containing the specified mappings - Throws:
IllegalArgumentException
- if duplicate keys or values are added- Since:
- 31.0
-
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, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's valuek5
- the fifth mapping's keyv5
- the fifth mapping's valuek6
- the sixth mapping's keyv6
- the sixth mapping's valuek7
- the seventh mapping's keyv7
- the seventh mapping's valuek8
- the eighth mapping's keyv8
- the eighth mapping's valuek9
- the ninth mapping's keyv9
- the ninth mapping's value- Returns:
- a
Map
containing the specified mappings - Throws:
IllegalArgumentException
- if duplicate keys or values are added- Since:
- 31.0
-
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, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
k1
- the first mapping's keyv1
- the first mapping's valuek2
- the second mapping's keyv2
- the second mapping's valuek3
- the third mapping's keyv3
- the third mapping's valuek4
- the fourth mapping's keyv4
- the fourth mapping's valuek5
- the fifth mapping's keyv5
- the fifth mapping's valuek6
- the sixth mapping's keyv6
- the sixth mapping's valuek7
- the seventh mapping's keyv7
- the seventh mapping's valuek8
- the eighth mapping's keyv8
- the eighth mapping's valuek9
- the ninth mapping's keyv9
- the ninth mapping's valuek10
- the tenth mapping's keyv10
- the tenth mapping's value- Returns:
- a
Map
containing the specified mappings - Throws:
IllegalArgumentException
- if duplicate keys or values are added- Since:
- 31.0
-
ofEntries
@SafeVarargs public static <K,V> ImmutableBiMap<K,V> ofEntries(Map.Entry<? extends K,? extends V>... entries)
Returns an immutable map containing the given entries, in order.- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
entries
-Map.Entry
s containing the keys and values from which the map is populated- Returns:
- a
Map
containing the specified mappings - Throws:
IllegalArgumentException
- if duplicate keys or values are provided- Since:
- 31.0
- See Also:
Map.entry()
-
builder
public static <K,V> ImmutableBiMap.Builder<K,V> builder()
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableBiMap.Builder
constructor.
-
builderWithExpectedSize
@Beta public static <K,V> ImmutableBiMap.Builder<K,V> builderWithExpectedSize(int expectedSize)
Returns a new builder, expecting the specified number of entries to be added.If
expectedSize
is exactly the number of entries added to the builder beforeImmutableBiMap.Builder.build()
is called, the builder is likely to perform better than an unsizedbuilder()
would have.It is not specified if any performance benefits apply if
expectedSize
is close to, but not exactly, the number of entries added to the builder.- Since:
- 23.1
-
copyOf
public static <K,V> ImmutableBiMap<K,V> copyOf(Map<? extends K,? extends V> map)
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.The returned
BiMap
iterates over entries in the same order as theentrySet
of the original map.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.
- Type Parameters:
K
- theMap
's key typeV
- theMap
's value type- Parameters:
map
- aMap
from which entries are drawn, must be non-null- Returns:
- a
Map
containing the entries of the givenMap
- Throws:
IllegalArgumentException
- if two keys have the same value or two values have the same keyNullPointerException
- 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. The returned bimap iterates over entries in the same order as the original iterable.- 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
public abstract ImmutableBiMap<V,K> 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
public ImmutableSet<V> values()
Returns an immutable set of the values in this map, in the same order they appear inImmutableMap.entrySet
.
-
forcePut
@CanIgnoreReturnValue @Deprecated @CheckForNull public final V forcePut(K key, V value)
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 that was previously associated with the key, or
null
if there was no previous entry. (If the bimap contains null values, thenforcePut
, likeput
, returnsnull
both if the key is absent and if it is present with a null value.) - Throws:
UnsupportedOperationException
- always
-
toImmutableMap
@Deprecated public static <T extends @Nullable Object,K,V> Collector<T,?,ImmutableMap<K,V>> toImmutableMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
Deprecated.Not supported. UsetoImmutableBiMap(java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>)
instead. This method exists only to hideImmutableMap.toImmutableMap(Function, Function)
from consumers ofImmutableBiMap
.- Throws:
UnsupportedOperationException
- always
-
toImmutableMap
@Deprecated public static <T extends @Nullable Object,K,V> Collector<T,?,ImmutableMap<K,V>> toImmutableMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction, BinaryOperator<V> mergeFunction)
Deprecated.Not supported. This method does not make sense forBiMap
. This method exists only to hideImmutableMap.toImmutableMap(Function, Function, BinaryOperator)
from consumers ofImmutableBiMap
.- Throws:
UnsupportedOperationException
- always
-
-