com.google.common.collect

Class ImmutableMap<K,V>

java.lang.Object

com.google.common.collect.ImmutableMap<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>

Direct Known Subclasses:

ImmutableBiMap, ImmutableSortedMap

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

Method Summary

Modifier and Type	Method and Description
ImmutableSetMultimap<K,V>	asMultimap() Returns a multimap view of the map.
static <K,V> ImmutableMap.Builder<K,V>	builder() Returns a new builder.
void	clear() 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)
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.
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.
V	put(K k, V v) Deprecated. Unsupported operation.
void	putAll(Map<? extends K,? extends V> map) Deprecated. Unsupported operation.
V	remove(Object o) Deprecated. Unsupported operation.
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

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Method Detail

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.

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.

of

public 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.

Throws:

IllegalArgumentException - if duplicate keys are provided

of

public 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.

Throws:

IllegalArgumentException - if duplicate keys are provided

of

public 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.

Throws:

IllegalArgumentException - if duplicate keys are provided

of

public 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.

Throws:

IllegalArgumentException - if duplicate keys are provided

builder

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

Returns a new builder. The generated builder is equivalent to the builder created by the ImmutableMap.Builder constructor.

copyOf

public static <K,V> ImmutableMap<K,V> copyOf(Map<? extends K,? extends V> map)

Returns an immutable map containing the same entries as map. The returned map iterates over entries in the same order as the entrySet of the original 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.

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:

NullPointerException - if any key or value in map is null

copyOf

@Beta
public static <K,V> ImmutableMap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)

Returns an immutable map containing the specified entries. The returned map iterates over entries in the same order as the original iterable.

Throws:

NullPointerException - if any key, value, or entry is null

IllegalArgumentException - if two entries have the same key

Since:

19.0

put

@Deprecated
public final V put(K k,
                               V v)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the map unmodified.

Specified by:

put in interface Map<K,V>

Throws:

UnsupportedOperationException - always

remove

@Deprecated
public final V remove(Object o)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the map unmodified.

Specified by:

remove in interface Map<K,V>

Throws:

UnsupportedOperationException - always

putAll

@Deprecated
public final void putAll(Map<? extends K,? extends V> map)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the map unmodified.

Specified by:

putAll in interface Map<K,V>

Throws:

UnsupportedOperationException - always

clear

@Deprecated
public final void clear()

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the map unmodified.

Specified by:

clear in interface Map<K,V>

Throws:

UnsupportedOperationException - always

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(@Nullable
                           Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(@Nullable
                             Object value)

Specified by:

containsValue in interface Map<K,V>

get

public abstract V get(@Nullable
                      Object key)

Specified by:

get in interface Map<K,V>

entrySet

public ImmutableSet<Map.Entry<K,V>> entrySet()

Returns an immutable set of the mappings in this map. The iteration order is specified by the method used to create this map. Typically, this is insertion order.

Specified by:

entrySet in interface Map<K,V>

keySet

public ImmutableSet<K> keySet()

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

Specified by:

keySet in interface Map<K,V>

values

public ImmutableCollection<V> values()

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

Specified by:

values in interface Map<K,V>

asMultimap

public ImmutableSetMultimap<K,V> asMultimap()

Returns a multimap view of the map.

Since:

14.0

equals

public boolean equals(@Nullable
                      Object object)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object