Package com.google.common.collect
Class ForwardingSetMultimap<K,V>
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
public abstract class ForwardingSetMultimap<K,V>
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract SetMultimap<K, V> delegate()Returns the backing delegate instance that methods are forwarded to.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.Removes all values associated with the keykey.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, valuesMethods inherited from class com.google.common.collect.ForwardingObject
toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.collect.Multimap
clear, containsEntry, containsKey, containsValue, forEach, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, valuesMethods inherited from interface com.google.common.collect.SetMultimap
asMap, equals
-
Constructor Details
-
ForwardingSetMultimap
public ForwardingSetMultimap()
-
-
Method Details
-
delegate
Description copied from class:ForwardingObjectReturns 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 asForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegatein classForwardingMultimap<K,V>
-
entries
Description copied from interface:MultimapReturns 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.
-
get
Description copied from interface:MultimapReturns 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.
-
removeAll
Description copied from interface:MultimapRemoves 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.- Specified by:
removeAllin interfaceMultimap<K,V> - Specified by:
removeAllin interfaceSetMultimap<K,V> - Overrides:
removeAllin classForwardingMultimap<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
Description copied from interface:MultimapStores a collection of values with the same key, replacing any existing values for that key.If
valuesis empty, this is equivalent toremoveAll(key).- Specified by:
replaceValuesin interfaceMultimap<K,V> - Specified by:
replaceValuesin interfaceSetMultimap<K,V> - Overrides:
replaceValuesin classForwardingMultimap<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.
-