@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableMap<K,V> extends Objectimplements 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
A builder for creating immutable map instances, especially
public static final maps ("constant maps").
|
Modifier and Type | Method and Description |
---|---|
ImmutableSetMultimap |
asMultimap()
Returns a multimap view of the map.
|
static <K |
builder()
Returns a new builder.
|
void |
clear()
Deprecated.
Unsupported operation.
|
boolean |
containsKey(Object
|
boolean |
containsValue(Object
|
static <K |
copyOf(Iterable
Returns an immutable map containing the specified entries.
|
static <K |
copyOf(Map
Returns an immutable map containing the same entries as
map .
|
ImmutableSet |
entrySet()
Returns an immutable set of the mappings in this map.
|
boolean |
equals(Object
|
abstract V |
get(Object
|
int |
hashCode()
|
boolean |
isEmpty()
|
ImmutableSet |
keySet()
Returns an immutable set of the keys in this map.
|
static <K |
of()
Returns the empty map.
|
static <K |
of(K k1, V v1)
Returns an immutable map containing a single entry.
|
static <K |
of(K k1, V v1, K k2, V v2)
Returns an immutable map containing the given entries, in order.
|
static <K |
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 |
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 |
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
Deprecated.
Unsupported operation.
|
V |
remove(Object
Deprecated.
Unsupported operation.
|
String |
toString()
|
ImmutableCollection |
values()
Returns an immutable collection of the values in this map.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll, size
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 provided
public static <K,V> ImmutableMap <K ,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
IllegalArgumentException
- if duplicate keys are provided
public 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 provided
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)
IllegalArgumentException
- if duplicate keys are provided
public 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 null
IllegalArgumentException
- 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 remove(Objecto)
remove
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 clear()
clear
in interface
Map<K,V>
UnsupportedOperationException
- always
public boolean isEmpty()
public boolean containsKey(Objectkey)
public boolean containsValue(Objectvalue)
public ImmutableSet<Map .Entry <K ,V>> entrySet()
public ImmutableSet<K> keySet()
public ImmutableCollection<V> values()
@Beta public ImmutableSetMultimap<K ,V> asMultimap()
public boolean equals(Objectobject)
public int hashCode()
public StringtoString()