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>

@GwtCompatible
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.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
java.util.SortedSet<V>	get(K key)	Returns a collection view containing the values associated with key in this multimap, if any.
java.util.SortedSet<V>	removeAll(java.lang.Object key)	Removes all values associated with a given key.
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, with null 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

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

entries, equals

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

asMap

Method Detail

get

public java.util.SortedSet<V> get(@Nullable
                                  K key)

Description copied from interface: Multimap

Returns a collection view containing the values associated with key in this multimap, if any. Note that even when (containsKey(key) is false, get(key) still 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,V>

Specified by:

get in interface SetMultimap<K,V>

Specified by:

get in interface SortedSetMultimap<K,V>

Overrides:

get in class ForwardingSetMultimap<K,V>

Parameters:

key - key to search for in multimap

Returns:

a view collection containing the zero or more values that the key maps to

removeAll

public java.util.SortedSet<V> removeAll(@Nullable
                                        java.lang.Object key)

Description copied from interface: Multimap

Removes all values associated with a given 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,V>

Specified by:

removeAll in interface SetMultimap<K,V>

Specified by:

removeAll in interface SortedSetMultimap<K,V>

Overrides:

removeAll in class ForwardingSetMultimap<K,V>

Parameters:

key - key of entries to remove from the multimap

Returns:

the collection of removed values, or an empty collection if no values were associated with the provided key. The 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: 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,V>

Specified by:

replaceValues in interface SetMultimap<K,V>

Specified by:

replaceValues in interface SortedSetMultimap<K,V>

Overrides:

replaceValues in class ForwardingSetMultimap<K,V>

Parameters:

key - key to store in the multimap

values - values to store in the multimap

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

public java.util.Comparator<? super V> valueComparator()

Description copied from interface: SortedSetMultimap

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

Specified by:

valueComparator in interface SortedSetMultimap<K,V>