Class LinkedListMultimap<K,V>
- All Implemented Interfaces:
ListMultimap<K,,V> Multimap<K,,V> Serializable
ListMultimap 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:
Multimap<K, V> multimap = LinkedListMultimap.create();
multimap.put(key1, foo);
multimap.put(key2, bar);
multimap.put(key1, baz);
... the iteration order for AbstractMultimap.keys() is [key1, key2, key1], and similarly for
entries(). Unlike LinkedHashMultimap, 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]. The entries() iterator returns mutable map entries, and
replaceValues(K, java.lang.Iterable<? extends V>) attempts to preserve iteration order as much as possible.
The collections returned by AbstractMultimap.keySet() and AbstractMultimap.asMap iterate through the keys in
the order they were first added to the multimap. Similarly, get(K), removeAll(java.lang.Object), and
replaceValues(K, java.lang.Iterable<? extends V>) return collections that iterate through the values in the order they were
added. The collections generated by entries(), AbstractMultimap.keys(), and values()
iterate across the key-value mappings in the order they were added to the multimap.
The values() and entries() methods both return a List, instead of
the Collection specified by the ListMultimap interface.
The methods get(K), AbstractMultimap.keySet(), AbstractMultimap.keys(), values(), entries(), and AbstractMultimap.asMap 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate classAnIteratorover distinct keys in key head order.private static classprivate static final classprivate classAnIteratorover all nodes.private classAListIteratorover values for a specified key.Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap
AbstractMultimap.Entries, AbstractMultimap.EntrySet, AbstractMultimap.Values -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate LinkedListMultimap.Node<K,V> private Map<K,LinkedListMultimap.KeyList<K, V>> private intprivate static final longprivate intprivate LinkedListMultimap.Node<K,V> -
Constructor Summary
ConstructorsModifierConstructorDescription(package private)privateLinkedListMultimap(int expectedKeys) privateLinkedListMultimap(Multimap<? extends K, ? extends V> multimap) -
Method Summary
Modifier and TypeMethodDescriptionprivate LinkedListMultimap.Node<K,V> Adds a new node for the specified key-value pair before the specifiednextSiblingelement, or at the end of the list ifnextSiblingis null.voidclear()Removes all key-value pairs from the multimap, leaving it empty.booleancontainsKey(Object key) Returnstrueif this multimap contains at least one key-value pair with the keykey.booleancontainsValue(Object value) Returnstrueif this multimap contains at least one key-value pair with the valuevalue.static <K,V> LinkedListMultimap<K, V> create()Creates a new, emptyLinkedListMultimapwith the default initial capacity.static <K,V> LinkedListMultimap<K, V> create(int expectedKeys) Constructs an emptyLinkedListMultimapwith enough capacity to hold the specified number of keys without rehashing.static <K,V> LinkedListMultimap<K, V> Constructs aLinkedListMultimapwith the same mappings as the specifiedMultimap.(package private) Map<K,Collection<V>> entries()Returns a view collection of all key-value pairs contained in this multimap, asMap.Entryinstances.Returns a view collection of the values associated withkeyin this multimap, if any.booleanisEmpty()Returnstrueif this multimap contains no key-value pairs.booleanStores a key-value pair in the multimap.private voidreadObject(ObjectInputStream stream) Removes all values associated with the keykey.private voidremoveAllNodes(K key) Removes all nodes for the specified key.private voidremoveNode(LinkedListMultimap.Node<K, V> node) Removes the specified node from the linked list.replaceValues(K key, Iterable<? extends V> values) Stores a collection of values with the same key, replacing any existing values for that key.intsize()Returns the number of key-value pairs in this multimap.values()Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (sovalues().size() == size()).private voidwriteObject(ObjectOutputStream stream) Methods inherited from class com.google.common.collect.AbstractMultimap
asMap, containsEntry, entrySpliterator, equals, hashCode, keys, keySet, putAll, putAll, remove, toString, valueIterator, valueSpliteratorMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.collect.ListMultimap
asMap, equals
-
Field Details
-
head
-
tail
-
keyToKeyList
-
size
private transient int size -
modCount
private transient int modCount -
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
LinkedListMultimap
LinkedListMultimap() -
LinkedListMultimap
private LinkedListMultimap(int expectedKeys) -
LinkedListMultimap
-
-
Method Details
-
create
Creates a new, emptyLinkedListMultimapwith the default initial capacity. -
create
Constructs an emptyLinkedListMultimapwith enough capacity to hold the specified number of keys without rehashing.- Parameters:
expectedKeys- the expected number of distinct keys- Throws:
IllegalArgumentException- ifexpectedKeysis negative
-
create
Constructs aLinkedListMultimapwith 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
-
addNode
private LinkedListMultimap.Node<K,V> addNode(K key, V value, @CheckForNull LinkedListMultimap.Node<K, V> nextSibling) Adds a new node for the specified key-value pair before the specifiednextSiblingelement, or at the end of the list ifnextSiblingis null. Note: ifnextSiblingis specified, it MUST be for a node for the samekey! -
removeNode
Removes the specified node from the linked list. This method is only intended to be used from theIteratorclasses. See alsoremoveAllNodes(Object). -
removeAllNodes
Removes all nodes for the specified key. -
size
public int size()Description copied from interface:MultimapReturns 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 theMultimapclass documentation for clarification. -
isEmpty
public boolean isEmpty()Description copied from interface:MultimapReturnstrueif this multimap contains no key-value pairs. Equivalent tosize() == 0, but can in some cases be more efficient. -
containsKey
Description copied from interface:MultimapReturnstrueif this multimap contains at least one key-value pair with the keykey.- Specified by:
containsKeyin interfaceMultimap<K,V>
-
containsValue
Description copied from interface:MultimapReturnstrueif this multimap contains at least one key-value pair with the valuevalue.- Specified by:
containsValuein interfaceMultimap<K,V> - Overrides:
containsValuein classAbstractMultimap<K,V>
-
put
Stores a key-value pair in the multimap. -
replaceValues
Stores a collection of values with the same key, replacing any existing values for that key.If
valuesis empty, this is equivalent toremoveAll(key).If any entries for the specified
keyalready 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:
replaceValuesin interfaceListMultimap<K,V> - Specified by:
replaceValuesin interfaceMultimap<K,V> - Overrides:
replaceValuesin classAbstractMultimap<K,V> - 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.
-
getCopy
-
removeAll
Removes all values associated with the keykey.Once this method returns,
keywill 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 theCollectionspecified in theMultimapinterface.The returned list is immutable and implements
RandomAccess. -
clear
public void clear()Description copied from interface:MultimapRemoves all key-value pairs from the multimap, leaving it empty. -
get
Returns a view collection of the values associated withkeyin 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 theCollectionspecified in theMultimapinterface.If the multimap is modified while an iteration over the list is in progress (except through the iterator's own
add,setorremoveoperations) the results of the iteration are undefined.The returned list is not serializable and does not have random access.
-
createKeySet
- Specified by:
createKeySetin classAbstractMultimap<K,V>
-
createKeys
- Specified by:
createKeysin classAbstractMultimap<K,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 theCollectionspecified in theListMultimapinterface. -
createValues
- Specified by:
createValuesin classAbstractMultimap<K,V>
-
entries
Returns a view collection of all key-value pairs contained in this multimap, asMap.Entryinstances.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 theCollectionspecified in theListMultimapinterface.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(). -
createEntries
- Specified by:
createEntriesin classAbstractMultimap<K,V>
-
entryIterator
- Specified by:
entryIteratorin classAbstractMultimap<K,V>
-
createAsMap
Map<K,Collection<V>> createAsMap()- Specified by:
createAsMapin classAbstractMultimap<K,V>
-
writeObject
- Throws:
IOException
-
readObject
- Throws:
IOExceptionClassNotFoundException
-