java.lang.Object
- com.google.common.collect.ImmutableMap<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>

Direct Known Subclasses:

ImmutableBiMap, ImmutableSortedMap
```
@DoNotMock("Use ImmutableMap.of or another implementation")
@GwtCompatible(serializable=true,
               emulated=true)
public abstract class ImmutableMap<K,V>
extends Object
implements Map<K,V>, Serializable
```
A Map whose contents will never change, with many other important properties detailed at ImmutableCollection.
See the Guava User Guide article on immutable collections.

Since:

2.0

Author:

Jesse Wilson, Kevin Bourrillion

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ImmutableMap.Builder<K,V>`	A builder for creating immutable map instances, especially `public static final` maps ("constant maps").

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
`ImmutableSetMultimap<K,V>`	`asMultimap()`	Returns a multimap view of the map.
`static <K,V> ImmutableMap.Builder<K,V>`	`builder()`	Returns a new builder.
`static <K,V> ImmutableMap.Builder<K,V>`	`builderWithExpectedSize(int expectedSize)`	Returns a new builder, expecting the specified number of entries to be added.
`void`	`clear()`	Deprecated. Unsupported operation.
`V`	`compute(K key, BiFunction<? super K,? super @Nullable V,? extends @Nullable V> remappingFunction)`	Deprecated. Unsupported operation.
`V`	`computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)`	Deprecated. Unsupported operation.
`V`	`computeIfPresent(K key, BiFunction<? super K,? super V,? extends @Nullable V> remappingFunction)`	Deprecated. Unsupported operation.
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`static <K,V> ImmutableMap<K,V>`	`copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)`	Returns an immutable map containing the specified entries.
`static <K,V> ImmutableMap<K,V>`	`copyOf(Map<? extends K,? extends V> map)`	Returns an immutable map containing the same entries as `map`.
`ImmutableSet<Map.Entry<K,V>>`	`entrySet()`	Returns an immutable set of the mappings in this map.
`boolean`	`equals(Object object)`
`abstract V`	`get(Object key)`
`V`	`getOrDefault(Object key, V defaultValue)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`ImmutableSet<K>`	`keySet()`	Returns an immutable set of the keys in this map, in the same order that they appear in `entrySet`.
`V`	`merge(K key, V value, BiFunction<? super V,? super V,? extends @Nullable V> function)`	Deprecated. Unsupported operation.
`static <K,V> ImmutableMap<K,V>`	`of()`	Returns the empty map.
`static <K,V> ImmutableMap<K,V>`	`of(K k1, V v1)`	Returns an immutable map containing a single entry.
`static <K,V> ImmutableMap<K,V>`	`of(K k1, V v1, K k2, V v2)`	Returns an immutable map containing the given entries, in order.
`static <K,V> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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> ImmutableMap<K,V>`	`ofEntries(Map.Entry<? extends K,? extends V>... entries)`	Returns an immutable map containing the given entries, in order.
`V`	`put(K k, V v)`	Deprecated. Unsupported operation.
`void`	`putAll(Map<? extends K,? extends V> map)`	Deprecated. Unsupported operation.
`V`	`putIfAbsent(K key, V value)`	Deprecated. Unsupported operation.
`V`	`remove(Object o)`	Deprecated. Unsupported operation.
`boolean`	`remove(Object key, Object value)`	Deprecated. Unsupported operation.
`V`	`replace(K key, V value)`	Deprecated. Unsupported operation.
`boolean`	`replace(K key, V oldValue, V newValue)`	Deprecated. Unsupported operation.
`void`	`replaceAll(BiFunction<? super K,? super V,? extends V> function)`	Deprecated. Unsupported operation.
`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)`	Returns a `Collector` that accumulates elements into an `ImmutableMap` 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, BinaryOperator<V> mergeFunction)`	Returns a `Collector` that accumulates elements into an `ImmutableMap` whose keys and values are the result of applying the provided mapping functions to the input elements.
`String`	`toString()`
`ImmutableCollection<V>`	`values()`	Returns an immutable collection of the values in this map, in the same order that they appear in `entrySet`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
forEach, size

Method Detail

toImmutableMap
```
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)
```
Returns a Collector that accumulates elements into an ImmutableMap whose keys and values are the result of applying the provided mapping functions to the input elements. Entries appear in the result ImmutableMap in encounter order.
If the mapped keys 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

toImmutableMap

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)

Returns a Collector that accumulates elements into an ImmutableMap whose keys and values are the result of applying the provided mapping functions to the input elements.

If the mapped keys contain duplicates (according to Object.equals(Object)), the values are merged using the specified merging function. If the merging function returns null, then the collector removes the value that has been computed for the key thus far (though future occurrences of the key would reinsert it).

Entries will appear in the encounter order of the first occurrence of the key.

Since:: 21.0

of
```
public static <K,V> ImmutableMap<K,V> of()
```
Returns the empty map. This map behaves and performs comparably to Collections.emptyMap(), and is preferable mainly for consistency and maintainability of your code.
Performance note: the instance returned is a singleton.

of
```
public static <K,V> ImmutableMap<K,V> of(K k1,
                                                     V v1)
```
Returns an immutable map containing a single entry. This map behaves and performs comparably to Collections.singletonMap(K, V) but will not accept a null key or value. It is preferable mainly for consistency and maintainability of your code.