Class ForwardingSetMultimap<K extends @Nullable Object, V extends @Nullable Object>

java.lang.Object

com.google.common.collect.ForwardingObject

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

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

All Implemented Interfaces:

Multimap<K,V>, SetMultimap<K,V>

Direct Known Subclasses:

ForwardingSortedSetMultimap

@GwtCompatible
public abstract class ForwardingSetMultimap<K extends @Nullable Object, V extends @Nullable Object>
extends ForwardingMultimap<K,V>
implements SetMultimap<K,V>

A set multimap which forwards all its method calls to another set 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 ForwardingSetMultimap.

Since:

3.0

Author:

Kurt Alfred Kluever

Constructor Summary

Constructors

Constructor	Description
ForwardingSetMultimap()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
protected abstract SetMultimap<K,V>	delegate()	Returns the backing delegate instance that methods are forwarded to.
Set<Map.Entry<K,V>>	entries()	Returns a view collection of all key-value pairs contained in this multimap, as Map.Entry instances.
Set<V>	get(K key)	Returns a view collection of the values associated with key in this multimap, if any.
Set<V>	removeAll(@Nullable Object key)	Removes all values associated with the key key.
Set<V>	replaceValues(K key, 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, 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.Multimap

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

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

asMap, equals

Constructor Details

ForwardingSetMultimap

public ForwardingSetMultimap()

Constructor for use by subclasses.

Method Details

delegate

protected abstract SetMultimap<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 Object, V extends @Nullable Object>

entries

public Set<Map.Entry<K,V>> entries()

Description copied from interface: Multimap

Returns a view collection of all key-value pairs contained in this multimap, as Map.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.

Specified by:

entries in interface Multimap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

entries in interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

entries in class ForwardingMultimap<K extends @Nullable Object, V extends @Nullable Object>

get

public Set<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 Multimap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

get in interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

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

removeAll

@CanIgnoreReturnValue
public Set<V> removeAll(@Nullable 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 Multimap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

removeAll in interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

removeAll in class ForwardingMultimap<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.

replaceValues

@CanIgnoreReturnValue
public Set<V> replaceValues(K key,
 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 Multimap<K extends @Nullable Object, V extends @Nullable Object>

Specified by:

replaceValues in interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

Overrides:

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