private static class Multimaps.UnmodifiableMultimap<K,V> extends ForwardingMultimap<K,V> implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
(package private) Multimap<K,V> |
delegate |
(package private) java.util.Collection<java.util.Map.Entry<K,V>> |
entries |
(package private) Multiset<K> |
keys |
(package private) java.util.Set<K> |
keySet |
(package private) java.util.Map<K,java.util.Collection<V>> |
map |
private static long |
serialVersionUID |
(package private) java.util.Collection<V> |
values |
Constructor and Description |
---|
UnmodifiableMultimap(Multimap<K,V> delegate) |
Modifier and Type | Method and Description |
---|---|
java.util.Map<K,java.util.Collection<V>> |
asMap()
Returns a view of this multimap as a
Map from each distinct key
to the nonempty collection of that key's associated values. |
void |
clear()
Removes all key-value pairs from the multimap, leaving it empty.
|
protected Multimap<K,V> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
java.util.Collection<java.util.Map.Entry<K,V>> |
entries()
Returns a view collection of all key-value pairs contained in this
multimap, as
Map.Entry instances. |
java.util.Collection<V> |
get(K key)
Returns a view collection of the values associated with
key in this
multimap, if any. |
Multiset<K> |
keys()
Returns a view collection containing the key from each key-value pair in
this multimap, without collapsing duplicates.
|
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.Collection<V> |
removeAll(java.lang.Object key)
Removes all values associated with the key
key . |
java.util.Collection<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.
|
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() ). |
containsEntry, containsKey, containsValue, equals, hashCode, isEmpty, size
toString
transient java.util.Set<K> keySet
transient java.util.Collection<V> values
private static final long serialVersionUID
protected Multimap<K,V> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.delegate
in class ForwardingMultimap<K,V>
public void clear()
Multimap
public java.util.Map<K,java.util.Collection<V>> asMap()
Multimap
Map
from each distinct key
to the nonempty collection of that key's associated values. Note that
this.asMap().get(k)
is equivalent to this.get(k)
only when
k
is a key contained in the multimap; otherwise it returns null
as opposed to an empty collection.
Changes to the returned map or the collections that serve as its values
will update the underlying multimap, and vice versa. The map does not
support put
or putAll
, nor do its entries support setValue
.
public java.util.Collection<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.
public java.util.Collection<V> get(K key)
Multimap
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.
public Multiset<K> keys()
Multimap
keys().count(k) ==
get(k).size()
for all k
.
Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
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 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 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.Collection<V> removeAll(java.lang.Object key)
Multimap
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.
public java.util.Collection<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 class ForwardingMultimap<K,V>
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.