Package com.google.common.collect
Class ImmutableMap<K,V>
- java.lang.Object
-
- com.google.common.collect.ImmutableMap<K,V>
-
- All Implemented Interfaces:
java.io.Serializable
,java.util.Map<K,V>
- Direct Known Subclasses:
ImmutableBiMap
,ImmutableMap.IteratorBasedImmutableMap
,ImmutableSortedMapFauxverideShim
,RegularImmutableMap
@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableMap<K,V> extends java.lang.Object implements java.util.Map<K,V>, java.io.Serializable
AMap
whose contents will never change, with many other important properties detailed atImmutableCollection
.See the Guava User Guide article on immutable collections.
- Since:
- 2.0
- 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, especiallypublic static final
maps ("constant maps").(package private) static class
ImmutableMap.IteratorBasedImmutableMap<K,V>
private class
ImmutableMap.MapViewOfValuesAsSingletonSets
(package private) static class
ImmutableMap.SerializedForm
Serialized type for all ImmutableMap instances.
-
Field Summary
Fields Modifier and Type Field Description (package private) static java.util.Map.Entry<?,?>[]
EMPTY_ENTRY_ARRAY
private ImmutableSet<java.util.Map.Entry<K,V>>
entrySet
private ImmutableSet<K>
keySet
private ImmutableSetMultimap<K,V>
multimapView
private ImmutableCollection<V>
values
-
Constructor Summary
Constructors Constructor Description ImmutableMap()
-
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.(package private) static void
checkNoConflict(boolean safe, java.lang.String conflictDescription, java.util.Map.Entry<?,?> entry1, java.util.Map.Entry<?,?> entry2)
void
clear()
Deprecated.Unsupported operation.boolean
containsKey(java.lang.Object key)
boolean
containsValue(java.lang.Object value)
static <K,V>
ImmutableMap<K,V>copyOf(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries)
Returns an immutable map containing the specified entries.static <K,V>
ImmutableMap<K,V>copyOf(java.util.Map<? extends K,? extends V> map)
Returns an immutable map containing the same entries asmap
.private static <K extends java.lang.Enum<K>,V>
ImmutableMap<K,V>copyOfEnumMap(java.util.EnumMap<K,? extends V> original)
(package private) abstract ImmutableSet<java.util.Map.Entry<K,V>>
createEntrySet()
(package private) ImmutableSet<K>
createKeySet()
(package private) ImmutableCollection<V>
createValues()
(package private) static <K,V>
ImmutableMapEntry<K,V>entryOf(K key, V value)
Verifies thatkey
andvalue
are non-null, and returns a new immutable entry with those values.ImmutableSet<java.util.Map.Entry<K,V>>
entrySet()
Returns an immutable set of the mappings in this map.boolean
equals(java.lang.Object object)
abstract V
get(java.lang.Object key)
int
hashCode()
boolean
isEmpty()
(package private) boolean
isHashCodeFast()
(package private) abstract boolean
isPartialView()
(package private) UnmodifiableIterator<K>
keyIterator()
ImmutableSet<K>
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.V
put(K k, V v)
Deprecated.Unsupported operation.void
putAll(java.util.Map<? extends K,? extends V> map)
Deprecated.Unsupported operation.V
remove(java.lang.Object o)
Deprecated.Unsupported operation.java.lang.String
toString()
ImmutableCollection<V>
values()
Returns an immutable collection of the values in this map.(package private) java.lang.Object
writeReplace()
-
-
-
Field Detail
-
EMPTY_ENTRY_ARRAY
static final java.util.Map.Entry<?,?>[] EMPTY_ENTRY_ARRAY
-
entrySet
private transient ImmutableSet<java.util.Map.Entry<K,V>> entrySet
-
keySet
private transient ImmutableSet<K> keySet
-
values
private transient ImmutableCollection<V> values
-
multimapView
private transient ImmutableSetMultimap<K,V> multimapView
-
-
Method Detail
-
of
public static <K,V> ImmutableMap<K,V> 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
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 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
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:
java.lang.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:
java.lang.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:
java.lang.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:
java.lang.IllegalArgumentException
- if duplicate keys are provided
-
entryOf
static <K,V> ImmutableMapEntry<K,V> entryOf(K key, V value)
Verifies thatkey
andvalue
are non-null, and returns a new immutable entry with those values.A call to
Map.Entry.setValue(V)
on the returned entry will always throwUnsupportedOperationException
.
-
builder
public static <K,V> ImmutableMap.Builder<K,V> builder()
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableMap.Builder
constructor.
-
checkNoConflict
static void checkNoConflict(boolean safe, java.lang.String conflictDescription, java.util.Map.Entry<?,?> entry1, java.util.Map.Entry<?,?> entry2)
-
copyOf
public static <K,V> ImmutableMap<K,V> copyOf(java.util.Map<? extends K,? extends V> map)
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:
java.lang.NullPointerException
- if any key or value inmap
is null
-
copyOf
@Beta public static <K,V> ImmutableMap<K,V> copyOf(java.lang.Iterable<? extends java.util.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:
java.lang.NullPointerException
- if any key, value, or entry is nulljava.lang.IllegalArgumentException
- if two entries have the same key- Since:
- 19.0
-
copyOfEnumMap
private static <K extends java.lang.Enum<K>,V> ImmutableMap<K,V> copyOfEnumMap(java.util.EnumMap<K,? extends V> original)
-
put
@Deprecated public final V put(K k, V v)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.
-
remove
@Deprecated public final V remove(java.lang.Object o)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.
-
putAll
@Deprecated public final void putAll(java.util.Map<? extends K,? extends V> map)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.
-
clear
@Deprecated public final void clear()
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.
-
containsKey
public boolean containsKey(@Nullable java.lang.Object key)
-
containsValue
public boolean containsValue(@Nullable java.lang.Object value)
-
get
public abstract V get(@Nullable java.lang.Object key)
-
entrySet
public ImmutableSet<java.util.Map.Entry<K,V>> 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.
-
createEntrySet
abstract ImmutableSet<java.util.Map.Entry<K,V>> createEntrySet()
-
keySet
public ImmutableSet<K> 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.
-
createKeySet
ImmutableSet<K> createKeySet()
-
keyIterator
UnmodifiableIterator<K> keyIterator()
-
values
public ImmutableCollection<V> 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.
-
createValues
ImmutableCollection<V> createValues()
-
asMultimap
public ImmutableSetMultimap<K,V> asMultimap()
Returns a multimap view of the map.- Since:
- 14.0
-
equals
public boolean equals(@Nullable java.lang.Object object)
-
isPartialView
abstract boolean isPartialView()
-
hashCode
public int hashCode()
-
isHashCodeFast
boolean isHashCodeFast()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
writeReplace
java.lang.Object writeReplace()
-
-