Interface ListMultimap<K,V>
- All Superinterfaces:
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
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
.
- Since:
- 2.0 (imported from Google Collections Library)
- Author:
- Jared Levy
-
Method Summary
Modifier and TypeMethodDescriptionMap<K,
Collection<V>> asMap()
Returns a view of this multimap as aMap
from each distinct key to the nonempty collection of that key's associated values.boolean
Compares the specified object to this multimap for equality.Returns a view collection of the values associated withkey
in this multimap, if any.Removes all values associated with the keykey
.Methods inherited from interface org.glassfish.jersey.internal.guava.Multimap
clear, containsEntry, containsKey, containsValue, entries, hashCode, keySet, put, putAll, remove, size, values
-
Method Details
-
get
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.
Because the values for a given key may have duplicates and follow the insertion ordering, this method returns a
List
, instead of theCollection
specified in theMultimap
interface. -
removeAll
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.Because the values for a given key may have duplicates and follow the insertion ordering, this method returns a
List
, instead of theCollection
specified in theMultimap
interface. -
asMap
Map<K,Collection<V>> asMap()Returns a view of this multimap as aMap
from each distinct key to the nonempty collection of that key's associated values. Note thatthis.asMap().get(k)
is equivalent tothis.get(k)
only whenk
is a key contained in the multimap; otherwise it returnsnull
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
orputAll
, nor do its entries supportsetValue
.Note: The returned map's values are guaranteed to be of type
List
. To obtain this map with the more specific generic typeMap<K, List<V>>
, callMultimaps#asMap(ListMultimap)
instead. -
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 emptyMultimap
, including an emptySetMultimap
.
-