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

All Superinterfaces:
Multimap<K,V>, SetMultimap<K,V>
All Known Implementing Classes:
ForwardingSortedSetMultimap, TreeMultimap
@GwtCompatible public interface SortedSetMultimap<K extends @Nullable Object, V extends @Nullable Object> extends SetMultimap<K,V>
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(K), removeAll(Object), and replaceValues(K, Iterable) 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(Object) behavior (or its position in the order of the values). Undefined behavior and bugs will result.

See the Guava User Guide article on Multimap.

Since:
2.0
Author:
Jared Levy

  • Method Summary

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

    Methods inherited from interface Multimap

    clear, containsEntry, containsKey, containsValue, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
    Modifier and Type
    Method
    Description
    void
    clear()
    Removes all key-value pairs from the multimap, leaving it empty.
    boolean
    containsEntry(@Nullable Object key, @Nullable Object value)
    Returns true if this multimap contains at least one key-value pair with the key key and the value value.
    boolean
    containsKey(@Nullable Object key)
    Returns true if this multimap contains at least one key-value pair with the key key.
    boolean
    containsValue(@Nullable Object value)
    Returns true if this multimap contains at least one key-value pair with the value value.
    int
    hashCode()
    Returns the hash code for this multimap.
    boolean
    isEmpty()
    Returns true if this multimap contains no key-value pairs.
    Multiset<K>
    keys()
    Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates.
    Set<K>
    keySet()
    Returns a view collection of all distinct keys contained in this multimap.
    boolean
    put(K key, V value)
    Stores a key-value pair in this multimap.
    boolean
    putAll(Multimap<? extends K, ? extends V> multimap)
    Stores all key-value pairs of multimap in this multimap, in the order returned by multimap.entries().
    boolean
    putAll(K key, Iterable<? extends V> values)
    Stores a key-value pair in this multimap for each of values, all using the same key, key.
    boolean
    remove(@Nullable Object key, @Nullable Object value)
    Removes a single key-value pair with the key key and the value value from this multimap, if such exists.
    int
    size()
    Returns the number of key-value pairs in this multimap.
    Collection<V>
    values()
    Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (so values().size() == size()).

    Methods inherited from interface SetMultimap

    entries, equals
    Modifier and Type
    Method
    Description
    Set<Map.Entry<K,V>>
    entries()
    Returns a view collection of all key-value pairs contained in this multimap, as Map.Entry instances.
    boolean
    equals(@Nullable Object obj)
    Compares the specified object to this multimap for equality.

  • Method Details

    • get

      SortedSet<V> get(K key)
      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 Collection specified in the Multimap interface.

      Specified by:
      get in interface Multimap<K extends @Nullable Object, V extends @Nullable Object>
      Specified by:
      get in interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

    • removeAll

      @CanIgnoreReturnValue SortedSet<V> removeAll(@Nullable Object key)
      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 Collection specified in the Multimap interface.

      Specified by:
      removeAll in interface Multimap<K extends @Nullable Object, V extends @Nullable Object>
      Specified by:
      removeAll in interface SetMultimap<K extends @Nullable Object, V extends @Nullable 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

      @CanIgnoreReturnValue SortedSet<V> replaceValues(K key, Iterable<? extends V> values)
      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 Collection specified in the Multimap interface.

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

      Specified by:
      replaceValues in interface Multimap<K extends @Nullable Object, V extends @Nullable Object>
      Specified by:
      replaceValues in interface SetMultimap<K extends @Nullable Object, V extends @Nullable 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.

    • asMap

      Map<K, Collection<V>> 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(K), 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.

      Specified by:
      asMap in interface Multimap<K extends @Nullable Object, V extends @Nullable Object>
      Specified by:
      asMap in interface SetMultimap<K extends @Nullable Object, V extends @Nullable Object>

    • valueComparator

      @Nullable Comparator<? super V> valueComparator()
      Returns the comparator that orders the multimap values, with null indicating that natural ordering is used.