001/*
002 * Copyright (C) 2007 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect;
018
019import com.google.common.annotations.GwtCompatible;
020import com.google.errorprone.annotations.CanIgnoreReturnValue;
021import java.util.Collection;
022import java.util.Comparator;
023import java.util.Map;
024import java.util.Set;
025import java.util.SortedMap;
026import java.util.SortedSet;
027import org.jspecify.annotations.Nullable;
028
029/**
030 * A {@code SetMultimap} whose set of values for a given key are kept sorted; that is, they comprise
031 * a {@link SortedSet}. It cannot hold duplicate key-value pairs; adding a key-value pair that's
032 * already in the multimap has no effect. This interface does not specify the ordering of the
033 * multimap's keys. See the {@link Multimap} documentation for information common to all multimaps.
034 *
035 * <p>The {@link #get}, {@link #removeAll}, and {@link #replaceValues} methods each return a {@link
036 * SortedSet} of values, while {@link Multimap#entries()} returns a {@link Set} of map entries.
037 * Though the method signature doesn't say so explicitly, the map returned by {@link #asMap} has
038 * {@code SortedSet} values.
039 *
040 * <p><b>Warning:</b> As in all {@link SetMultimap}s, do not modify either a key <i>or a value</i>
041 * of a {@code SortedSetMultimap} in a way that affects its {@link Object#equals} behavior (or its
042 * position in the order of the values). Undefined behavior and bugs will result.
043 *
044 * <p>See the Guava User Guide article on <a href=
045 * "https://github.com/google/guava/wiki/NewCollectionTypesExplained#multimap">{@code Multimap}</a>.
046 *
047 * @author Jared Levy
048 * @since 2.0
049 */
050@GwtCompatible
051public interface SortedSetMultimap<K extends @Nullable Object, V extends @Nullable Object>
052    extends SetMultimap<K, V> {
053  // Following Javadoc copied from Multimap.
054
055  /**
056   * Returns a collection view of all values associated with a key. If no mappings in the multimap
057   * have the provided key, an empty collection is returned.
058   *
059   * <p>Changes to the returned collection will update the underlying multimap, and vice versa.
060   *
061   * <p>Because a {@code SortedSetMultimap} has unique sorted values for a given key, this method
062   * returns a {@link SortedSet}, instead of the {@link java.util.Collection} specified in the
063   * {@link Multimap} interface.
064   */
065  @Override
066  SortedSet<V> get(@ParametricNullness K key);
067
068  /**
069   * Removes all values associated with a given key.
070   *
071   * <p>Because a {@code SortedSetMultimap} has unique sorted values for a given key, this method
072   * returns a {@link SortedSet}, instead of the {@link java.util.Collection} specified in the
073   * {@link Multimap} interface.
074   */
075  @CanIgnoreReturnValue
076  @Override
077  SortedSet<V> removeAll(@Nullable Object key);
078
079  /**
080   * Stores a collection of values with the same key, replacing any existing values for that key.
081   *
082   * <p>Because a {@code SortedSetMultimap} has unique sorted values for a given key, this method
083   * returns a {@link SortedSet}, instead of the {@link java.util.Collection} specified in the
084   * {@link Multimap} interface.
085   *
086   * <p>Any duplicates in {@code values} will be stored in the multimap once.
087   */
088  @CanIgnoreReturnValue
089  @Override
090  SortedSet<V> replaceValues(@ParametricNullness K key, Iterable<? extends V> values);
091
092  /**
093   * Returns a map view that associates each key with the corresponding values in the multimap.
094   * Changes to the returned map, such as element removal, will update the underlying multimap. The
095   * map does not support {@code setValue()} on its entries, {@code put}, or {@code putAll}.
096   *
097   * <p>When passed a key that is present in the map, {@code asMap().get(Object)} has the same
098   * behavior as {@link #get}, returning a live collection. When passed a key that is not present,
099   * however, {@code asMap().get(Object)} returns {@code null} instead of an empty collection.
100   *
101   * <p><b>Note:</b> The returned map's values are guaranteed to be of type {@link SortedSet}. To
102   * obtain this map with the more specific generic type {@code Map<K, SortedSet<V>>}, call {@link
103   * Multimaps#asMap(SortedSetMultimap)} instead. <b>However</b>, the returned map <i>itself</i> is
104   * not necessarily a {@link SortedMap}: A {@code SortedSetMultimap} must expose the <i>values</i>
105   * for a given key in sorted order, but it need not expose the <i>keys</i> in sorted order.
106   * Individual {@code SortedSetMultimap} implementations, like those built with {@link
107   * MultimapBuilder#treeKeys()}, may make additional guarantees.
108   */
109  @Override
110  Map<K, Collection<V>> asMap();
111
112  /**
113   * Returns the comparator that orders the multimap values, with {@code null} indicating that
114   * natural ordering is used.
115   */
116  @Nullable Comparator<? super V> valueComparator();
117}