Package 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A builder for creating immutable map instances, especiallypublic static final
maps ("constant maps"). -
Method Summary
Modifier and TypeMethodDescriptionReturns a multimap view of the map.static <K,
V> ImmutableMap.Builder <K, V> builder()
Returns a new builder.final void
clear()
Deprecated.Unsupported operation.boolean
containsKey
(Object key) boolean
containsValue
(Object value) static <K,
V> ImmutableMap <K, V> Returns an immutable map containing the specified entries.static <K,
V> ImmutableMap <K, V> Returns an immutable map containing the same entries asmap
.entrySet()
Returns an immutable set of the mappings in this map.boolean
abstract V
int
hashCode()
boolean
isEmpty()
keySet()
Returns an immutable set of the keys in this map.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.final V
Deprecated.Unsupported operation.final void
Deprecated.Unsupported operation.final V
Deprecated.Unsupported operation.toString()
values()
Returns an immutable collection of the values in this map.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 Details
-
of
Returns the empty map. This map behaves and performs comparably toCollections.emptyMap()
, and is preferable mainly for consistency and maintainability of your code. -
of
Returns an immutable map containing a single entry. This map behaves and performs comparably toCollections.singletonMap(K, V)
but will not accept a null key or value. It is preferable mainly for consistency and maintainability of your code. -
of
Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException
- if duplicate keys are provided
-
of
Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException
- if duplicate keys are provided
-
of
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
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableMap.Builder
constructor. -
copyOf
Returns an immutable map 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.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 inmap
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 nullIllegalArgumentException
- if two entries have the same key- Since:
- 19.0
-
put
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
put
in interfaceMap<K,
V> - Throws:
UnsupportedOperationException
- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
remove
in interfaceMap<K,
V> - Throws:
UnsupportedOperationException
- always
-
putAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
putAll
in interfaceMap<K,
V> - Throws:
UnsupportedOperationException
- always
-
clear
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
clear
in interfaceMap<K,
V> - Throws:
UnsupportedOperationException
- always
-
isEmpty
public boolean isEmpty() -
containsKey
- Specified by:
containsKey
in interfaceMap<K,
V>
-
containsValue
- Specified by:
containsValue
in interfaceMap<K,
V>
-
get
-
entrySet
Returns an immutable set of the mappings in this map. The entries are in the same order as the parameters used to build this map. -
keySet
Returns an immutable set of the keys in this map. These keys are in the same order as the parameters used to build this map. -
values
Returns an immutable collection of the values in this map. The values are in the same order as the parameters used to build this map. -
asMultimap
Returns a multimap view of the map.- Since:
- 14.0
-
equals
-
hashCode
public int hashCode() -
toString
-