Class Multimaps.TransformedEntriesMultimap<K,V1,V2>
- All Implemented Interfaces:
Multimap<K,V2>
- Direct Known Subclasses:
Multimaps.TransformedEntriesListMultimap
- Enclosing class:
Multimaps
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries, AbstractMultimap.EntrySet, AbstractMultimap.Values -
Field Summary
FieldsModifier and TypeFieldDescription(package private) final Maps.EntryTransformer<? super K, ? super V1, V2> -
Constructor Summary
ConstructorsConstructorDescriptionTransformedEntriesMultimap(Multimap<K, V1> fromMultimap, Maps.EntryTransformer<? super K, ? super V1, V2> transformer) -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Removes all key-value pairs from the multimap, leaving it empty.booleancontainsKey(Object key) Returnstrueif this multimap contains at least one key-value pair with the keykey.(package private) Map<K, Collection<V2>> (package private) Collection<Map.Entry<K, V2>> (package private) Collection<V2> Returns a view collection of the values associated withkeyin this multimap, if any.booleanisEmpty()Returnstrueif this multimap contains no key-value pairs.booleanStores a key-value pair in this multimap.booleanStores all key-value pairs ofmultimapin this multimap, in the order returned bymultimap.entries().booleanStores a key-value pair in this multimap for each ofvalues, all using the same key,key.booleanRemoves a single key-value pair with the keykeyand the valuevaluefrom this multimap, if such exists.Removes all values associated with the keykey.replaceValues(K key, Iterable<? extends V2> values) Stores a collection of values with the same key, replacing any existing values for that key.intsize()Returns the number of key-value pairs in this multimap.(package private) Collection<V2> transform(K key, Collection<V1> values) Methods inherited from class com.google.common.collect.AbstractMultimap
asMap, containsEntry, containsValue, entries, entrySpliterator, equals, hashCode, keys, keySet, toString, valueIterator, values, valueSpliterator
-
Field Details
-
fromMultimap
-
transformer
-
-
Constructor Details
-
TransformedEntriesMultimap
-
-
Method Details
-
transform
-
createAsMap
Map<K,Collection<V2>> createAsMap()- Specified by:
createAsMapin classAbstractMultimap<K,V2>
-
clear
public void clear()Description copied from interface:MultimapRemoves all key-value pairs from the multimap, leaving it empty. -
containsKey
Description copied from interface:MultimapReturnstrueif this multimap contains at least one key-value pair with the keykey. -
createEntries
Collection<Map.Entry<K,V2>> createEntries()- Specified by:
createEntriesin classAbstractMultimap<K,V2>
-
entryIterator
- Specified by:
entryIteratorin classAbstractMultimap<K,V2>
-
get
Description copied from interface:MultimapReturns a view collection of the values associated withkeyin 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:MultimapReturnstrueif this multimap contains no key-value pairs. Equivalent tosize() == 0, but can in some cases be more efficient. -
createKeySet
- Specified by:
createKeySetin classAbstractMultimap<K,V2>
-
createKeys
- Specified by:
createKeysin classAbstractMultimap<K,V2>
-
put
Description copied from interface:MultimapStores a key-value pair in this multimap.Some multimap implementations allow duplicate key-value pairs, in which case
putalways 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
Description copied from interface:MultimapStores 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
valuesis empty. -
putAll
Description copied from interface:MultimapStores all key-value pairs ofmultimapin this multimap, in the order returned bymultimap.entries(). -
remove
Description copied from interface:MultimapRemoves a single key-value pair with the keykeyand the valuevaluefrom this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified. -
removeAll
Description copied from interface:MultimapRemoves all values associated with the keykey.Once this method returns,
keywill 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
Description copied from interface:MultimapStores a collection of values with the same key, replacing any existing values for that key.If
valuesis empty, this is equivalent toremoveAll(key).- Specified by:
replaceValuesin interfaceMultimap<K,V1> - Overrides:
replaceValuesin 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:MultimapReturns 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 theMultimapclass documentation for clarification. -
createValues
Collection<V2> createValues()- Specified by:
createValuesin classAbstractMultimap<K,V2>
-