Multimaps.TransformedEntriesMultimap

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 and Description

(package private) Multimap<K,V1> fromMultimap

(package private) Maps.EntryTransformer<? super K,? super V1,V2> transformer

Fields
Modifier and Type	Field and Description
`(package private) Multimap<K,V1>`	`fromMultimap`
`(package private) Maps.EntryTransformer<? super K,? super V1,V2>`	`transformer`

Constructor Summary

Constructors
Constructor and Description

TransformedEntriesMultimap(Multimap<K,V1> fromMultimap, Maps.EntryTransformer<? super K,? super V1,V2> transformer)

Constructors
Constructor and 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 and Description
`void`	`clear()` Removes all key-value pairs from the multimap, leaving it empty.
`boolean`	`containsKey(java.lang.Object key)` Returns `true` if this multimap contains at least one key-value pair with the key `key`.
`(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 with `key` in this multimap, if any.
`boolean`	`isEmpty()` Returns `true` 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(K key, java.lang.Iterable<? extends V2> 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 V2> 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<V2>`	`removeAll(java.lang.Object key)` Removes all values associated with the key `key`.
`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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - fromMultimap
```
final Multimap<K,V1> fromMultimap
```
  - transformer
```
final Maps.EntryTransformer<? super K,? super V1,V2> transformer
```
- Constructor Detail
  - TransformedEntriesMultimap
```
TransformedEntriesMultimap(Multimap<K,V1> fromMultimap,
                           Maps.EntryTransformer<? super K,? super V1,V2> transformer)
```
- Method Detail
  - transform
```
java.util.Collection<V2> transform(K key,
                                   java.util.Collection<V1> values)
```
  - createAsMap
```
java.util.Map<K,java.util.Collection<V2>> createAsMap()
```
    Specified by:
    
    createAsMap in class AbstractMultimap<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
    
    Returns true if this multimap contains at least one key-value pair with the key key.
  - entryIterator
```
java.util.Iterator<java.util.Map.Entry<K,V2>> entryIterator()
```
    Specified by:
    
    entryIterator in class AbstractMultimap<K,V2>
  - get
```
public java.util.Collection<V2> get(K key)
```
    Description copied from interface: Multimap
    
    Returns a view collection of the values associated with 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.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Multimap
    
    Returns true if this multimap contains no key-value pairs. Equivalent to size() == 0, but can in some cases be more efficient.
    
    Specified by:
    
    isEmpty in interface Multimap<K,V2>
    
    Overrides:
    
    isEmpty in class AbstractMultimap<K,V2>
  - 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.
    
    Specified by:
    
    keySet in interface Multimap<K,V2>
    
    Overrides:
    
    keySet in class AbstractMultimap<K,V2>
  - 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, and 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.
    
    Specified by:
    
    keys in interface Multimap<K,V2>
    
    Overrides:
    
    keys in class AbstractMultimap<K,V2>
  - 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.
    
    Specified by:
    
    put in interface Multimap<K,V2>
    
    Overrides:
    
    put in class AbstractMultimap<K,V2>
    
    Returns:
    
    true if the method increased the size of the multimap, or false if the multimap already contained the key-value pair and doesn't allow duplicates
  - 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 of 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.
    Specified by:
    
    putAll in interface Multimap<K,V2>
    
    Overrides:
    
    putAll in class AbstractMultimap<K,V2>
    
    Returns:
    
    true if the multimap changed
  - putAll
```
public boolean putAll(Multimap<? extends K,? extends V2> multimap)
```
    Description copied from interface: Multimap
    
    Stores all key-value pairs of multimap in this multimap, in the order returned by multimap.entries().
    
    Specified by:
    
    putAll in interface Multimap<K,V2>
    
    Overrides:
    
    putAll in class AbstractMultimap<K,V2>
    
    Returns:
    
    true if the multimap changed
  - 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 key 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.
    
    Specified by:
    
    remove in interface Multimap<K,V2>
    
    Overrides:
    
    remove in class AbstractMultimap<K,V2>
    
    Returns:
    
    true if the multimap changed
  - removeAll
```
public java.util.Collection<V2> removeAll(java.lang.Object key)
```
    Description copied from interface: Multimap
    
    Removes all values associated with the key 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.
    
    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 to removeAll(key).
    
    Specified by:
    
    replaceValues in interface Multimap<K,V2>
    
    Overrides:
    
    replaceValues in class AbstractMultimap<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() or asMap().size(). See the opening section of the Multimap class documentation for clarification.
  - createValues
```
java.util.Collection<V2> createValues()
```
    Overrides:
    
    createValues in class AbstractMultimap<K,V2>

Class Multimaps.TransformedEntriesMultimap<K,V1,V2>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.common.collect.AbstractMultimap

Methods inherited from class java.lang.Object

Field Detail

fromMultimap

transformer

Constructor Detail

TransformedEntriesMultimap

Method Detail

transform

createAsMap

clear

containsKey

entryIterator

get

isEmpty

keySet

keys

put

putAll

putAll

remove

removeAll

replaceValues

size

createValues