|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.common.collect.ImmutableMap<K,V>
@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableMap<K,V>
An immutable, hash-based Map
with reliable user-specified iteration
order. Does not permit null keys or values.
Unlike Collections.unmodifiableMap(java.util.Map extends K, ? extends V>)
, which is a view of a
separate map which can still change, an instance of ImmutableMap
contains its own data and will never change. ImmutableMap
is
convenient for public static final
maps ("constant maps") and also
lets you easily make a "defensive copy" of a map provided to your class by a
caller.
Performance notes: unlike HashMap
, ImmutableMap
is
not optimized for element types that have slow Object.equals(java.lang.Object)
or
Object.hashCode()
implementations. You can get better performance by
having your element type cache its own hash codes, and by making use of the
cached values to short-circuit a slow equals
algorithm.
See the Guava User Guide article on immutable collections.
Nested Class Summary | |
---|---|
static class |
ImmutableMap.Builder<K,V>
A builder for creating immutable map instances, especially public
static final maps ("constant maps"). |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Method Summary | ||
---|---|---|
ImmutableSetMultimap<K,V> |
asMultimap()
Returns a multimap view of the map. |
|
static
|
builder()
Returns a new builder. |
|
void |
clear()
Deprecated. Unsupported operation. |
|
boolean |
containsKey(java.lang.Object key)
|
|
boolean |
containsValue(java.lang.Object value)
|
|
static
|
copyOf(java.util.Map<? extends K,? extends V> map)
Returns an immutable map containing the same entries as map . |
|
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()
|
|
ImmutableSet<K> |
keySet()
Returns an immutable set of the keys in this map. |
|
static
|
of()
Returns the empty map. |
|
static
|
of(K k1,
V v1)
Returns an immutable map containing a single entry. |
|
static
|
of(K k1,
V v1,
K k2,
V v2)
Returns an immutable map containing the given entries, in order. |
|
static
|
of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
Returns an immutable map containing the given entries, in order. |
|
static
|
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
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
size |
Method Detail |
---|
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 providedpublic static <K,V> ImmutableMap.Builder<K,V> builder()
ImmutableMap.Builder
constructor.
public static <K,V> ImmutableMap<K,V> copyOf(java.util.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.
java.lang.NullPointerException
- if any key or value in map
is null@Deprecated public final V put(K k, V v)
put
in interface java.util.Map<K,V>
java.lang.UnsupportedOperationException
- always@Deprecated public final V remove(java.lang.Object o)
remove
in interface java.util.Map<K,V>
java.lang.UnsupportedOperationException
- always@Deprecated public final void putAll(java.util.Map<? extends K,? extends V> map)
putAll
in interface java.util.Map<K,V>
java.lang.UnsupportedOperationException
- always@Deprecated public final void clear()
clear
in interface java.util.Map<K,V>
java.lang.UnsupportedOperationException
- alwayspublic boolean isEmpty()
isEmpty
in interface java.util.Map<K,V>
public boolean containsKey(@Nullable java.lang.Object key)
containsKey
in interface java.util.Map<K,V>
public boolean containsValue(@Nullable java.lang.Object value)
containsValue
in interface java.util.Map<K,V>
public abstract V get(@Nullable java.lang.Object key)
get
in interface java.util.Map<K,V>
public ImmutableSet<java.util.Map.Entry<K,V>> entrySet()
entrySet
in interface java.util.Map<K,V>
public ImmutableSet<K> keySet()
keySet
in interface java.util.Map<K,V>
public ImmutableCollection<V> values()
values
in interface java.util.Map<K,V>
@Beta public ImmutableSetMultimap<K,V> asMultimap()
public boolean equals(@Nullable java.lang.Object object)
equals
in interface java.util.Map<K,V>
equals
in class java.lang.Object
public int hashCode()
hashCode
in interface java.util.Map<K,V>
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |