001/*
002 * Copyright (C) 2009 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 static com.google.common.base.Preconditions.checkNotNull;
020import static com.google.common.collect.CollectPreconditions.checkNonnegative;
021import static java.lang.Math.max;
022import static java.util.Arrays.asList;
023import static java.util.Objects.requireNonNull;
024
025import com.google.common.annotations.GwtCompatible;
026import com.google.common.annotations.GwtIncompatible;
027import com.google.common.annotations.J2ktIncompatible;
028import com.google.common.base.MoreObjects;
029import com.google.errorprone.annotations.CanIgnoreReturnValue;
030import com.google.errorprone.annotations.DoNotCall;
031import com.google.errorprone.annotations.concurrent.LazyInit;
032import com.google.j2objc.annotations.RetainedWith;
033import com.google.j2objc.annotations.Weak;
034import java.io.IOException;
035import java.io.InvalidObjectException;
036import java.io.ObjectInputStream;
037import java.io.ObjectOutputStream;
038import java.util.Collection;
039import java.util.Comparator;
040import java.util.Map;
041import java.util.Map.Entry;
042import java.util.Set;
043import java.util.function.Function;
044import java.util.stream.Collector;
045import java.util.stream.Stream;
046import org.jspecify.annotations.Nullable;
047
048/**
049 * A {@link SetMultimap} whose contents will never change, with many other important properties
050 * detailed at {@link ImmutableCollection}.
051 *
052 * <p><b>Warning:</b> As in all {@link SetMultimap}s, do not modify either a key <i>or a value</i>
053 * of a {@code ImmutableSetMultimap} in a way that affects its {@link Object#equals} behavior.
054 * Undefined behavior and bugs will result.
055 *
056 * <p>See the Guava User Guide article on <a href=
057 * "https://github.com/google/guava/wiki/ImmutableCollectionsExplained">immutable collections</a>.
058 *
059 * @author Mike Ward
060 * @since 2.0
061 */
062@GwtCompatible(serializable = true, emulated = true)
063public class ImmutableSetMultimap<K, V> extends ImmutableMultimap<K, V>
064    implements SetMultimap<K, V> {
065  /**
066   * Returns a {@link Collector} that accumulates elements into an {@code ImmutableSetMultimap}
067   * whose keys and values are the result of applying the provided mapping functions to the input
068   * elements.
069   *
070   * <p>For streams with defined encounter order (as defined in the Ordering section of the {@link
071   * java.util.stream} Javadoc), that order is preserved, but entries are <a
072   * href="ImmutableMultimap.html#iteration">grouped by key</a>.
073   *
074   * <p>Example:
075   *
076   * <pre>{@code
077   * static final Multimap<Character, String> FIRST_LETTER_MULTIMAP =
078   *     Stream.of("banana", "apple", "carrot", "asparagus", "cherry")
079   *         .collect(toImmutableSetMultimap(str -> str.charAt(0), str -> str.substring(1)));
080   *
081   * // is equivalent to
082   *
083   * static final Multimap<Character, String> FIRST_LETTER_MULTIMAP =
084   *     new ImmutableSetMultimap.Builder<Character, String>()
085   *         .put('b', "anana")
086   *         .putAll('a', "pple", "sparagus")
087   *         .putAll('c', "arrot", "herry")
088   *         .build();
089   * }</pre>
090   *
091   * @since 21.0
092   */
093  public static <T extends @Nullable Object, K, V>
094      Collector<T, ?, ImmutableSetMultimap<K, V>> toImmutableSetMultimap(
095          Function<? super T, ? extends K> keyFunction,
096          Function<? super T, ? extends V> valueFunction) {
097    return CollectCollectors.toImmutableSetMultimap(keyFunction, valueFunction);
098  }
099
100  /**
101   * Returns a {@code Collector} accumulating entries into an {@code ImmutableSetMultimap}. Each
102   * input element is mapped to a key and a stream of values, each of which are put into the
103   * resulting {@code Multimap}, in the encounter order of the stream and the encounter order of the
104   * streams of values.
105   *
106   * <p>Example:
107   *
108   * <pre>{@code
109   * static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
110   *     Stream.of("banana", "apple", "carrot", "asparagus", "cherry")
111   *         .collect(
112   *             flatteningToImmutableSetMultimap(
113   *                  str -> str.charAt(0),
114   *                  str -> str.substring(1).chars().mapToObj(c -> (char) c));
115   *
116   * // is equivalent to
117   *
118   * static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
119   *     ImmutableSetMultimap.<Character, Character>builder()
120   *         .putAll('b', Arrays.asList('a', 'n', 'a', 'n', 'a'))
121   *         .putAll('a', Arrays.asList('p', 'p', 'l', 'e'))
122   *         .putAll('c', Arrays.asList('a', 'r', 'r', 'o', 't'))
123   *         .putAll('a', Arrays.asList('s', 'p', 'a', 'r', 'a', 'g', 'u', 's'))
124   *         .putAll('c', Arrays.asList('h', 'e', 'r', 'r', 'y'))
125   *         .build();
126   *
127   * // after deduplication, the resulting multimap is equivalent to
128   *
129   * static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
130   *     ImmutableSetMultimap.<Character, Character>builder()
131   *         .putAll('b', Arrays.asList('a', 'n'))
132   *         .putAll('a', Arrays.asList('p', 'l', 'e', 's', 'a', 'r', 'g', 'u'))
133   *         .putAll('c', Arrays.asList('a', 'r', 'o', 't', 'h', 'e', 'y'))
134   *         .build();
135   * }
136   * }</pre>
137   *
138   * @since 21.0
139   */
140  public static <T extends @Nullable Object, K, V>
141      Collector<T, ?, ImmutableSetMultimap<K, V>> flatteningToImmutableSetMultimap(
142          Function<? super T, ? extends K> keyFunction,
143          Function<? super T, ? extends Stream<? extends V>> valuesFunction) {
144    return CollectCollectors.flatteningToImmutableSetMultimap(keyFunction, valuesFunction);
145  }
146
147  /**
148   * Returns the empty multimap.
149   *
150   * <p><b>Performance note:</b> the instance returned is a singleton.
151   */
152  // Casting is safe because the multimap will never hold any elements.
153  @SuppressWarnings("unchecked")
154  public static <K, V> ImmutableSetMultimap<K, V> of() {
155    return (ImmutableSetMultimap<K, V>) EmptyImmutableSetMultimap.INSTANCE;
156  }
157
158  /** Returns an immutable multimap containing a single entry. */
159  public static <K, V> ImmutableSetMultimap<K, V> of(K k1, V v1) {
160    ImmutableSetMultimap.Builder<K, V> builder = ImmutableSetMultimap.builder();
161    builder.put(k1, v1);
162    return builder.build();
163  }
164
165  /**
166   * Returns an immutable multimap containing the given entries, in order. Repeated occurrences of
167   * an entry (according to {@link Object#equals}) after the first are ignored.
168   */
169  public static <K, V> ImmutableSetMultimap<K, V> of(K k1, V v1, K k2, V v2) {
170    ImmutableSetMultimap.Builder<K, V> builder = ImmutableSetMultimap.builder();
171    builder.put(k1, v1);
172    builder.put(k2, v2);
173    return builder.build();
174  }
175
176  /**
177   * Returns an immutable multimap containing the given entries, in order. Repeated occurrences of
178   * an entry (according to {@link Object#equals}) after the first are ignored.
179   */
180  public static <K, V> ImmutableSetMultimap<K, V> of(K k1, V v1, K k2, V v2, K k3, V v3) {
181    ImmutableSetMultimap.Builder<K, V> builder = ImmutableSetMultimap.builder();
182    builder.put(k1, v1);
183    builder.put(k2, v2);
184    builder.put(k3, v3);
185    return builder.build();
186  }
187
188  /**
189   * Returns an immutable multimap containing the given entries, in order. Repeated occurrences of
190   * an entry (according to {@link Object#equals}) after the first are ignored.
191   */
192  public static <K, V> ImmutableSetMultimap<K, V> of(
193      K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) {
194    ImmutableSetMultimap.Builder<K, V> builder = ImmutableSetMultimap.builder();
195    builder.put(k1, v1);
196    builder.put(k2, v2);
197    builder.put(k3, v3);
198    builder.put(k4, v4);
199    return builder.build();
200  }
201
202  /**
203   * Returns an immutable multimap containing the given entries, in order. Repeated occurrences of
204   * an entry (according to {@link Object#equals}) after the first are ignored.
205   */
206  public static <K, V> ImmutableSetMultimap<K, V> of(
207      K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5) {
208    ImmutableSetMultimap.Builder<K, V> builder = ImmutableSetMultimap.builder();
209    builder.put(k1, v1);
210    builder.put(k2, v2);
211    builder.put(k3, v3);
212    builder.put(k4, v4);
213    builder.put(k5, v5);
214    return builder.build();
215  }
216
217  // looking for of() with > 5 entries? Use the builder instead.
218
219  /** Returns a new {@link Builder}. */
220  public static <K, V> Builder<K, V> builder() {
221    return new Builder<>();
222  }
223
224  /**
225   * Returns a new builder with a hint for how many distinct keys are expected to be added. The
226   * generated builder is equivalent to that returned by {@link #builder}, but may perform better if
227   * {@code expectedKeys} is a good estimate.
228   *
229   * @throws IllegalArgumentException if {@code expectedKeys} is negative
230   * @since 33.3.0
231   */
232  public static <K, V> Builder<K, V> builderWithExpectedKeys(int expectedKeys) {
233    checkNonnegative(expectedKeys, "expectedKeys");
234    return new Builder<>(expectedKeys);
235  }
236
237  /**
238   * A builder for creating immutable {@code SetMultimap} instances, especially {@code public static
239   * final} multimaps ("constant multimaps"). Example:
240   *
241   * <pre>{@code
242   * static final Multimap<String, Integer> STRING_TO_INTEGER_MULTIMAP =
243   *     new ImmutableSetMultimap.Builder<String, Integer>()
244   *         .put("one", 1)
245   *         .putAll("several", 1, 2, 3)
246   *         .putAll("many", 1, 2, 3, 4, 5)
247   *         .build();
248   * }</pre>
249   *
250   * <p>Builder instances can be reused; it is safe to call {@link #build} multiple times to build
251   * multiple multimaps in series. Each multimap contains the key-value mappings in the previously
252   * created multimaps.
253   *
254   * @since 2.0
255   */
256  public static final class Builder<K, V> extends ImmutableMultimap.Builder<K, V> {
257    /**
258     * Creates a new builder. The returned builder is equivalent to the builder generated by {@link
259     * ImmutableSetMultimap#builder}.
260     */
261    public Builder() {}
262
263    Builder(int expectedKeys) {
264      super(expectedKeys);
265    }
266
267    @Override
268    ImmutableCollection.Builder<V> newValueCollectionBuilderWithExpectedSize(int expectedSize) {
269      return (valueComparator == null)
270          ? ImmutableSet.builderWithExpectedSize(expectedSize)
271          : new ImmutableSortedSet.Builder<V>(valueComparator, expectedSize);
272    }
273
274    @Override
275    int expectedValueCollectionSize(int defaultExpectedValues, Iterable<?> values) {
276      // Only trust the size of `values` if it is a Set and therefore probably already deduplicated.
277      if (values instanceof Set<?>) {
278        Set<?> collection = (Set<?>) values;
279        return max(defaultExpectedValues, collection.size());
280      } else {
281        return defaultExpectedValues;
282      }
283    }
284
285    /**
286     * {@inheritDoc}
287     *
288     * <p>Note that {@code expectedValuesPerKey} is taken to mean the expected number of
289     * <i>distinct</i> values per key.
290     *
291     * @since 33.3.0
292     */
293    @CanIgnoreReturnValue
294    @Override
295    public Builder<K, V> expectedValuesPerKey(int expectedValuesPerKey) {
296      super.expectedValuesPerKey(expectedValuesPerKey);
297      return this;
298    }
299
300    /** Adds a key-value mapping to the built multimap if it is not already present. */
301    @CanIgnoreReturnValue
302    @Override
303    public Builder<K, V> put(K key, V value) {
304      super.put(key, value);
305      return this;
306    }
307
308    /**
309     * Adds an entry to the built multimap if it is not already present.
310     *
311     * @since 11.0
312     */
313    @CanIgnoreReturnValue
314    @Override
315    public Builder<K, V> put(Entry<? extends K, ? extends V> entry) {
316      super.put(entry);
317      return this;
318    }
319
320    /**
321     * {@inheritDoc}
322     *
323     * @since 19.0
324     */
325    @CanIgnoreReturnValue
326    @Override
327    public Builder<K, V> putAll(Iterable<? extends Entry<? extends K, ? extends V>> entries) {
328      super.putAll(entries);
329      return this;
330    }
331
332    @CanIgnoreReturnValue
333    @Override
334    public Builder<K, V> putAll(K key, Iterable<? extends V> values) {
335      super.putAll(key, values);
336      return this;
337    }
338
339    @CanIgnoreReturnValue
340    @Override
341    public Builder<K, V> putAll(K key, V... values) {
342      return putAll(key, asList(values));
343    }
344
345    @CanIgnoreReturnValue
346    @Override
347    public Builder<K, V> putAll(Multimap<? extends K, ? extends V> multimap) {
348      for (Entry<? extends K, ? extends Collection<? extends V>> entry :
349          multimap.asMap().entrySet()) {
350        putAll(entry.getKey(), entry.getValue());
351      }
352      return this;
353    }
354
355    @CanIgnoreReturnValue
356    @Override
357    Builder<K, V> combine(ImmutableMultimap.Builder<K, V> other) {
358      super.combine(other);
359      return this;
360    }
361
362    /**
363     * {@inheritDoc}
364     *
365     * @since 8.0
366     */
367    @CanIgnoreReturnValue
368    @Override
369    public Builder<K, V> orderKeysBy(Comparator<? super K> keyComparator) {
370      super.orderKeysBy(keyComparator);
371      return this;
372    }
373
374    /**
375     * Specifies the ordering of the generated multimap's values for each key.
376     *
377     * <p>If this method is called, the sets returned by the {@code get()} method of the generated
378     * multimap and its {@link Multimap#asMap()} view are {@link ImmutableSortedSet} instances.
379     * However, serialization does not preserve that property, though it does maintain the key and
380     * value ordering.
381     *
382     * @since 8.0
383     */
384    // TODO: Make serialization behavior consistent.
385    @CanIgnoreReturnValue
386    @Override
387    public Builder<K, V> orderValuesBy(Comparator<? super V> valueComparator) {
388      super.orderValuesBy(valueComparator);
389      return this;
390    }
391
392    /** Returns a newly-created immutable set multimap. */
393    @Override
394    public ImmutableSetMultimap<K, V> build() {
395      if (builderMap == null) {
396        return ImmutableSetMultimap.of();
397      }
398      Collection<Map.Entry<K, ImmutableCollection.Builder<V>>> mapEntries = builderMap.entrySet();
399      if (keyComparator != null) {
400        mapEntries = Ordering.from(keyComparator).<K>onKeys().immutableSortedCopy(mapEntries);
401      }
402      return fromMapBuilderEntries(mapEntries, valueComparator);
403    }
404  }
405
406  /**
407   * Returns an immutable set multimap containing the same mappings as {@code multimap}. The
408   * generated multimap's key and value orderings correspond to the iteration ordering of the {@code
409   * multimap.asMap()} view. Repeated occurrences of an entry in the multimap after the first are
410   * ignored.
411   *
412   * <p>Despite the method name, this method attempts to avoid actually copying the data when it is
413   * safe to do so. The exact circumstances under which a copy will or will not be performed are
414   * undocumented and subject to change.
415   *
416   * @throws NullPointerException if any key or value in {@code multimap} is null
417   */
418  public static <K, V> ImmutableSetMultimap<K, V> copyOf(
419      Multimap<? extends K, ? extends V> multimap) {
420    return copyOf(multimap, null);
421  }
422
423  private static <K, V> ImmutableSetMultimap<K, V> copyOf(
424      Multimap<? extends K, ? extends V> multimap,
425      @Nullable Comparator<? super V> valueComparator) {
426    checkNotNull(multimap); // eager for GWT
427    if (multimap.isEmpty() && valueComparator == null) {
428      return of();
429    }
430
431    if (multimap instanceof ImmutableSetMultimap) {
432      @SuppressWarnings("unchecked") // safe since multimap is not writable
433      ImmutableSetMultimap<K, V> kvMultimap = (ImmutableSetMultimap<K, V>) multimap;
434      if (!kvMultimap.isPartialView()) {
435        return kvMultimap;
436      }
437    }
438
439    return fromMapEntries(multimap.asMap().entrySet(), valueComparator);
440  }
441
442  /**
443   * Returns an immutable multimap containing the specified entries. The returned multimap iterates
444   * over keys in the order they were first encountered in the input, and the values for each key
445   * are iterated in the order they were encountered. If two values for the same key are {@linkplain
446   * Object#equals equal}, the first value encountered is used.
447   *
448   * @throws NullPointerException if any key, value, or entry is null
449   * @since 19.0
450   */
451  public static <K, V> ImmutableSetMultimap<K, V> copyOf(
452      Iterable<? extends Entry<? extends K, ? extends V>> entries) {
453    return new Builder<K, V>().putAll(entries).build();
454  }
455
456  /** Creates an ImmutableSetMultimap from an asMap.entrySet. */
457  static <K, V> ImmutableSetMultimap<K, V> fromMapEntries(
458      Collection<? extends Map.Entry<? extends K, ? extends Collection<? extends V>>> mapEntries,
459      @Nullable Comparator<? super V> valueComparator) {
460    if (mapEntries.isEmpty()) {
461      return of();
462    }
463    ImmutableMap.Builder<K, ImmutableSet<V>> builder =
464        new ImmutableMap.Builder<>(mapEntries.size());
465    int size = 0;
466
467    for (Entry<? extends K, ? extends Collection<? extends V>> entry : mapEntries) {
468      K key = entry.getKey();
469      Collection<? extends V> values = entry.getValue();
470      ImmutableSet<V> set = valueSet(valueComparator, values);
471      if (!set.isEmpty()) {
472        builder.put(key, set);
473        size += set.size();
474      }
475    }
476
477    return new ImmutableSetMultimap<>(builder.buildOrThrow(), size, valueComparator);
478  }
479
480  /** Creates an ImmutableSetMultimap from a map to builders. */
481  static <K, V> ImmutableSetMultimap<K, V> fromMapBuilderEntries(
482      Collection<? extends Map.Entry<K, ImmutableCollection.Builder<V>>> mapEntries,
483      @Nullable Comparator<? super V> valueComparator) {
484    if (mapEntries.isEmpty()) {
485      return of();
486    }
487    ImmutableMap.Builder<K, ImmutableSet<V>> builder =
488        new ImmutableMap.Builder<>(mapEntries.size());
489    int size = 0;
490
491    for (Entry<K, ImmutableCollection.Builder<V>> entry : mapEntries) {
492      K key = entry.getKey();
493      ImmutableSet.Builder<? extends V> values = (ImmutableSet.Builder<V>) entry.getValue();
494      // If orderValuesBy got called at the very end, we may need to do the ImmutableSet to
495      // ImmutableSortedSet copy for each of these.
496      ImmutableSet<V> set = valueSet(valueComparator, values.build());
497      if (!set.isEmpty()) {
498        builder.put(key, set);
499        size += set.size();
500      }
501    }
502
503    return new ImmutableSetMultimap<>(builder.buildOrThrow(), size, valueComparator);
504  }
505
506  /**
507   * Returned by get() when a missing key is provided. Also holds the comparator, if any, used for
508   * values.
509   */
510  private final transient ImmutableSet<V> emptySet;
511
512  ImmutableSetMultimap(
513      ImmutableMap<K, ImmutableSet<V>> map,
514      int size,
515      @Nullable Comparator<? super V> valueComparator) {
516    super(map, size);
517    this.emptySet = emptySet(valueComparator);
518  }
519
520  // views
521
522  /**
523   * Returns an immutable set of the values for the given key. If no mappings in the multimap have
524   * the provided key, an empty immutable set is returned. The values are in the same order as the
525   * parameters used to build this multimap.
526   */
527  @Override
528  public ImmutableSet<V> get(K key) {
529    // This cast is safe as its type is known in constructor.
530    ImmutableSet<V> set = (ImmutableSet<V>) map.get(key);
531    return MoreObjects.firstNonNull(set, emptySet);
532  }
533
534  @LazyInit @RetainedWith private transient @Nullable ImmutableSetMultimap<V, K> inverse;
535
536  /**
537   * {@inheritDoc}
538   *
539   * <p>Because an inverse of a set multimap cannot contain multiple pairs with the same key and
540   * value, this method returns an {@code ImmutableSetMultimap} rather than the {@code
541   * ImmutableMultimap} specified in the {@code ImmutableMultimap} class.
542   */
543  @Override
544  public ImmutableSetMultimap<V, K> inverse() {
545    ImmutableSetMultimap<V, K> result = inverse;
546    return (result == null) ? (inverse = invert()) : result;
547  }
548
549  private ImmutableSetMultimap<V, K> invert() {
550    Builder<V, K> builder = builder();
551    for (Entry<K, V> entry : entries()) {
552      builder.put(entry.getValue(), entry.getKey());
553    }
554    ImmutableSetMultimap<V, K> invertedMultimap = builder.build();
555    invertedMultimap.inverse = this;
556    return invertedMultimap;
557  }
558
559  /**
560   * Guaranteed to throw an exception and leave the multimap unmodified.
561   *
562   * @throws UnsupportedOperationException always
563   * @deprecated Unsupported operation.
564   */
565  @CanIgnoreReturnValue
566  @Deprecated
567  @Override
568  @DoNotCall("Always throws UnsupportedOperationException")
569  public final ImmutableSet<V> removeAll(@Nullable Object key) {
570    throw new UnsupportedOperationException();
571  }
572
573  /**
574   * Guaranteed to throw an exception and leave the multimap unmodified.
575   *
576   * @throws UnsupportedOperationException always
577   * @deprecated Unsupported operation.
578   */
579  @CanIgnoreReturnValue
580  @Deprecated
581  @Override
582  @DoNotCall("Always throws UnsupportedOperationException")
583  public final ImmutableSet<V> replaceValues(K key, Iterable<? extends V> values) {
584    throw new UnsupportedOperationException();
585  }
586
587  @LazyInit @RetainedWith private transient @Nullable ImmutableSet<Entry<K, V>> entries;
588
589  /**
590   * Returns an immutable collection of all key-value pairs in the multimap. Its iterator traverses
591   * the values for the first key, the values for the second key, and so on.
592   */
593  @Override
594  public ImmutableSet<Entry<K, V>> entries() {
595    ImmutableSet<Entry<K, V>> result = entries;
596    return result == null ? (entries = new EntrySet<>(this)) : result;
597  }
598
599  private static final class EntrySet<K, V> extends ImmutableSet<Entry<K, V>> {
600    @Weak private final transient ImmutableSetMultimap<K, V> multimap;
601
602    EntrySet(ImmutableSetMultimap<K, V> multimap) {
603      this.multimap = multimap;
604    }
605
606    @Override
607    public boolean contains(@Nullable Object object) {
608      if (object instanceof Entry) {
609        Entry<?, ?> entry = (Entry<?, ?>) object;
610        return multimap.containsEntry(entry.getKey(), entry.getValue());
611      }
612      return false;
613    }
614
615    @Override
616    public int size() {
617      return multimap.size();
618    }
619
620    @Override
621    public UnmodifiableIterator<Entry<K, V>> iterator() {
622      return multimap.entryIterator();
623    }
624
625    @Override
626    boolean isPartialView() {
627      return false;
628    }
629
630    // redeclare to help optimizers with b/310253115
631    @SuppressWarnings("RedundantOverride")
632    @Override
633    @J2ktIncompatible // serialization
634    @GwtIncompatible // serialization
635    Object writeReplace() {
636      return super.writeReplace();
637    }
638  }
639
640  private static <V> ImmutableSet<V> valueSet(
641      @Nullable Comparator<? super V> valueComparator, Collection<? extends V> values) {
642    return (valueComparator == null)
643        ? ImmutableSet.copyOf(values)
644        : ImmutableSortedSet.copyOf(valueComparator, values);
645  }
646
647  private static <V> ImmutableSet<V> emptySet(@Nullable Comparator<? super V> valueComparator) {
648    return (valueComparator == null)
649        ? ImmutableSet.<V>of()
650        : ImmutableSortedSet.<V>emptySet(valueComparator);
651  }
652
653  private static <V> ImmutableSet.Builder<V> valuesBuilder(
654      @Nullable Comparator<? super V> valueComparator) {
655    return (valueComparator == null)
656        ? new ImmutableSet.Builder<V>()
657        : new ImmutableSortedSet.Builder<V>(valueComparator);
658  }
659
660  /**
661   * @serialData number of distinct keys, and then for each distinct key: the key, the number of
662   *     values for that key, and the key's values
663   */
664  @GwtIncompatible // java.io.ObjectOutputStream
665  @J2ktIncompatible
666  private void writeObject(ObjectOutputStream stream) throws IOException {
667    stream.defaultWriteObject();
668    stream.writeObject(valueComparator());
669    Serialization.writeMultimap(this, stream);
670  }
671
672  @Nullable Comparator<? super V> valueComparator() {
673    return emptySet instanceof ImmutableSortedSet
674        ? ((ImmutableSortedSet<V>) emptySet).comparator()
675        : null;
676  }
677
678  @GwtIncompatible // java serialization
679  @J2ktIncompatible
680  private static final class SetFieldSettersHolder {
681    static final Serialization.FieldSetter<? super ImmutableSetMultimap<?, ?>>
682        EMPTY_SET_FIELD_SETTER =
683            Serialization.getFieldSetter(ImmutableSetMultimap.class, "emptySet");
684  }
685
686  @GwtIncompatible // java.io.ObjectInputStream
687  @J2ktIncompatible
688  // Serialization type safety is at the caller's mercy.
689  @SuppressWarnings("unchecked")
690  private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException {
691    stream.defaultReadObject();
692    Comparator<Object> valueComparator = (Comparator<Object>) stream.readObject();
693    int keyCount = stream.readInt();
694    if (keyCount < 0) {
695      throw new InvalidObjectException("Invalid key count " + keyCount);
696    }
697    ImmutableMap.Builder<Object, ImmutableSet<Object>> builder = ImmutableMap.builder();
698    int tmpSize = 0;
699
700    for (int i = 0; i < keyCount; i++) {
701      Object key = requireNonNull(stream.readObject());
702      int valueCount = stream.readInt();
703      if (valueCount <= 0) {
704        throw new InvalidObjectException("Invalid value count " + valueCount);
705      }
706
707      ImmutableSet.Builder<Object> valuesBuilder = valuesBuilder(valueComparator);
708      for (int j = 0; j < valueCount; j++) {
709        valuesBuilder.add(requireNonNull(stream.readObject()));
710      }
711      ImmutableSet<Object> valueSet = valuesBuilder.build();
712      if (valueSet.size() != valueCount) {
713        throw new InvalidObjectException("Duplicate key-value pairs exist for key " + key);
714      }
715      builder.put(key, valueSet);
716      tmpSize += valueCount;
717    }
718
719    ImmutableMap<Object, ImmutableSet<Object>> tmpMap;
720    try {
721      tmpMap = builder.buildOrThrow();
722    } catch (IllegalArgumentException e) {
723      throw (InvalidObjectException) new InvalidObjectException(e.getMessage()).initCause(e);
724    }
725
726    FieldSettersHolder.MAP_FIELD_SETTER.set(this, tmpMap);
727    FieldSettersHolder.SIZE_FIELD_SETTER.set(this, tmpSize);
728    SetFieldSettersHolder.EMPTY_SET_FIELD_SETTER.set(this, emptySet(valueComparator));
729  }
730
731  @GwtIncompatible // not needed in emulated source.
732  @J2ktIncompatible
733  private static final long serialVersionUID = 0;
734}