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

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,V>

Method Summary

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.
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 <T,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,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,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,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.

Type Parameters:

K - the Map's key type

V - the Map'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 - the Map's key type

V - the Map's value type

Parameters:

k1 - the mapping's key

v1 - 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 - the Map's key type

V - the Map's value type

Parameters:

k1 - the first mapping's key

v1 - the first mapping's value

k2 - the second mapping's key

v2 - 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 - the Map's key type

V - the Map's value type

Parameters:

k1 - the first mapping's key

v1 - the first mapping's value

k2 - the second mapping's key

v2 - the second mapping's value

k3 - the third mapping's key

v3 - 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 - the Map's key type

V - the Map's value type

Parameters:

k1 - the first mapping's key

v1 - the first mapping's value

k2 - the second mapping's key

v2 - the second mapping's value

k3 - the third mapping's key

v3 - the third mapping's value

k4 - the fourth mapping's key

v4 - 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 - the Map's key type

V - the Map's value type

Parameters:

k1 - the first mapping's key

v1 - the first mapping's value

k2 - the second mapping's key

v2 - the second mapping's value

k3 - the third mapping's key

v3 - the third mapping's value

k4 - the fourth mapping's key

v4 - the fourth mapping's value

k5 - the fifth mapping's key

v5 - the fifth mapping's value

Returns:

a Map containing the specified mappings

Throws:

IllegalArgumentException - if duplicate keys or values are added

builder

public static <K,V> ImmutableBiMap.Builder<K,V> builder()

Returns a new builder. The generated builder is equivalent to the builder created by the ImmutableBiMap.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 before ImmutableBiMap.Builder.build() is called, the builder is likely to perform better than an unsized builder() 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 as map. If map somehow contains entries with duplicate keys (for example, if it is a SortedMap 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 the entrySet 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 - the Map's key type

V - the Map's value type

Parameters:

map - a Map from which entries are drawn, must be non-null

Returns:

a Map containing the entries of the given Map

Throws:

IllegalArgumentException - if two keys have the same value or two values have the same key

NullPointerException - if any key or value in map 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 key

NullPointerException - 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 another ImmutableBiMap.

Specified by:

inverse in interface BiMap<K,V>

Returns:

the inverse view of this bimap

values

public ImmutableSet<V> values()

Returns an immutable set of the values in this map, in the same order they appear in ImmutableMap.entrySet.

Specified by:

values in interface BiMap<K,V>

Specified by:

values in interface Map<K,V>

Overrides:

values in class ImmutableMap<K,V>

Returns:

a collection view of the values contained in this map

forcePut

@CanIgnoreReturnValue
@Deprecated
public V forcePut(K key,
                  V value)

Deprecated.

Unsupported operation.

Guaranteed to throw an exception and leave the bimap unmodified.

Specified by:

forcePut in interface BiMap<K,V>

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

Returns:

the value which was previously associated with the key, which may be null, or null if there was no previous entry

Throws:

UnsupportedOperationException - always

toImmutableMap

@Deprecated
public static <T,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>).

Not supported. Use toImmutableBiMap(java.util.function.Function<? super T, ? extends K>, java.util.function.Function<? super T, ? extends V>) instead. This method exists only to hide ImmutableMap.toImmutableMap(Function, Function) from consumers of ImmutableBiMap.

Throws:

UnsupportedOperationException - always

toImmutableMap

@Deprecated
public static <T,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 for BiMap. This method exists only to hide ImmutableMap.toImmutableMap(Function, Function, BinaryOperator) from consumers of ImmutableBiMap.

Throws:

UnsupportedOperationException - always