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

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, especially `public static final` bimaps ("constant bimaps").

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K extends Object,V extends Object>

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 as `map`.
`@Nullable 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 a `Collector` that accumulates elements into an `ImmutableBiMap` 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)`	Deprecated. Use `toImmutableBiMap(java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>)`.
`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 in `ImmutableMap.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 com.google.common.collect.BiMap
put, putAll

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 a Collector that accumulates elements into an ImmutableBiMap whose keys and values are the result of applying the provided mapping functions to the input elements. Entries appear in the result ImmutableBiMap in encounter order.
If the mapped keys or values contain duplicates (according to Object.equals(Object)), an IllegalArgumentException is thrown when the collection operation is performed. (This differs from the Collector returned by Collectors.toMap(Function, Function), which throws an IllegalStateException.)

Since:

21.0

of
```
public static <K,V> ImmutableBiMap<K,V> of()
```
Returns the empty bimap.
Performance note: the instance returned is a singleton.

of

public static <K,V> ImmutableBiMap<K,V> of(K k1,
                                                       V v1)

Returns an immutable bimap containing a single entry.