com.google.common.collect

Class AbstractListMultimap<K,V>

java.lang.Object

com.google.common.collect.AbstractMultimap<K,V>

com.google.common.collect.AbstractMapBasedMultimap<K,V>

com.google.common.collect.AbstractListMultimap<K,V>

All Implemented Interfaces:

ListMultimap<K,V>, Multimap<K,V>, java.io.Serializable

Direct Known Subclasses:

ArrayListMultimap, Multimaps.CustomListMultimap

@GwtCompatible
abstract class AbstractListMultimap<K,V>
extends AbstractMapBasedMultimap<K,V>
implements ListMultimap<K,V>

Basic implementation of the ListMultimap interface. It's a wrapper around AbstractMapBasedMultimap that converts the returned collections into Lists. The createCollection() method must return a List.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.AbstractMapBasedMultimap

AbstractMapBasedMultimap.NavigableAsMap, AbstractMapBasedMultimap.NavigableKeySet, AbstractMapBasedMultimap.WrappedNavigableSet

Nested classes/interfaces inherited from class com.google.common.collect.AbstractMultimap

AbstractMultimap.Values

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractListMultimap(java.util.Map<K,java.util.Collection<V>> map) Creates a new multimap that uses the provided map.

Method Summary

Modifier and Type	Method and Description
java.util.Map<K,java.util.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.
(package private) abstract java.util.List<V>	createCollection() Creates the collection of values for a single key.
(package private) java.util.List<V>	createUnmodifiableEmptyCollection() Creates an unmodifiable, empty collection of values.
boolean	equals(java.lang.Object object) Compares the specified object to this multimap for equality.
java.util.List<V>	get(K key) Returns a view collection of the values associated with key in this multimap, if any.
boolean	put(K key, V value) Stores a key-value pair in the multimap.
java.util.List<V>	removeAll(java.lang.Object key) Removes all values associated with the key key.
java.util.List<V>	replaceValues(K key, java.lang.Iterable<? extends V> values) Stores a collection of values with the same key, replacing any existing values for that key.

Methods inherited from class com.google.common.collect.AbstractMapBasedMultimap

backingMap, clear, containsKey, createAsMap, createCollection, createKeySet, entries, entryIterator, setMap, size, unmodifiableCollectionSubclass, valueIterator, values, wrapCollection

Methods inherited from class com.google.common.collect.AbstractMultimap

containsEntry, containsValue, createEntries, createKeys, createValues, hashCode, isEmpty, keys, keySet, putAll, putAll, remove, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.collect.Multimap

clear, containsEntry, containsKey, containsValue, entries, hashCode, isEmpty, keys, keySet, putAll, putAll, remove, size, values

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AbstractListMultimap

protected AbstractListMultimap(java.util.Map<K,java.util.Collection<V>> map)

Creates a new multimap that uses the provided map.

Parameters:

map - place to store the mapping from each key to its corresponding values

Method Detail

createCollection

abstract java.util.List<V> createCollection()

Description copied from class: AbstractMapBasedMultimap

Creates the collection of values for a single key.

Collections with weak, soft, or phantom references are not supported. Each call to createCollection should create a new instance.

The returned collection class determines whether duplicate key-value pairs are allowed.

Specified by:

createCollection in class AbstractMapBasedMultimap<K,V>

Returns:

an empty collection of values

createUnmodifiableEmptyCollection

java.util.List<V> createUnmodifiableEmptyCollection()

Description copied from class: AbstractMapBasedMultimap

Creates an unmodifiable, empty collection of values.

This is used in AbstractMapBasedMultimap.removeAll(java.lang.Object) on an empty key.

Overrides:

createUnmodifiableEmptyCollection in class AbstractMapBasedMultimap<K,V>

get

public java.util.List<V> get(@Nullable
                             K key)

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.

The returned collection is not serializable.

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.

Specified by:

get in interface ListMultimap<K,V>

Specified by:

get in interface Multimap<K,V>

Overrides:

get in class AbstractMapBasedMultimap<K,V>

removeAll

public java.util.List<V> removeAll(@Nullable
                                   java.lang.Object key)

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

The returned collection is immutable.

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.

Specified by:

removeAll in interface ListMultimap<K,V>

Specified by:

removeAll in interface Multimap<K,V>

Overrides:

removeAll in class AbstractMapBasedMultimap<K,V>

Returns:

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

replaceValues

public java.util.List<V> replaceValues(@Nullable
                                       K key,
                                       java.lang.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 to removeAll(key).

The returned collection is immutable.

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.

Specified by:

replaceValues in interface ListMultimap<K,V>

Specified by:

replaceValues in interface Multimap<K,V>

Overrides:

replaceValues in class AbstractMapBasedMultimap<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.

put

public boolean put(@Nullable
                   K key,
                   @Nullable
                   V value)

Stores a key-value pair in the multimap.

Specified by:

put in interface Multimap<K,V>

Overrides:

put in class AbstractMapBasedMultimap<K,V>

Parameters:

key - key to store in the multimap

value - value to store in the multimap

Returns:

true always

asMap

public java.util.Map<K,java.util.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. 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.

Though the method signature doesn't say so explicitly, the returned map has List values.

Specified by:

asMap in interface ListMultimap<K,V>

Specified by:

asMap in interface Multimap<K,V>

Overrides:

asMap in class AbstractMultimap<K,V>

equals

public boolean equals(@Nullable
                      java.lang.Object object)

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.

Specified by:

equals in interface ListMultimap<K,V>

Specified by:

equals in interface Multimap<K,V>

Overrides:

equals in class AbstractMultimap<K,V>