|
|||||||||
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>
public class ImmutableMultimap<K,V>
An immutable ListMultimap
with reliable user-specified key and value
iteration order. Does not permit null keys or values.
Unlike Multimaps.unmodifiableListMultimap(ListMultimap)
, which is
a view of a separate map 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.
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 . |
|
static
|
empty()
Returns the empty multimap. |
|
ImmutableCollection<Map.Entry<K,V>> |
entries()
Returns an immutable collection of all key-value pairs in the multimap. |
|
boolean |
equals(Object obj)
Compares the specified object to this multimap for equality. |
|
ImmutableList<V> |
get(K key)
Returns an immutable list of the values for the given key. |
|
int |
hashCode()
Returns the hash code for this multimap. |
|
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. |
|
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. |
|
List<V> |
removeAll(Object key)
Guaranteed to throw an exception and leave the multimap unmodified. |
|
List<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> empty()
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.
Note: Despite what the method name suggests, if
multimap
is an ImmutableMultimap
, no copy will actually be
performed, and the given map itself will be returned.
NullPointerException
- if any key or value in multimap
is
nullpublic List<V> removeAll(Object key)
removeAll
in interface ListMultimap<K,V>
removeAll
in interface Multimap<K,V>
key
- key of entries to remove from the multimap
UnsupportedOperationException
- alwayspublic List<V> replaceValues(K key, Iterable<? extends V> values)
replaceValues
in interface ListMultimap<K,V>
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 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
- alwayspublic 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
- alwayspublic 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
- alwayspublic boolean containsEntry(@Nullable Object key, @Nullable Object value)
Multimap
true
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 multimappublic boolean containsKey(@Nullable Object key)
Multimap
true
if the multimap contains any values for the specified
key.
containsKey
in interface Multimap<K,V>
key
- key to search for in multimappublic boolean containsValue(@Nullable Object value)
Multimap
true
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()
Multimap
true
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 obj)
ListMultimap
Two ListMultimap
instances are equal if, for each key, they
contain the same values in the same order. If the value orderings disagree,
the multimaps will not be considered equal.
equals
in interface ListMultimap<K,V>
equals
in interface Multimap<K,V>
equals
in class Object
public int hashCode()
Multimap
The 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 Object
public String toString()
toString
in class Object
public ImmutableList<V> get(@Nullable K key)
get
in interface ListMultimap<K,V>
get
in interface Multimap<K,V>
key
- key to search for in multimap
public ImmutableSet<K> keySet()
keySet
in interface Multimap<K,V>
public ImmutableMap<K,Collection<V>> asMap()
ImmutableList
values.
asMap
in interface ListMultimap<K,V>
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 |