Package com.google.common.collect
Class ForwardingSortedSetMultimap<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.ForwardingSetMultimap<K,V>
-
- com.google.common.collect.ForwardingSortedSetMultimap<K,V>
-
- All Implemented Interfaces:
Multimap<K,V>,SetMultimap<K,V>,SortedSetMultimap<K,V>
@GwtCompatible public abstract class ForwardingSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object> 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.defaultmethod warning: This class does not forward calls todefaultmethods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingSortedSetMultimap.- Since:
- 3.0
- Author:
- Kurt Alfred Kluever
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedForwardingSortedSetMultimap()Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract SortedSetMultimap<K,V>delegate()Returns the backing delegate instance that methods are forwarded to.java.util.SortedSet<V>get(K key)Returns a view collection of the values associated withkeyin this multimap, if any.java.util.SortedSet<V>removeAll(java.lang.Object key)Removes all values associated with the keykey.java.util.SortedSet<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.java.util.Comparator<? super V>valueComparator()Returns the comparator that orders the multimap values, withnullindicating 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 Detail
-
ForwardingSortedSetMultimap
protected ForwardingSortedSetMultimap()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract SortedSetMultimap<K,V> 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.
-
get
public java.util.SortedSet<V> get(K key)
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.
- Specified by:
getin interfaceMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Specified by:
getin interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Specified by:
getin interfaceSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Overrides:
getin classForwardingSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
-
removeAll
public java.util.SortedSet<V> removeAll(@CheckForNull java.lang.Object key)
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 extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Specified by:
removeAllin interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Specified by:
removeAllin interfaceSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Overrides:
removeAllin classForwardingSetMultimap<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
public java.util.SortedSet<V> replaceValues(K key, java.lang.Iterable<? extends V> values)
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 extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Specified by:
replaceValuesin interfaceSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Specified by:
replaceValuesin interfaceSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>- Overrides:
replaceValuesin classForwardingSetMultimap<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.
-
valueComparator
@CheckForNull public java.util.Comparator<? super V> valueComparator()
Description copied from interface:SortedSetMultimapReturns the comparator that orders the multimap values, withnullindicating that natural ordering is used.- Specified by:
valueComparatorin interfaceSortedSetMultimap<K extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
-
-