Class Multimaps.MapMultimap<K,V>
- java.lang.Object
-
- com.google.common.collect.AbstractMultimap<K,V>
-
- com.google.common.collect.Multimaps.MapMultimap<K,V>
-
- All Implemented Interfaces:
Multimap<K,V>
,SetMultimap<K,V>
,java.io.Serializable
- Enclosing class:
- Multimaps
private static class Multimaps.MapMultimap<K,V> extends AbstractMultimap<K,V> implements SetMultimap<K,V>, java.io.Serializable
- See Also:
Multimaps.forMap(java.util.Map<K, V>)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Values
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.util.Map<K,V>
map
private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description MapMultimap(java.util.Map<K,V> map)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes all key-value pairs from the multimap, leaving it empty.boolean
containsEntry(java.lang.Object key, java.lang.Object value)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.boolean
containsKey(java.lang.Object key)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.boolean
containsValue(java.lang.Object value)
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.(package private) java.util.Map<K,java.util.Collection<V>>
createAsMap()
java.util.Set<java.util.Map.Entry<K,V>>
entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.(package private) java.util.Iterator<java.util.Map.Entry<K,V>>
entryIterator()
java.util.Set<V>
get(K key)
Returns a view collection of the values associated withkey
in this multimap, if any.int
hashCode()
Returns the hash code for this multimap.java.util.Set<K>
keySet()
Returns a view collection of all distinct keys contained in this multimap.boolean
put(K key, V value)
Stores a key-value pair in this multimap.boolean
putAll(Multimap<? extends K,? extends V> multimap)
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.boolean
putAll(K key, java.lang.Iterable<? extends V> values)
Stores a key-value pair in this multimap for each ofvalues
, all using the same key,key
.boolean
remove(java.lang.Object key, java.lang.Object value)
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists.java.util.Set<V>
removeAll(java.lang.Object key)
Removes all values associated with the keykey
.java.util.Set<V>
replaceValues(K key, java.lang.Iterable<? extends V> values)
Stores a collection of values with the same key, replacing any existing values for that key.int
size()
Returns the number of key-value pairs in this multimap.java.util.Collection<V>
values()
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).-
Methods inherited from class com.google.common.collect.AbstractMultimap
asMap, createEntries, createKeys, createKeySet, createValues, equals, isEmpty, keys, toString, valueIterator
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.collect.SetMultimap
asMap, equals
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
size
public int size()
Description copied from interface:Multimap
Returns the number of key-value pairs in this multimap.Note: this method does not return the number of distinct keys in the multimap, which is given by
keySet().size()
orasMap().size()
. See the opening section of theMultimap
class documentation for clarification.
-
containsKey
public boolean containsKey(java.lang.Object key)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.- Specified by:
containsKey
in interfaceMultimap<K,V>
-
containsValue
public boolean containsValue(java.lang.Object value)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.- Specified by:
containsValue
in interfaceMultimap<K,V>
- Overrides:
containsValue
in classAbstractMultimap<K,V>
-
containsEntry
public boolean containsEntry(java.lang.Object key, java.lang.Object value)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.- Specified by:
containsEntry
in interfaceMultimap<K,V>
- Overrides:
containsEntry
in classAbstractMultimap<K,V>
-
get
public java.util.Set<V> get(K key)
Description copied from interface:SetMultimap
Returns a view collection of the values associated withkey
in this multimap, if any. Note that whencontainsKey(key)
is false, this returns an empty collection, notnull
.Changes to the returned collection will update the underlying multimap, and vice versa.
Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface.
-
put
public boolean put(K key, V value)
Description copied from interface:Multimap
Stores a key-value pair in this multimap.Some multimap implementations allow duplicate key-value pairs, in which case
put
always adds a new key-value pair and increases the multimap size by 1. Other implementations prohibit duplicates, and storing a key-value pair that's already in the multimap has no effect.
-
putAll
public boolean putAll(K key, java.lang.Iterable<? extends V> values)
Description copied from interface:Multimap
Stores a key-value pair in this multimap for each ofvalues
, all using the same key,key
. Equivalent to (but expected to be more efficient than):for (V value : values) { put(key, value); }
In particular, this is a no-op if
values
is empty.
-
putAll
public boolean putAll(Multimap<? extends K,? extends V> multimap)
Description copied from interface:Multimap
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.
-
replaceValues
public java.util.Set<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
Description copied from interface:Multimap
Stores a collection of values with the same key, replacing any existing values for that key.If
values
is empty, this is equivalent toremoveAll(key)
.- Specified by:
replaceValues
in interfaceMultimap<K,V>
- Specified by:
replaceValues
in interfaceSetMultimap<K,V>
- Overrides:
replaceValues
in classAbstractMultimap<K,V>
- Returns:
- the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.
-
remove
public boolean remove(java.lang.Object key, java.lang.Object value)
Description copied from interface:Multimap
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified.
-
removeAll
public java.util.Set<V> removeAll(java.lang.Object key)
Description copied from interface:SetMultimap
Removes all values associated with the keykey
.Once this method returns,
key
will not be mapped to any values, so it will not appear inMultimap.keySet()
,Multimap.asMap()
, or any other views.Because a
SetMultimap
has unique values for a given key, this method returns aSet
, instead of theCollection
specified in theMultimap
interface.
-
clear
public void clear()
Description copied from interface:Multimap
Removes all key-value pairs from the multimap, leaving it empty.
-
keySet
public java.util.Set<K> keySet()
Description copied from interface:Multimap
Returns a view collection of all distinct keys contained in this multimap. Note that the key set contains a key if and only if this multimap maps that key to at least one value.Changes to the returned set will update the underlying multimap, and vice versa. However, adding to the returned set is not possible.
-
values
public java.util.Collection<V> values()
Description copied from interface:Multimap
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
-
entries
public java.util.Set<java.util.Map.Entry<K,V>> entries()
Description copied from interface:Multimap
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
-
entryIterator
java.util.Iterator<java.util.Map.Entry<K,V>> entryIterator()
- Specified by:
entryIterator
in classAbstractMultimap<K,V>
-
createAsMap
java.util.Map<K,java.util.Collection<V>> createAsMap()
- Specified by:
createAsMap
in classAbstractMultimap<K,V>
-
hashCode
public int hashCode()
Description copied from class:AbstractMultimap
Returns the hash code for this multimap.The hash code of a multimap is defined as the hash code of the map view, as returned by
Multimap.asMap()
.
-
-