Package com.google.common.collect

Class ForwardingListMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

java.lang.Object

com.google.common.collect.ForwardingObject

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

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

All Implemented Interfaces:

ListMultimap<K,V>, Multimap<K,V>

@GwtCompatible
public abstract class ForwardingListMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
extends ForwardingMultimap<K,V>
implements ListMultimap<K,V>

A list multimap which forwards all its method calls to another list multimap. Subclasses should override one or more methods to modify the behavior of the backing multimap as desired per the decorator pattern.

default method warning: This class does not forward calls to default methods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on the ForwardingListMultimap.

Since:

3.0

Author:

Kurt Alfred Kluever

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingListMultimap()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
protected abstract ListMultimap<K,V>	delegate()	Returns the backing delegate instance that methods are forwarded to.
java.util.List<V>	get(K key)	Returns a view collection of the values associated with key in this multimap, if any.
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.ForwardingMultimap

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

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

toString

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

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

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

Constructor Detail

ForwardingListMultimap

protected ForwardingListMultimap()

Constructor for use by subclasses.

Method Detail

delegate

protected abstract ListMultimap<K,V> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

get

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

Description copied from interface: Multimap

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.

Specified by:

get in interface ListMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

Specified by:

get in interface Multimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

Overrides:

get in class ForwardingMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

removeAll

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

Description copied from interface: Multimap

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.

Specified by:

removeAll in interface ListMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

Specified by:

removeAll in interface Multimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

Overrides:

removeAll in class ForwardingMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.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.

replaceValues

@CanIgnoreReturnValue
public java.util.List<V> replaceValues(K key,
                                       java.lang.Iterable<? extends V> values)

Description copied from interface: Multimap

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).

Specified by:

replaceValues in interface ListMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

Specified by:

replaceValues in interface Multimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>

Overrides:

replaceValues in class ForwardingMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.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.