@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableMap<K,V> extends java.lang.Object implements java.util.Map<K,V>, java.io.Serializable
Map
whose contents will never change, with many other important properties detailed at
ImmutableCollection
.
See the Guava User Guide article on immutable collections.
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"). |
(package private) static class |
ImmutableMap.IteratorBasedImmutableMap<K,V> |
private class |
ImmutableMap.MapViewOfValuesAsSingletonSets |
(package private) static class |
ImmutableMap.SerializedForm
Serialized type for all ImmutableMap instances.
|
Modifier and Type | Field and 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 and Description |
---|
ImmutableMap() |
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.
|
static <K,V> ImmutableMap.Builder<K,V> |
builderWithExpectedSize(int expectedSize)
Returns a new builder, expecting the specified number of entries to be added.
|
(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.
|
V |
compute(K key,
java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
Deprecated.
Unsupported operation.
|
V |
computeIfAbsent(K key,
java.util.function.Function<? super K,? extends V> mappingFunction)
Deprecated.
Unsupported operation.
|
V |
computeIfPresent(K key,
java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
Deprecated.
Unsupported operation.
|
(package private) static java.lang.IllegalArgumentException |
conflictException(java.lang.String conflictDescription,
java.lang.Object entry1,
java.lang.Object entry2) |
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 as
map . |
private static <K extends java.lang.Enum<K>,V> |
copyOfEnumMap(java.util.EnumMap<K,? extends V> original) |
(package private) abstract ImmutableSet<java.util.Map.Entry<K,V>> |
createEntrySet() |
(package private) abstract ImmutableSet<K> |
createKeySet() |
(package private) abstract ImmutableCollection<V> |
createValues() |
(package private) static <K,V> java.util.Map.Entry<K,V> |
entryOf(K key,
V value)
Verifies that
key and value 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) |
V |
getOrDefault(java.lang.Object key,
V defaultValue) |
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, in the same order that they appear in
entrySet . |
(package private) java.util.Spliterator<K> |
keySpliterator() |
V |
merge(K key,
V value,
java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
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.
|
V |
put(K k,
V v)
Deprecated.
Unsupported operation.
|
void |
putAll(java.util.Map<? extends K,? extends V> map)
Deprecated.
Unsupported operation.
|
V |
putIfAbsent(K key,
V value)
Deprecated.
Unsupported operation.
|
V |
remove(java.lang.Object o)
Deprecated.
Unsupported operation.
|
boolean |
remove(java.lang.Object key,
java.lang.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(java.util.function.BiFunction<? super K,? super V,? extends V> function)
Deprecated.
Unsupported operation.
|
static <T,K,V> java.util.stream.Collector<T,?,ImmutableMap<K,V>> |
toImmutableMap(java.util.function.Function<? super T,? extends K> keyFunction,
java.util.function.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,K,V> java.util.stream.Collector<T,?,ImmutableMap<K,V>> |
toImmutableMap(java.util.function.Function<? super T,? extends K> keyFunction,
java.util.function.Function<? super T,? extends V> valueFunction,
java.util.function.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. |
java.lang.String |
toString() |
ImmutableCollection<V> |
values()
Returns an immutable collection of the values in this map, in the same order that they appear
in
entrySet . |
(package private) java.lang.Object |
writeReplace() |
static final java.util.Map.Entry<?,?>[] EMPTY_ENTRY_ARRAY
private transient ImmutableSet<java.util.Map.Entry<K,V>> entrySet
private transient ImmutableSet<K> keySet
private transient ImmutableCollection<V> values
private transient ImmutableSetMultimap<K,V> multimapView
@Beta public static <T,K,V> java.util.stream.Collector<T,?,ImmutableMap<K,V>> toImmutableMap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)
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
.)
@Beta public static <T,K,V> java.util.stream.Collector<T,?,ImmutableMap<K,V>> toImmutableMap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction, java.util.function.BinaryOperator<V> mergeFunction)
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. Entries will appear in the encounter
order of the first occurrence of the key.
public static <K,V> ImmutableMap<K,V> of()
Collections.emptyMap()
, and is preferable mainly for consistency and maintainability of your
code.public static <K,V> ImmutableMap<K,V> of(K k1, V v1)
Collections.singletonMap(K, V)
but will not accept a null key or value. It is preferable
mainly for consistency and maintainability of your code.public static <K,V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2)
java.lang.IllegalArgumentException
- if duplicate keys are providedpublic static <K,V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
java.lang.IllegalArgumentException
- if duplicate keys are providedpublic static <K,V> ImmutableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
java.lang.IllegalArgumentException
- if duplicate keys are providedpublic 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)
java.lang.IllegalArgumentException
- if duplicate keys are providedstatic <K,V> java.util.Map.Entry<K,V> entryOf(K key, V value)
key
and value
are non-null, and returns a new immutable entry
with those values.
A call to Entry#setValue
on the returned entry will always throw UnsupportedOperationException
.
public static <K,V> ImmutableMap.Builder<K,V> builder()
ImmutableMap.Builder
constructor.@Beta public static <K,V> ImmutableMap.Builder<K,V> builderWithExpectedSize(int expectedSize)
If expectedSize
is exactly the number of entries added to the builder before ImmutableMap.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.
static void checkNoConflict(boolean safe, java.lang.String conflictDescription, java.util.Map.Entry<?,?> entry1, java.util.Map.Entry<?,?> entry2)
static java.lang.IllegalArgumentException conflictException(java.lang.String conflictDescription, java.lang.Object entry1, java.lang.Object entry2)
public static <K,V> ImmutableMap<K,V> copyOf(java.util.Map<? extends K,? extends V> map)
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.
java.lang.NullPointerException
- if any key or value in map
is null@Beta public static <K,V> ImmutableMap<K,V> copyOf(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>> entries)
java.lang.NullPointerException
- if any key, value, or entry is nulljava.lang.IllegalArgumentException
- if two entries have the same keyprivate static <K extends java.lang.Enum<K>,V> ImmutableMap<K,V> copyOfEnumMap(java.util.EnumMap<K,? extends V> original)
@Deprecated public final V put(K k, V v)
@Deprecated public final V putIfAbsent(K key, V value)
@Deprecated public final boolean replace(K key, V oldValue, V newValue)
@Deprecated public final V replace(K key, V value)
@Deprecated public final V computeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction)
@Deprecated public final V computeIfPresent(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
@Deprecated public final V compute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
@Deprecated public final V merge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
@Deprecated public final void putAll(java.util.Map<? extends K,? extends V> map)
@Deprecated public final void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
@Deprecated public final V remove(java.lang.Object o)
@Deprecated public final boolean remove(java.lang.Object key, java.lang.Object value)
@Deprecated public final void clear()
public boolean containsKey(java.lang.Object key)
public boolean containsValue(java.lang.Object value)
public ImmutableSet<java.util.Map.Entry<K,V>> entrySet()
abstract ImmutableSet<java.util.Map.Entry<K,V>> createEntrySet()
public ImmutableSet<K> keySet()
entrySet
.abstract ImmutableSet<K> createKeySet()
UnmodifiableIterator<K> keyIterator()
java.util.Spliterator<K> keySpliterator()
public ImmutableCollection<V> values()
entrySet
.abstract ImmutableCollection<V> createValues()
public ImmutableSetMultimap<K,V> asMultimap()
public boolean equals(java.lang.Object object)
abstract boolean isPartialView()
public int hashCode()
boolean isHashCodeFast()
public java.lang.String toString()
toString
in class java.lang.Object
java.lang.Object writeReplace()