|
||||||||||
| 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.
| 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 |
|---|
Map.Entry<K,V> |
| Method Summary | ||
|---|---|---|
static
|
builder()
Returns a new builder. |
|
void |
clear()
Guaranteed to throw an exception and leave the map unmodified. |
|
boolean |
containsKey(Object key)
|
|
abstract boolean |
containsValue(Object value)
|
|
static
|
copyOf(Map<? extends K,? extends V> map)
Returns an immutable map containing the same entries as map. |
|
abstract 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)
|
|
int |
hashCode()
|
|
boolean |
isEmpty()
|
|
abstract 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)
Guaranteed to throw an exception and leave the map unmodified. |
|
void |
putAll(Map<? extends K,? extends V> map)
Guaranteed to throw an exception and leave the map unmodified. |
|
V |
remove(Object o)
Guaranteed to throw an exception and leave the map unmodified. |
|
String |
toString()
|
|
abstract 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)
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 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
public final V put(K k,
V v)
put in interface Map<K,V>UnsupportedOperationException - alwayspublic final V remove(Object o)
remove in interface Map<K,V>UnsupportedOperationException - alwayspublic final void putAll(Map<? extends K,? extends V> map)
putAll in interface Map<K,V>UnsupportedOperationException - alwayspublic final void clear()
clear in interface Map<K,V>UnsupportedOperationException - alwayspublic boolean isEmpty()
isEmpty in interface Map<K,V>
public boolean containsKey(@Nullable
Object key)
containsKey in interface Map<K,V>
public abstract boolean containsValue(@Nullable
Object value)
containsValue in interface Map<K,V>
public abstract V get(@Nullable
Object key)
get in interface Map<K,V>public abstract ImmutableSet<Map.Entry<K,V>> entrySet()
entrySet in interface Map<K,V>public abstract ImmutableSet<K> keySet()
keySet in interface Map<K,V>public abstract ImmutableCollection<V> values()
values in interface Map<K,V>
public boolean equals(@Nullable
Object object)
equals in interface Map<K,V>equals in class Objectpublic int hashCode()
hashCode in interface Map<K,V>hashCode in class Objectpublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||