@GwtCompatible public interface ListMultimap<K,V> extends Multimap<K,V>
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(K)
, removeAll(java.lang.Object)
, and replaceValues(K, java.lang.Iterable<? extends V>)
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
.
Modifier and Type | Method and Description |
---|---|
Map<K,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. |
boolean |
equals(@Nullable Object obj)
Compares the specified object to this multimap for equality.
|
List<V> |
get(K key)
Returns a view collection of the values associated with
key in this multimap, if any. |
List<V> |
removeAll(@Nullable Object key)
Removes all values associated with the key
key . |
List<V> |
replaceValues(K key,
Iterable<? extends V> values)
Stores a collection of values with the same key, replacing any existing values for that key.
|
List<V> get(K key)
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 Collection
specified in
the Multimap
interface.
@CanIgnoreReturnValue List<V> removeAll(@Nullable Object 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.
Because the values for a given key may have duplicates and follow the insertion ordering,
this method returns a List
, instead of the Collection
specified in
the Multimap
interface.
@CanIgnoreReturnValue List<V> replaceValues(K key, Iterable<? extends V> values)
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 Collection
specified in
the Multimap
interface.
replaceValues
in interface Multimap<K,V>
Map<K,Collection<V>> asMap()
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.
boolean equals(@Nullable Object obj)
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
.
Copyright © 2010–2019. All rights reserved.