001 /*
002 * Copyright (C) 2007 Google Inc.
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
017 package com.google.common.collect;
018
019 import com.google.common.annotations.GwtCompatible;
020
021 import java.util.Collection;
022 import java.util.Comparator;
023 import java.util.Map;
024 import java.util.Set;
025 import java.util.SortedSet;
026
027 import javax.annotation.Nullable;
028
029 /**
030 * A {@code SetMultimap} whose set of values for a given key are kept sorted;
031 * that is, they comprise a {@link SortedSet}. It cannot hold duplicate
032 * key-value pairs; adding a key-value pair that's already in the multimap has
033 * no effect. This interface does not specify the ordering of the multimap's
034 * keys.
035 *
036 * <p>The {@link #get}, {@link #removeAll}, and {@link #replaceValues} methods
037 * each return a {@link SortedSet} of values, while {@link Multimap#entries()}
038 * returns a {@link Set} of map entries. Though the method signature doesn't say
039 * so explicitly, the map returned by {@link #asMap} has {@code SortedSet}
040 * values.
041 *
042 * @author Jared Levy
043 * @since 2 (imported from Google Collections Library)
044 */
045 @GwtCompatible
046 public interface SortedSetMultimap<K, V> extends SetMultimap<K, V> {
047 /**
048 * Returns a collection view of all values associated with a key. If no
049 * mappings in the multimap have the provided key, an empty collection is
050 * returned.
051 *
052 * <p>Changes to the returned collection will update the underlying multimap,
053 * and vice versa.
054 *
055 * <p>Because a {@code SortedSetMultimap} has unique sorted values for a given
056 * key, this method returns a {@link SortedSet}, instead of the
057 * {@link java.util.Collection} specified in the {@link Multimap} interface.
058 */
059 SortedSet<V> get(@Nullable K key);
060
061 /**
062 * Removes all values associated with a given key.
063 *
064 * <p>Because a {@code SortedSetMultimap} has unique sorted values for a given
065 * key, this method returns a {@link SortedSet}, instead of the
066 * {@link java.util.Collection} specified in the {@link Multimap} interface.
067 */
068 SortedSet<V> removeAll(@Nullable Object key);
069
070 /**
071 * Stores a collection of values with the same key, replacing any existing
072 * values for that key.
073 *
074 * <p>Because a {@code SortedSetMultimap} has unique sorted values for a given
075 * key, this method returns a {@link SortedSet}, instead of the
076 * {@link java.util.Collection} specified in the {@link Multimap} interface.
077 *
078 * <p>Any duplicates in {@code values} will be stored in the multimap once.
079 */
080 SortedSet<V> replaceValues(K key, Iterable<? extends V> values);
081
082 /**
083 * Returns a map view that associates each key with the corresponding values
084 * in the multimap. Changes to the returned map, such as element removal,
085 * will update the underlying multimap. The map never supports
086 * {@code setValue()} on the map entries, {@code put}, or {@code putAll}.
087 *
088 * <p>The collections returned by {@code asMap().get(Object)} have the same
089 * behavior as those returned by {@link #get}.
090 *
091 * <p>Though the method signature doesn't say so explicitly, the returned map
092 * has {@link SortedSet} values.
093 */
094 Map<K, Collection<V>> asMap();
095
096 /**
097 * Returns the comparator that orders the multimap values, with a {@code null}
098 * indicating that natural ordering is used.
099 */
100 Comparator<? super V> valueComparator();
101 }