Package com.google.common.collect
Class ForwardingSortedSetMultimap<K,V>
java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMultimap<K,V>
com.google.common.collect.ForwardingSetMultimap<K,V>
com.google.common.collect.ForwardingSortedSetMultimap<K,V>
- All Implemented Interfaces:
Multimap<K,
,V> SetMultimap<K,
,V> SortedSetMultimap<K,
V>
public abstract class ForwardingSortedSetMultimap<K,V>
extends ForwardingSetMultimap<K,V>
implements SortedSetMultimap<K,V>
A sorted set multimap which forwards all its method calls to another sorted 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 ForwardingSortedSetMultimap
.
- Since:
- 3.0
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor for use by subclasses. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract SortedSetMultimap
<K, V> delegate()
Returns the backing delegate instance that methods are forwarded to.Returns a view collection of the values associated withkey
in 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.Comparator
<? super V> Returns the comparator that orders the multimap values, withnull
indicating that natural ordering is used.Methods inherited from class com.google.common.collect.ForwardingSetMultimap
entries
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, forEach, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
Methods inherited from interface com.google.common.collect.SetMultimap
entries, equals
Methods inherited from interface com.google.common.collect.SortedSetMultimap
asMap
-
Constructor Details
-
ForwardingSortedSetMultimap
protected ForwardingSortedSetMultimap()Constructor for use by subclasses.
-
-
Method Details
-
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 asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingSetMultimap<K,
V>
-
get
Description copied from interface:Multimap
Returns a view collection of the values associated withkey
in 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:Multimap
Removes all values associated with the keykey
.Once this method returns,
key
will not be mapped to any values, so it will not appear inMultimap.keySet()
,Multimap.asMap()
, or any other views.- Specified by:
removeAll
in interfaceMultimap<K,
V> - Specified by:
removeAll
in interfaceSetMultimap<K,
V> - Specified by:
removeAll
in interfaceSortedSetMultimap<K,
V> - Overrides:
removeAll
in classForwardingSetMultimap<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:Multimap
Stores a collection of values with the same key, replacing any existing values for that key.If
values
is empty, this is equivalent toremoveAll(key)
.- Specified by:
replaceValues
in interfaceMultimap<K,
V> - Specified by:
replaceValues
in interfaceSetMultimap<K,
V> - Specified by:
replaceValues
in interfaceSortedSetMultimap<K,
V> - Overrides:
replaceValues
in classForwardingSetMultimap<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.
-
valueComparator
Description copied from interface:SortedSetMultimap
Returns the comparator that orders the multimap values, withnull
indicating that natural ordering is used.- Specified by:
valueComparator
in interfaceSortedSetMultimap<K,
V>
-