Class LinkedListMultimap<K extends @Nullable Object,V extends @Nullable Object>
- java.lang.Object
-
- com.google.common.collect.LinkedListMultimap<K,V>
-
- All Implemented Interfaces:
ListMultimap<K,V>
,Multimap<K,V>
,Serializable
@GwtCompatible(serializable=true, emulated=true) public class LinkedListMultimap<K extends @Nullable Object,V extends @Nullable Object> extends Object implements ListMultimap<K,V>, Serializable
An implementation ofListMultimap
that supports deterministic iteration order for both keys and values. The iteration order is preserved across non-distinct key values. For example, for the following multimap definition:
... the iteration order forMultimap<K, V> multimap = LinkedListMultimap.create(); multimap.put(key1, foo); multimap.put(key2, bar); multimap.put(key1, baz);
Multimap.keys()
is[key1, key2, key1]
, and similarly forentries()
. UnlikeLinkedHashMultimap
, the iteration order is kept consistent between keys, entries and values. For example, calling:multimap.remove(key1, foo);
changes the entries iteration order to
[key2=bar, key1=baz]
and the key iteration order to[key2, key1]
. Theentries()
iterator returns mutable map entries, andreplaceValues(K, java.lang.Iterable<? extends V>)
attempts to preserve iteration order as much as possible.The collections returned by
Multimap.keySet()
andasMap
iterate through the keys in the order they were first added to the multimap. Similarly,get(K)
,removeAll(java.lang.Object)
, andreplaceValues(K, java.lang.Iterable<? extends V>)
return collections that iterate through the values in the order they were added. The collections generated byentries()
,Multimap.keys()
, andvalues()
iterate across the key-value mappings in the order they were added to the multimap.The
values()
andentries()
methods both return aList
, instead of theCollection
specified by theListMultimap
interface.The methods
get(K)
,Multimap.keySet()
,Multimap.keys()
,values()
,entries()
, andasMap
return collections that are views of the multimap. If the multimap is modified while an iteration over any of those collections is in progress, except through the iterator's methods, the results of the iteration are undefined.Keys and values may be null. All optional multimap methods are supported, and all returned views are modifiable.
This class is not threadsafe when any concurrent operations update the multimap. Concurrent read operations will work correctly. To allow concurrent update operations, wrap your multimap with a call to
Multimaps.synchronizedListMultimap(com.google.common.collect.ListMultimap<K, V>)
.See the Guava User Guide article on
Multimap
.- Since:
- 2.0
- Author:
- Mike Bostock
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.void
clear()
Removes all key-value pairs from the multimap, leaving it empty.boolean
containsEntry(Object key, Object value)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.boolean
containsKey(Object key)
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.boolean
containsValue(Object value)
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.static <K extends @Nullable Object,V extends @Nullable Object>
LinkedListMultimap<K,V>create()
Creates a new, emptyLinkedListMultimap
with the default initial capacity.static <K extends @Nullable Object,V extends @Nullable Object>
LinkedListMultimap<K,V>create(int expectedKeys)
Constructs an emptyLinkedListMultimap
with enough capacity to hold the specified number of keys without rehashing.static <K extends @Nullable Object,V extends @Nullable Object>
LinkedListMultimap<K,V>create(Multimap<? extends K,? extends V> multimap)
Constructs aLinkedListMultimap
with the same mappings as the specifiedMultimap
.List<Map.Entry<K,V>>
entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.boolean
equals(Object object)
Indicates whether some other object is "equal to" this one.List<V>
get(K key)
Returns a view collection of the values associated withkey
in this multimap, if any.int
hashCode()
Returns the hash code for this multimap.boolean
isEmpty()
Returnstrue
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.Set<K>
keySet()
Returns a view collection of all distinct keys contained in this multimap.boolean
put(K key, V value)
Stores a key-value pair in the multimap.boolean
putAll(Multimap<? extends K,? extends V> multimap)
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.boolean
putAll(K key, Iterable<? extends V> values)
Stores a key-value pair in this multimap for each ofvalues
, all using the same key,key
.boolean
remove(Object key, Object value)
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists.List<V>
removeAll(@Nullable Object key)
Removes all values associated with the keykey
.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.int
size()
Returns the number of key-value pairs in this multimap.String
toString()
Returns a string representation of the multimap, generated by callingtoString
on the map returned byMultimap.asMap()
.List<V>
values()
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.collect.ListMultimap
asMap, equals
-
-
-
-
Method Detail
-
create
public static <K extends @Nullable Object,V extends @Nullable Object> LinkedListMultimap<K,V> create()
Creates a new, emptyLinkedListMultimap
with the default initial capacity.
-
create
public static <K extends @Nullable Object,V extends @Nullable Object> LinkedListMultimap<K,V> create(int expectedKeys)
Constructs an emptyLinkedListMultimap
with enough capacity to hold the specified number of keys without rehashing.- Parameters:
expectedKeys
- the expected number of distinct keys- Throws:
IllegalArgumentException
- ifexpectedKeys
is negative
-
create
public static <K extends @Nullable Object,V extends @Nullable Object> LinkedListMultimap<K,V> create(Multimap<? extends K,? extends V> multimap)
Constructs aLinkedListMultimap
with the same mappings as the specifiedMultimap
. The new multimap has the sameMultimap.entries()
iteration order as the input multimap.- Parameters:
multimap
- the multimap whose contents are copied to this 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()
orasMap().size()
. See the opening section of theMultimap
class documentation for clarification.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Multimap
Returnstrue
if this multimap contains no key-value pairs. Equivalent tosize() == 0
, but can in some cases be more efficient.
-
containsKey
public boolean containsKey(@CheckForNull Object key)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
.
-
containsValue
public boolean containsValue(@CheckForNull Object value)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the valuevalue
.
-
put
@CanIgnoreReturnValue public boolean put(K key, V value)
Stores a key-value pair in the multimap.
-
replaceValues
@CanIgnoreReturnValue public 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.If
values
is empty, this is equivalent toremoveAll(key)
.If any entries for the specified
key
already exist in the multimap, their values are changed in-place without affecting the iteration order.The returned list is immutable and implements
RandomAccess
.- Specified by:
replaceValues
in interfaceListMultimap<K extends @Nullable Object,V extends @Nullable Object>
- Specified by:
replaceValues
in interfaceMultimap<K extends @Nullable Object,V extends @Nullable Object>
- 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.
-
removeAll
@CanIgnoreReturnValue public List<V> removeAll(@Nullable Object key)
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.The returned list is immutable and implements
RandomAccess
.- Specified by:
removeAll
in interfaceListMultimap<K extends @Nullable Object,V extends @Nullable Object>
- Specified by:
removeAll
in interfaceMultimap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.
-
clear
public void clear()
Description copied from interface:Multimap
Removes all key-value pairs from the multimap, leaving it empty.
-
get
public List<V> get(K key)
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.If the multimap is modified while an iteration over the list is in progress (except through the iterator's own
add
,set
orremove
operations) the results of the iteration are undefined.The returned list is not serializable and does not have random access.
-
values
public List<V> values()
Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()
).Changes to the returned collection will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
The iterator generated by the returned collection traverses the values in the order they were added to the multimap. Because the values may have duplicates and follow the insertion ordering, this method returns a
List
, instead of theCollection
specified in theListMultimap
interface.
-
entries
public List<Map.Entry<K,V>> entries()
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entry
instances.Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
The iterator generated by the returned collection traverses the entries in the order they were added to the multimap. Because the entries may have duplicates and follow the insertion ordering, this method returns a
List
, instead of theCollection
specified in theListMultimap
interface.An entry's
Map.Entry.getKey()
method always returns the same key, regardless of what happens subsequently. As long as the corresponding key-value mapping is not removed from the multimap,Map.Entry.getValue()
returns the value from the multimap, which may change over time, andMap.Entry.setValue(V)
modifies that value. Removing the mapping from the multimap does not alter the value returned bygetValue()
, though a subsequentsetValue()
call won't update the multimap but will lead to a revised value being returned bygetValue()
.
-
containsEntry
public boolean containsEntry(@CheckForNull Object key, @CheckForNull Object value)
Description copied from interface:Multimap
Returnstrue
if this multimap contains at least one key-value pair with the keykey
and the valuevalue
.
-
remove
@CanIgnoreReturnValue public boolean remove(@CheckForNull Object key, @CheckForNull Object value)
Description copied from interface:Multimap
Removes a single key-value pair with the keykey
and the valuevalue
from this multimap, if such exists. If multiple key-value pairs in the multimap fit this description, which one is removed is unspecified.
-
putAll
@CanIgnoreReturnValue public boolean putAll(K key, Iterable<? extends V> values)
Description copied from interface:Multimap
Stores 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
values
is empty.
-
putAll
@CanIgnoreReturnValue public boolean putAll(Multimap<? extends K,? extends V> multimap)
Description copied from interface:Multimap
Stores all key-value pairs ofmultimap
in this multimap, in the order returned bymultimap.entries()
.
-
keySet
public 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.
-
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, andkeys().count(k) == get(k).size()
for allk
.Changes to the returned multiset will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.
-
asMap
public Map<K,Collection<V>> asMap()
Description copied from interface:Multimap
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
.
-
equals
public boolean equals(@CheckForNull Object object)
Description copied from class:java.lang.Object
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Specified by:
equals
in interfaceMultimap<K extends @Nullable Object,V extends @Nullable Object>
- Overrides:
equals
in classObject
- Parameters:
object
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public int hashCode()
Returns the hash code for this multimap.The hash code of a multimap is defined as the hash code of the map view, as returned by
Multimap.asMap()
.
-
toString
public String toString()
Returns a string representation of the multimap, generated by callingtoString
on the map returned byMultimap.asMap()
.
-
-