Class ImmutableMap<K,V>
- All Implemented Interfaces:
Serializable,Map<K,V>
- Direct Known Subclasses:
ImmutableBiMapFauxverideShim,ImmutableMap.IteratorBasedImmutableMap,ImmutableSortedMapFauxverideShim,JdkBackedImmutableMap,RegularImmutableMap
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 classA builder for creating immutable map instances, especiallypublic static finalmaps ("constant maps").(package private) static classprivate final class(package private) static classSerialized type for all ImmutableMap instances. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final Map.Entry<?,?>[] private ImmutableSet<Map.Entry<K,V>> private ImmutableSet<K>private ImmutableSetMultimap<K,V> private ImmutableCollection<V> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns 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 voidcheckNoConflict(boolean safe, String conflictDescription, Object entry1, Object entry2) final voidclear()Deprecated.Unsupported operation.final VDeprecated.Unsupported operation.final VcomputeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) Deprecated.Unsupported operation.final VcomputeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Deprecated.Unsupported operation.(package private) static IllegalArgumentExceptionconflictException(String conflictDescription, Object entry1, Object entry2) booleancontainsKey(Object key) booleancontainsValue(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.private static <K extends Enum<K>,V>
ImmutableMap<K,? extends V> copyOfEnumMap(EnumMap<?, ? extends V> original) (package private) abstract ImmutableSet<Map.Entry<K,V>> (package private) abstract ImmutableSet<K>(package private) abstract ImmutableCollection<V>(package private) static <K,V> Map.Entry<K, V> entryOf(K key, V value) Verifies thatkeyandvalueare non-null, and returns a new immutable entry with those values.entrySet()Returns an immutable set of the mappings in this map.booleanabstract Vfinal VgetOrDefault(Object key, V defaultValue) inthashCode()booleanisEmpty()(package private) boolean(package private) abstract boolean(package private) UnmodifiableIterator<K>keySet()Returns an immutable set of the keys in this map, in the same order that they appear inentrySet.(package private) Spliterator<K>final VDeprecated.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> Returns an immutable map containing the given entries, in order.final VDeprecated.Unsupported operation.final voidDeprecated.Unsupported operation.final VputIfAbsent(K key, V value) Deprecated.Unsupported operation.private voidreadObject(ObjectInputStream stream) final VDeprecated.Unsupported operation.final booleanDeprecated.Unsupported operation.final VDeprecated.Unsupported operation.final booleanDeprecated.Unsupported operation.final voidreplaceAll(BiFunction<? super K, ? super V, ? extends V> function) Deprecated.Unsupported operation.static <T,K, V> Collector<T, ?, ImmutableMap<K, V>> toImmutableMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction) Returns aCollectorthat accumulates elements into anImmutableMapwhose keys and values are the result of applying the provided mapping functions to the input elements.static <T,K, V> Collector<T, ?, ImmutableMap<K, V>> toImmutableMap(Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction, BinaryOperator<V> mergeFunction) Returns aCollectorthat accumulates elements into anImmutableMapwhose keys and values are the result of applying the provided mapping functions to the input elements.toString()values()Returns an immutable collection of the values in this map, in the same order that they appear inentrySet.(package private) ObjectReturns a serializable form of this object.
-
Field Details
-
EMPTY_ENTRY_ARRAY
-
entrySet
-
keySet
-
values
-
multimapView
-
-
Constructor Details
-
ImmutableMap
ImmutableMap()
-
-
Method Details
-
toImmutableMap
public static <T,K, Collector<T,V> ?, toImmutableMapImmutableMap<K, V>> (Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction) Returns aCollectorthat accumulates elements into anImmutableMapwhose keys and values are the result of applying the provided mapping functions to the input elements. Entries appear in the resultImmutableMapin encounter order.If the mapped keys contain duplicates (according to
Object.equals(Object), anIllegalArgumentExceptionis thrown when the collection operation is performed. (This differs from theCollectorreturned byCollectors.toMap(Function, Function), which throws anIllegalStateException.)- Since:
- 21.0
-
toImmutableMap
public static <T,K, Collector<T,V> ?, toImmutableMapImmutableMap<K, V>> (Function<? super T, ? extends K> keyFunction, Function<? super T, ? extends V> valueFunction, BinaryOperator<V> mergeFunction) Returns aCollectorthat accumulates elements into anImmutableMapwhose 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.- Since:
- 21.0
-
of
Returns the empty map. This map behaves and performs comparably toCollections.emptyMap(), and is preferable mainly for consistency and maintainability of your code.Performance note: the instance returned is a singleton.
-
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
-
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, K k6, V v6) Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException- if duplicate keys are provided- Since:
- 31.0
-
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, K k6, V v6, K k7, V v7) Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException- if duplicate keys are provided- Since:
- 31.0
-
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, K k6, V v6, K k7, V v7, K k8, V v8) Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException- if duplicate keys are provided- Since:
- 31.0
-
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, 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.- Throws:
IllegalArgumentException- if duplicate keys are provided- Since:
- 31.0
-
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, 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.- Throws:
IllegalArgumentException- if duplicate keys are provided- Since:
- 31.0
-
ofEntries
@SafeVarargs public static <K,V> ImmutableMap<K,V> ofEntries(Map.Entry<? extends K, ? extends V>... entries) Returns an immutable map containing the given entries, in order.- Throws:
IllegalArgumentException- if duplicate keys are provided- Since:
- 31.0
-
entryOf
Verifies thatkeyandvalueare 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
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableMap.Builderconstructor. -
builderWithExpectedSize
Returns a new builder, expecting the specified number of entries to be added.If
expectedSizeis exactly the number of entries added to the builder beforeImmutableMap.Builder.build(boolean)is called, the builder is likely to perform better than an unsizedbuilder()would have.It is not specified if any performance benefits apply if
expectedSizeis close to, but not exactly, the number of entries added to the builder.- Since:
- 23.1
-
checkNoConflict
-
conflictException
static IllegalArgumentException conflictException(String conflictDescription, Object entry1, Object entry2) -
copyOf
Returns an immutable map containing the same entries asmap. The returned map iterates over entries in the same order as theentrySetof the original map. Ifmapsomehow contains entries with duplicate keys (for example, if it is aSortedMapwhose 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 inmapis null
-
copyOf
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
-
copyOfEnumMap
private static <K extends Enum<K>,V> ImmutableMap<K,? extends V> copyOfEnumMap(EnumMap<?, ? extends V> original) -
put
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
putin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
putIfAbsent
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
putIfAbsentin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
replace
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
replacein interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
replace
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
replacein interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
computeIfAbsent
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
computeIfAbsentin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
computeIfPresent
@Deprecated @CheckForNull public final V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
computeIfPresentin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
compute
@Deprecated @CheckForNull public final V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
computein interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
merge
@Deprecated @CheckForNull public final V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> function) Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
mergein interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
putAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
putAllin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
replaceAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
replaceAllin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
removein interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
removein interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
clear
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the map unmodified.- Specified by:
clearin interfaceMap<K,V> - Throws:
UnsupportedOperationException- always
-
isEmpty
public boolean isEmpty() -
containsKey
- Specified by:
containsKeyin interfaceMap<K,V>
-
containsValue
- Specified by:
containsValuein interfaceMap<K,V>
-
get
-
getOrDefault
- Specified by:
getOrDefaultin interfaceMap<K,V> - Since:
- 21.0 (but only since 23.5 in the Android flavor). Note, however, that Java 8 users can call this method with any version and flavor of Guava.
-
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. -
createEntrySet
-
keySet
Returns an immutable set of the keys in this map, in the same order that they appear inentrySet. -
createKeySet
-
keyIterator
UnmodifiableIterator<K> keyIterator() -
keySpliterator
Spliterator<K> keySpliterator() -
values
Returns an immutable collection of the values in this map, in the same order that they appear inentrySet. -
createValues
-
asMultimap
Returns a multimap view of the map.- Since:
- 14.0
-
equals
-
isPartialView
abstract boolean isPartialView() -
hashCode
public int hashCode() -
isHashCodeFast
boolean isHashCodeFast() -
toString
-
writeReplace
Object writeReplace()Returns a serializable form of this object. Non-public subclasses should not override this method. Publicly-accessible subclasses must override this method and should return a subclass of SerializedForm whose readResolve() method returns objects of the subclass type. -
readObject
- Throws:
InvalidObjectException
-