Top Description Constructors Methods
com.google.common.collect

public abstract Class ForwardingSortedSetMultimap<K extends @Nullable Object, V extends @Nullable Object>

extends ForwardingSetMultimap<K extends @Nullable Object, V extends @Nullable Object>
implements SortedSetMultimap<K extends @Nullable Object, V extends @Nullable Object>
Class Inheritance
All Implemented Interfaces
com.google.common.collect.SortedSetMultimap, com.google.common.collect.SetMultimap, com.google.common.collect.Multimap
Annotations
@GwtCompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtCompatible, java.util.Comparator, .SortedSet, javax.annotation.CheckForNull, org.checkerframework.checker.nullness.qual.Nullable
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.

Author
Kurt Alfred Kluever
Since
3.0

Constructor Summary

AccessConstructor and Description
protected
ForwardingSortedSetMultimap()

Constructor for use by subclasses.

Method Summary

Modifier and TypeMethod and Description
protected abstract SortedSetMultimap<K, V>
delegate()

Implements abstract com.google.common.collect.ForwardingSetMultimap.delegate.

Returns the backing delegate instance that methods are forwarded to.
public SortedSet<V>
get(K key)

Overrides com.google.common.collect.ForwardingSetMultimap.get.

Implements com.google.common.collect.SortedSetMultimap.get, com.google.common.collect.SetMultimap.get, com.google.common.collect.Multimap.get.

Returns a collection view of all values associated with a key.
public SortedSet<V>
removeAll(Object key)

Overrides com.google.common.collect.ForwardingSetMultimap.removeAll.

Implements com.google.common.collect.SortedSetMultimap.removeAll, com.google.common.collect.SetMultimap.removeAll, com.google.common.collect.Multimap.removeAll.

Removes all values associated with a given key.
public SortedSet<V>
replaceValues(K key, Iterable<? extends V> values)

Overrides com.google.common.collect.ForwardingSetMultimap.replaceValues.

Implements com.google.common.collect.SortedSetMultimap.replaceValues, com.google.common.collect.SetMultimap.replaceValues, com.google.common.collect.Multimap.replaceValues.

Stores a collection of values with the same key, replacing any existing values for that key.
public Comparator<? super V>
valueComparator()

Implements com.google.common.collect.SortedSetMultimap.valueComparator.

Returns the comparator that orders the multimap values, with null indicating that natural ordering is used.
Inherited from com.google.common.collect.ForwardingSetMultimap:
entries

Constructor Detail

ForwardingSortedSetMultimapback to summary
protected ForwardingSortedSetMultimap()

Constructor for use by subclasses.

Method Detail

delegateback to summary
protected abstract SortedSetMultimap<K, V> delegate()

Implements abstract com.google.common.collect.ForwardingSetMultimap.delegate.

Doc from com.google.common.collect.ForwardingObject.delegate.

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.

Annotations
@Override
getback to summary
public SortedSet<V> get(K key)

Overrides com.google.common.collect.ForwardingSetMultimap.get.

Implements com.google.common.collect.SortedSetMultimap.get, com.google.common.collect.SetMultimap.get, com.google.common.collect.Multimap.get.

Doc from com.google.common.collect.SortedSetMultimap.get.

Returns a collection view of all values associated with a key. If no mappings in the multimap have the provided key, an empty collection is returned.

Changes to the returned collection will update the underlying multimap, and vice versa.

Because a SortedSetMultimap has unique sorted values for a given key, this method returns a SortedSet, instead of the java.util.Collection specified in the Multimap interface.

Annotations
@Override
removeAllback to summary
public SortedSet<V> removeAll(Object key)

Overrides com.google.common.collect.ForwardingSetMultimap.removeAll.

Implements com.google.common.collect.SortedSetMultimap.removeAll, com.google.common.collect.SetMultimap.removeAll, com.google.common.collect.Multimap.removeAll.

Doc from com.google.common.collect.SortedSetMultimap.removeAll.

Removes all values associated with a given key.

Because a SortedSetMultimap has unique sorted values for a given key, this method returns a SortedSet, instead of the java.util.Collection specified in the Multimap interface.

Returns:SortedSet<V>

Doc from com.google.common.collect.Multimap.removeAll.

the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.

Annotations
@Override
replaceValuesback to summary
public SortedSet<V> replaceValues(K key, Iterable<? extends V> values)

Overrides com.google.common.collect.ForwardingSetMultimap.replaceValues.

Implements com.google.common.collect.SortedSetMultimap.replaceValues, com.google.common.collect.SetMultimap.replaceValues, com.google.common.collect.Multimap.replaceValues.

Doc from com.google.common.collect.SortedSetMultimap.replaceValues.

Stores a collection of values with the same key, replacing any existing values for that key.

Because a SortedSetMultimap has unique sorted values for a given key, this method returns a SortedSet, instead of the java.util.Collection specified in the Multimap interface.

Any duplicates in values will be stored in the multimap once.

Returns:SortedSet<V>

Doc from com.google.common.collect.Multimap.replaceValues.

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.

Annotations
@Override
valueComparatorback to summary
public Comparator<? super V> valueComparator()

Implements com.google.common.collect.SortedSetMultimap.valueComparator.

Doc from com.google.common.collect.SortedSetMultimap.valueComparator.

Returns the comparator that orders the multimap values, with null indicating that natural ordering is used.

Annotations
@Override
@CheckForNull