Guava: Google Core Libraries for Java 32.1.2-jre · com.google.common.collect.SortedSetMultimap

A SetMultimap whose set of values for a given key are kept sorted; that is, they comprise a SortedSet. It cannot hold duplicate key-value pairs; adding a key-value pair that's already in the multimap has no effect. This interface does not specify the ordering of the multimap's keys. See the Multimap documentation for information common to all multimaps.

The get, removeAll, and replaceValues methods each return a SortedSet of values, while Multimap#entries() returns a Set of map entries. Though the method signature doesn't say so explicitly, the map returned by asMap has SortedSet values.

Warning

As in all SetMultimaps, do not modify either a key or a value of a SortedSetMultimap in a way that affects its Object#equals behavior (or its position in the order of the values). Undefined behavior and bugs will result.

See the Guava User Guide article on Multimap.

Method Summary

Modifier and Type	Method and Description
public Map<K, Collection<V>>	asMap() Redeclares com.google.common.collect.SetMultimap.asMap. Returns a map view that associates each key with the corresponding values in the multimap.
public SortedSet<V>	get(K key) Redeclares com.google.common.collect.SetMultimap.get. Returns a collection view of all values associated with a key.
public SortedSet<V>	removeAll(Object key) Redeclares com.google.common.collect.SetMultimap.removeAll. Removes all values associated with a given key.
public SortedSet<V>	replaceValues(K key, Iterable<? extends V> values) Redeclares com.google.common.collect.SetMultimap.replaceValues. Stores a collection of values with the same key, replacing any existing values for that key.
public Comparator<? super V>	valueComparator() Returns the comparator that orders the multimap values, with `null` indicating that natural ordering is used.

Inherited from com.google.common.collect.SetMultimap:: entries equals

Method Detail

asMap back to summary

asMap	back to summary
public Map<K, Collection<V>> asMap() Redeclares com.google.common.collect.SetMultimap.asMap. Returns a map view that associates each key with the corresponding values in the multimap. Changes to the returned map, such as element removal, will update the underlying multimap. The map does not support `setValue()` on its entries, `put`, or `putAll`. When passed a key that is present in the map, `asMap().get(Object)` has the same behavior as `get`, returning a live collection. When passed a key that is not present, however, `asMap().get(Object)` returns `null` instead of an empty collection. Note The returned map's values are guaranteed to be of type `SortedSet`. To obtain this map with the more specific generic type `Map<K, SortedSet<V>>`, call `Multimaps#asMap(SortedSetMultimap)` instead. However, the returned map itself is not necessarily a `SortedMap`: A `SortedSetMultimap` must expose the values for a given key in sorted order, but it need not expose the keys in sorted order. Individual `SortedSetMultimap` implementations, like those built with `MultimapBuilder#treeKeys()`, may make additional guarantees. Annotations @Override

public Map<K, Collection<V>> asMap()

Redeclares com.google.common.collect.SetMultimap.asMap.

Returns a map view that associates each key with the corresponding values in the multimap. Changes to the returned map, such as element removal, will update the underlying multimap. The map does not support setValue() on its entries, put, or putAll.

When passed a key that is present in the map, asMap().get(Object) has the same behavior as get, returning a live collection. When passed a key that is not present, however, asMap().get(Object) returns null instead of an empty collection.

Note

The returned map's values are guaranteed to be of type SortedSet. To obtain this map with the more specific generic type Map<K, SortedSet<V>>, call Multimaps#asMap(SortedSetMultimap) instead. However, the returned map itself is not necessarily a SortedMap: A SortedSetMultimap must expose the values for a given key in sorted order, but it need not expose the keys in sorted order. Individual SortedSetMultimap implementations, like those built with MultimapBuilder#treeKeys(), may make additional guarantees.

Annotations

@Override

get back to summary

get	back to summary
public SortedSet<V> get(K key) Redeclares com.google.common.collect.SetMultimap.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

public SortedSet<V> get(K key)

Redeclares com.google.common.collect.SetMultimap.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

removeAll back to summary

removeAll	back to summary
public SortedSet<V> removeAll(Object key) Redeclares com.google.common.collect.SetMultimap.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 @CanIgnoreReturnValue @Override

public SortedSet<V> removeAll(Object key)

Redeclares com.google.common.collect.SetMultimap.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

@CanIgnoreReturnValue
@Override

replaceValues back to summary

replaceValues	back to summary
public SortedSet<V> replaceValues(K key, Iterable<? extends V> values) Redeclares com.google.common.collect.SetMultimap.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 @CanIgnoreReturnValue @Override

public SortedSet<V> replaceValues(K key, Iterable<? extends V> values)

Redeclares com.google.common.collect.SetMultimap.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

@CanIgnoreReturnValue
@Override

valueComparator back to summary

valueComparator	back to summary
public Comparator<? super V> valueComparator() Returns the comparator that orders the multimap values, with `null` indicating that natural ordering is used. Annotations @CheckForNull

public Comparator<? super V> valueComparator()

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

Annotations

@CheckForNull

public Interface SortedSetMultimap<K extends @Nullable Object, V extends @Nullable Object>

Method Summary

Method Detail