@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableMap<K,V> extends Object implements Map<K,V>, 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"). |
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.
|
V |
compute(K key,
BiFunction<? super K,? super V,? extends V> remappingFunction)
Deprecated.
Unsupported operation.
|
V |
computeIfAbsent(K key,
Function<? super K,? extends V> mappingFunction)
Deprecated.
Unsupported operation.
|
V |
computeIfPresent(K key,
BiFunction<? super K,? super V,? extends V> remappingFunction)
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) |
V |
getOrDefault(Object key,
V defaultValue) |
int |
hashCode() |
boolean |
isEmpty() |
ImmutableSet<K> |
keySet()
Returns an immutable set of the keys in this map.
|
V |
merge(K key,
V value,
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(Map<? extends K,? extends V> map)
Deprecated.
Unsupported operation.
|
V |
putIfAbsent(K key,
V value)
Deprecated.
Unsupported operation.
|
V |
remove(Object o)
Deprecated.
Unsupported operation.
|
boolean |
remove(Object key,
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(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 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> Collector<T,?,ImmutableMap<K,V>> |
toImmutableMap(Function<? super T,? extends K> keyFunction,
Function<? super T,? extends V> valueFunction,
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. |
String |
toString() |
ImmutableCollection<V> |
values()
Returns an immutable collection of the values in this map.
|
@Beta public static <T,K,V> Collector<T,?,ImmutableMap<K,V>> toImmutableMap(Function<? super T,? extends K> keyFunction, 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> Collector<T,?,ImmutableMap<K,V>> toImmutableMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction, 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)
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)
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)
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)
IllegalArgumentException
- if duplicate keys are providedpublic static <K,V> ImmutableMap.Builder<K,V> builder()
ImmutableMap.Builder
constructor.public static <K,V> ImmutableMap<K,V> copyOf(Map<? extends K,? extends V> map)
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.
NullPointerException
- if any key or value in map
is null@Beta public static <K,V> ImmutableMap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
NullPointerException
- if any key, value, or entry is nullIllegalArgumentException
- if two entries have the same key@Deprecated public final V put(K k, V v)
put
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V putIfAbsent(K key, V value)
putIfAbsent
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final boolean replace(K key, V oldValue, V newValue)
replace
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V replace(K key, V value)
replace
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
computeIfAbsent
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
computeIfPresent
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
compute
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
merge
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final void putAll(Map<? extends K,? extends V> map)
putAll
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final void replaceAll(BiFunction<? super K,? super V,? extends V> function)
replaceAll
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final V remove(Object o)
remove
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final boolean remove(Object key, Object value)
remove
in interface Map<K,V>
UnsupportedOperationException
- always@Deprecated public final void clear()
clear
in interface Map<K,V>
UnsupportedOperationException
- alwayspublic boolean containsKey(@Nullable Object key)
containsKey
in interface Map<K,V>
public boolean containsValue(@Nullable Object value)
containsValue
in interface Map<K,V>
public final V getOrDefault(@Nullable Object key, @Nullable V defaultValue)
getOrDefault
in interface Map<K,V>
public ImmutableSet<Map.Entry<K,V>> entrySet()
public ImmutableSet<K> keySet()
public ImmutableCollection<V> values()
public ImmutableSetMultimap<K,V> asMultimap()
public int hashCode()
Copyright © 2010-2017. All Rights Reserved.