|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableMultimap<K,V>
@GwtCompatible(emulated=true) public abstract class ImmutableMultimap<K,V>
An immutable Multimap. Does not permit null keys or values.
Unlike Multimaps.unmodifiableMultimap(Multimap), which is
a view of a separate multimap which can still change, an instance of
ImmutableMultimap contains its own data and will never
change. ImmutableMultimap is convenient for
public static final multimaps ("constant multimaps") and also lets
you easily make a "defensive copy" of a multimap provided to your class by
a caller.
Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this class are guaranteed to be immutable.
In addition to methods defined by Multimap, an inverse()
method is also supported.
| Nested Class Summary | |
|---|---|
static class |
ImmutableMultimap.Builder<K,V>
A builder for creating immutable multimap instances, especially public static final multimaps ("constant multimaps"). |
| Method Summary | ||
|---|---|---|
ImmutableMap<K,Collection<V>> |
asMap()
Returns an immutable map that associates each key with its corresponding values in the multimap. |
|
static
|
builder()
Returns a new builder. |
|
void |
clear()
Guaranteed to throw an exception and leave the multimap unmodified. |
|
boolean |
containsEntry(Object key,
Object value)
Returns true if the multimap contains the specified key-value pair. |
|
boolean |
containsKey(Object key)
Returns true if the multimap contains any values for the specified
key. |
|
boolean |
containsValue(Object value)
Returns true if the multimap contains the specified value for any
key. |
|
static
|
copyOf(Multimap<? extends K,? extends V> multimap)
Returns an immutable multimap containing the same mappings as multimap. |
|
ImmutableCollection<Map.Entry<K,V>> |
entries()
Returns an immutable collection of all key-value pairs in the multimap. |
|
boolean |
equals(Object object)
Compares the specified object with this multimap for equality. |
|
abstract ImmutableCollection<V> |
get(K key)
Returns an immutable collection of the values for the given key. |
|
int |
hashCode()
Returns the hash code for this multimap. |
|
abstract ImmutableMultimap<V,K> |
inverse()
Returns an immutable multimap which is the inverse of this one. |
|
boolean |
isEmpty()
Returns true if the multimap contains no key-value pairs. |
|
ImmutableMultiset<K> |
keys()
Returns a collection, which may contain duplicates, of all keys. |
|
ImmutableSet<K> |
keySet()
Returns an immutable set of the distinct keys in this multimap. |
|
static
|
of()
Returns an empty multimap. |
|
static
|
of(K k1,
V v1)
Returns an immutable multimap containing a single entry. |
|
static
|
of(K k1,
V v1,
K k2,
V v2)
Returns an immutable multimap containing the given entries, in order. |
|
static
|
of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
Returns an immutable multimap 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 multimap 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 multimap containing the given entries, in order. |
|
boolean |
put(K key,
V value)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
boolean |
putAll(K key,
Iterable<? extends V> values)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
boolean |
putAll(Multimap<? extends K,? extends V> multimap)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
boolean |
remove(Object key,
Object value)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
ImmutableCollection<V> |
removeAll(Object key)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
ImmutableCollection<V> |
replaceValues(K key,
Iterable<? extends V> values)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
int |
size()
Returns the number of key-value pairs in the multimap. |
|
String |
toString()
|
|
ImmutableCollection<V> |
values()
Returns an immutable collection of the values in this multimap. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public static <K,V> ImmutableMultimap<K,V> of()
public static <K,V> ImmutableMultimap<K,V> of(K k1,
V v1)
public static <K,V> ImmutableMultimap<K,V> of(K k1,
V v1,
K k2,
V v2)
public static <K,V> ImmutableMultimap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3)
public static <K,V> ImmutableMultimap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4)
public static <K,V> ImmutableMultimap<K,V> of(K k1,
V v1,
K k2,
V v2,
K k3,
V v3,
K k4,
V v4,
K k5,
V v5)
public static <K,V> ImmutableMultimap.Builder<K,V> builder()
ImmutableMultimap.Builder constructor.
public static <K,V> ImmutableMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
multimap. The generated multimap's key and value orderings correspond to
the iteration ordering of the multimap.asMap() view.
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 multimap is
nullpublic ImmutableCollection<V> removeAll(Object key)
removeAll in interface Multimap<K,V>key - key of entries to remove from the multimap
UnsupportedOperationException - always
public ImmutableCollection<V> replaceValues(K key,
Iterable<? extends V> values)
replaceValues in interface Multimap<K,V>key - key to store in the multimapvalues - values to store in the multimap
UnsupportedOperationException - alwayspublic void clear()
clear in interface Multimap<K,V>UnsupportedOperationException - alwayspublic abstract ImmutableCollection<V> get(K key)
get in interface Multimap<K,V>key - key to search for in multimap
@Beta public abstract ImmutableMultimap<V,K> inverse()
public boolean put(K key,
V value)
put in interface Multimap<K,V>key - key to store in the multimapvalue - value to store in the multimap
true if the method increased the size of the multimap, or
false if the multimap already contained the key-value pair and
doesn't allow duplicates
UnsupportedOperationException - always
public boolean putAll(K key,
Iterable<? extends V> values)
putAll in interface Multimap<K,V>key - key to store in the multimapvalues - values to store in the multimap
true if the multimap changed
UnsupportedOperationException - alwayspublic boolean putAll(Multimap<? extends K,? extends V> multimap)
putAll in interface Multimap<K,V>multimap - mappings to store in this multimap
true if the multimap changed
UnsupportedOperationException - always
public boolean remove(Object key,
Object value)
remove in interface Multimap<K,V>key - key of entry to remove from the multimapvalue - value of entry to remove the multimap
true if the multimap changed
UnsupportedOperationException - always
public boolean containsEntry(@Nullable
Object key,
@Nullable
Object value)
Multimaptrue if the multimap contains the specified key-value pair.
containsEntry in interface Multimap<K,V>key - key to search for in multimapvalue - value to search for in multimap
public boolean containsKey(@Nullable
Object key)
Multimaptrue if the multimap contains any values for the specified
key.
containsKey in interface Multimap<K,V>key - key to search for in multimap
public boolean containsValue(@Nullable
Object value)
Multimaptrue if the multimap contains the specified value for any
key.
containsValue in interface Multimap<K,V>value - value to search for in multimappublic boolean isEmpty()
Multimaptrue if the multimap contains no key-value pairs.
isEmpty in interface Multimap<K,V>public int size()
Multimap
size in interface Multimap<K,V>
public boolean equals(@Nullable
Object object)
MultimapMultimap.asMap(),
are also equal.
In general, two multimaps with identical key-value mappings may or may
not be equal, depending on the implementation. For example, two
SetMultimap instances with the same key-value mappings are equal,
but equality of two ListMultimap instances depends on the ordering
of the values for each key.
A non-empty SetMultimap cannot be equal to a non-empty
ListMultimap, since their Multimap.asMap() views contain unequal
collections as values. However, any two empty multimaps are equal, because
they both have empty Multimap.asMap() views.
equals in interface Multimap<K,V>equals in class Objectpublic int hashCode()
MultimapThe hash code of a multimap is defined as the hash code of the map view,
as returned by Multimap.asMap().
hashCode in interface Multimap<K,V>hashCode in class Objectpublic String toString()
toString in class Objectpublic ImmutableSet<K> keySet()
keySet in interface Multimap<K,V>public ImmutableMap<K,Collection<V>> asMap()
asMap in interface Multimap<K,V>public ImmutableCollection<Map.Entry<K,V>> entries()
entries in interface Multimap<K,V>public ImmutableMultiset<K> keys()
keys in interface Multimap<K,V>public ImmutableCollection<V> values()
values in interface Multimap<K,V>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||