Class Multimaps.TransformedEntriesMultimap<K,V1,V2>
- java.lang.Object
-
- com.google.common.collect.AbstractMultimap<K,V2>
-
- com.google.common.collect.Multimaps.TransformedEntriesMultimap<K,V1,V2>
-
- All Implemented Interfaces:
Multimap<K,V2>
- Direct Known Subclasses:
Multimaps.TransformedEntriesListMultimap
- Enclosing class:
- Multimaps
private static class Multimaps.TransformedEntriesMultimap<K,V1,V2> extends AbstractMultimap<K,V2>
-
-
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) Multimap<K,V1>
fromMultimap
(package private) Maps.EntryTransformer<? super K,? super V1,V2>
transformer
-
Constructor Summary
Constructors Constructor Description TransformedEntriesMultimap(Multimap<K,V1> fromMultimap, Maps.EntryTransformer<? super K,? super V1,V2> transformer)
-
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
containsKey(java.lang.Object key)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.(package private) java.util.Map<K,java.util.Collection<V2>>
createAsMap()
(package private) java.util.Collection<V2>
createValues()
(package private) java.util.Iterator<java.util.Map.Entry<K,V2>>
entryIterator()
java.util.Collection<V2>
get(K key)
Returns a view collection of the values associated withkey
in this multimap, if any.boolean
isEmpty()
Returnstrue
if this multimap contains no key-value pairs.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, V2 value)
Stores a key-value pair in this multimap.boolean
putAll(Multimap<? extends K,? extends V2> multimap)
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.boolean
putAll(K key, java.lang.Iterable<? extends V2> 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.Collection<V2>
removeAll(java.lang.Object key)
Removes all values associated with the keykey
.java.util.Collection<V2>
replaceValues(K key, java.lang.Iterable<? extends V2> 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.(package private) java.util.Collection<V2>
transform(K key, java.util.Collection<V1> values)
-
Methods inherited from class com.google.common.collect.AbstractMultimap
asMap, containsEntry, containsValue, createEntries, createKeys, createKeySet, entries, equals, hashCode, toString, valueIterator, values
-
-
-
-
Method Detail
-
createAsMap
java.util.Map<K,java.util.Collection<V2>> createAsMap()
- Specified by:
createAsMap
in classAbstractMultimap<K,V2>
-
clear
public void clear()
Description copied from interface:Multimap
Removes all key-value pairs from the multimap, leaving it empty.
-
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
.
-
entryIterator
java.util.Iterator<java.util.Map.Entry<K,V2>> entryIterator()
- Specified by:
entryIterator
in classAbstractMultimap<K,V2>
-
get
public java.util.Collection<V2> get(K key)
Description copied from interface:Multimap
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.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Multimap
Returnstrue
if this multimap contains no key-value pairs. Equivalent tosize() == 0
, but can in some cases be more efficient.
-
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.
-
keys
public Multiset<K> keys()
Description copied from interface:Multimap
Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates. This collection has the same size as this multimap, andkeys().count(k) == get(k).size()
for allk
.Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
-
put
public boolean put(K key, V2 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 V2> 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 V2> multimap)
Description copied from interface:Multimap
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.
-
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.Collection<V2> removeAll(java.lang.Object key)
Description copied from interface:Multimap
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.- Returns:
- the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.
-
replaceValues
public java.util.Collection<V2> replaceValues(K key, java.lang.Iterable<? extends V2> 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,V1>
- Overrides:
replaceValues
in classAbstractMultimap<K,V2>
- 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.
-
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.
-
createValues
java.util.Collection<V2> createValues()
- Overrides:
createValues
in classAbstractMultimap<K,V2>
-
-