Top Description Methods
com.google.common.collect

public Interface ListMultimap<K extends @Nullable Object, V extends @Nullable Object>

extends Multimap<K extends @Nullable Object, V extends @Nullable Object>
Known Direct Implementers
com.google.common.collect.Multimaps.UnmodifiableListMultimap, com.google.common.collect.Multimaps.TransformedEntriesListMultimap, com.google.common.collect.Synchronized.SynchronizedListMultimap, com.google.common.collect.AbstractListMultimap, com.google.common.collect.FilteredKeyListMultimap, com.google.common.collect.ForwardingListMultimap, com.google.common.collect.ImmutableListMultimap, com.google.common.collect.LinkedListMultimap
Annotations
@GwtCompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtCompatible, com.google.errorprone.annotations.CanIgnoreReturnValue, java.util.Collection, .List, .Map, javax.annotation.CheckForNull, org.checkerframework.checker.nullness.qual.Nullable
A Multimap that can hold duplicate key-value pairs and that maintains the insertion ordering of values for a given key. See the Multimap documentation for information common to all multimaps.

The get, removeAll, and replaceValues methods each return a List of values. Though the method signature doesn't say so explicitly, the map returned by asMap has List values.

See the Guava User Guide article on Multimap.

Author
Jared Levy
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public Map<K, Collection<V>>
asMap()

Redeclares com.google.common.collect.Multimap.asMap.

Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values.
public boolean
equals(Object obj)

Redeclares com.google.common.collect.Multimap.equals.

Compares the specified object to this multimap for equality.
public List<V>
get(K key)

Redeclares com.google.common.collect.Multimap.get.

Returns a view collection of the values associated with key in this multimap, if any.
public List<V>
removeAll(Object key)

Redeclares com.google.common.collect.Multimap.removeAll.

Removes all values associated with the key key.
public List<V>
replaceValues(K key, Iterable<? extends V> values)

Redeclares com.google.common.collect.Multimap.replaceValues.

Stores a collection of values with the same key, replacing any existing values for that key.
Inherited from com.google.common.collect.Multimap:
clearcontainsEntrycontainsKeycontainsValueentriesforEachhashCodeisEmptykeyskeySetputputAllputAllremovesizevalues

Method Detail

asMapback to summary
public Map<K, Collection<V>> asMap()

Redeclares com.google.common.collect.Multimap.asMap.

Doc from com.google.common.collect.Multimap.asMap.

Returns a view of this multimap as a 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.

Note

The returned map's values are guaranteed to be of type List. To obtain this map with the more specific generic type Map<K, List<V>>, call Multimaps#asMap(ListMultimap) instead.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Redeclares com.google.common.collect.Multimap.equals.

Compares the specified object to this multimap for equality.

Two ListMultimap instances are equal if, for each key, they contain the same values in the same order. If the value orderings disagree, the multimaps will not be considered equal.

An empty ListMultimap is equal to any other empty Multimap, including an empty SetMultimap.

Annotations
@Override
getback to summary
public List<V> get(K key)

Redeclares com.google.common.collect.Multimap.get.

Doc from com.google.common.collect.Multimap.get.

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.

Because the values for a given key may have duplicates and follow the insertion ordering, this method returns a List, instead of the java.util.Collection specified in the Multimap interface.

Annotations
@Override
removeAllback to summary
public List<V> removeAll(Object key)

Redeclares com.google.common.collect.Multimap.removeAll.

Doc from com.google.common.collect.Multimap.removeAll.

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 keySet(), asMap(), or any other views.

Because the values for a given key may have duplicates and follow the insertion ordering, this method returns a List, instead of the java.util.Collection specified in the Multimap interface.

Returns:List<V>

the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.

Annotations
@CanIgnoreReturnValue
@Override
replaceValuesback to summary
public List<V> replaceValues(K key, Iterable<? extends V> values)

Redeclares com.google.common.collect.Multimap.replaceValues.

Doc from com.google.common.collect.Multimap.replaceValues.

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).

Because the values for a given key may have duplicates and follow the insertion ordering, this method returns a List, instead of the java.util.Collection specified in the Multimap interface.

Returns:List<V>

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.

Annotations
@CanIgnoreReturnValue
@Override