private static class Multimaps.MapMultimap<K,V> extends AbstractMultimap<K,V> implements SetMultimap<K,V>, java.io.Serializable
Multimaps.forMap(java.util.Map<K, V>)
AbstractMultimap.Values
Modifier and Type | Field and Description |
---|---|
(package private) java.util.Map<K,V> |
map |
private static long |
serialVersionUID |
Constructor and Description |
---|
MapMultimap(java.util.Map<K,V> map) |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all key-value pairs from the multimap, leaving it empty.
|
boolean |
containsEntry(java.lang.Object key,
java.lang.Object value)
Returns
true if this multimap contains at least one key-value pair
with the key key and the value value . |
boolean |
containsKey(java.lang.Object key)
Returns
true if this multimap contains at least one key-value pair
with the key key . |
boolean |
containsValue(java.lang.Object value)
Returns
true if this multimap contains at least one key-value pair
with the value value . |
(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, as
Map.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 with
key 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(K key,
java.lang.Iterable<? extends V> values)
Stores a key-value pair in this multimap for each of
values , all
using the same key, key . |
boolean |
putAll(Multimap<? extends K,? extends V> multimap)
Stores all key-value pairs of
multimap in this multimap, in the
order returned by multimap.entries() . |
boolean |
remove(java.lang.Object key,
java.lang.Object value)
Removes a single key-value pair with the key
key and the value
value from this multimap, if such exists. |
java.util.Set<V> |
removeAll(java.lang.Object key)
Removes all values associated with the key
key . |
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 (so
values().size() == size() ). |
asMap, createEntries, createKeys, createKeySet, createValues, equals, isEmpty, keys, toString, valueIterator
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asMap, equals
private static final long serialVersionUID
public int size()
Multimap
Note: this method does not return the number of distinct
keys in the multimap, which is given by keySet().size()
or
asMap().size()
. See the opening section of the Multimap
class documentation for clarification.
public boolean containsKey(java.lang.Object key)
Multimap
true
if this multimap contains at least one key-value pair
with the key key
.containsKey
in interface Multimap<K,V>
public boolean containsValue(java.lang.Object value)
Multimap
true
if this multimap contains at least one key-value pair
with the value value
.containsValue
in interface Multimap<K,V>
containsValue
in class AbstractMultimap<K,V>
public boolean containsEntry(java.lang.Object key, java.lang.Object value)
Multimap
true
if this multimap contains at least one key-value pair
with the key key
and the value value
.containsEntry
in interface Multimap<K,V>
containsEntry
in class AbstractMultimap<K,V>
public java.util.Set<V> get(K key)
SetMultimap
key
in this
multimap, if any. Note that when containsKey(key)
is false, this
returns an empty collection, not null
.
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 a Set
, instead of the Collection
specified in the Multimap
interface.
public boolean put(K key, V value)
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.
public boolean putAll(K key, java.lang.Iterable<? extends V> values)
Multimap
values
, 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.
public boolean putAll(Multimap<? extends K,? extends V> multimap)
Multimap
multimap
in this multimap, in the
order returned by multimap.entries()
.public java.util.Set<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
Multimap
If values
is empty, this is equivalent to
removeAll(key)
.
replaceValues
in interface Multimap<K,V>
replaceValues
in interface SetMultimap<K,V>
replaceValues
in class AbstractMultimap<K,V>
public boolean remove(java.lang.Object key, java.lang.Object value)
Multimap
key
and the value
value
from this multimap, if such exists. If multiple key-value
pairs in the multimap fit this description, which one is removed is
unspecified.public java.util.Set<V> removeAll(java.lang.Object key)
SetMultimap
key
.
Once this method returns, key
will not be mapped to any values,
so it will not appear in Multimap.keySet()
, Multimap.asMap()
, or any other
views.
Because a SetMultimap
has unique values for a given key, this
method returns a Set
, instead of the Collection
specified in the Multimap
interface.
public void clear()
Multimap
public java.util.Set<K> keySet()
Multimap
Changes to the returned set will update the underlying multimap, and vice versa. However, adding to the returned set is not possible.
public java.util.Collection<V> values()
Multimap
values().size() == size()
).
Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
public java.util.Set<java.util.Map.Entry<K,V>> entries()
Multimap
Map.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.
java.util.Iterator<java.util.Map.Entry<K,V>> entryIterator()
entryIterator
in class AbstractMultimap<K,V>
java.util.Map<K,java.util.Collection<V>> createAsMap()
createAsMap
in class AbstractMultimap<K,V>
public int hashCode()
AbstractMultimap
The hash code of a multimap is defined as the hash code of the map view,
as returned by Multimap.asMap()
.