Hides com.google.common.collect.ImmutableMultimap.builder.

Returns a new Builder.

Hides com.google.common.collect.ImmutableMultimap.copyOf.

Returns an immutable set multimap containing the same mappings as multimap. The generated multimap's key and value orderings correspond to the iteration ordering of the multimap.asMap() view. Repeated occurrences of an entry in the multimap after the first are ignored.

Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.

Exceptions

NullPointerException:

if any key or value in multimap is null

Hides com.google.common.collect.ImmutableMultimap.copyOf.

Returns an immutable multimap containing the specified entries. The returned multimap iterates over keys in the order they were first encountered in the input, and the values for each key are iterated in the order they were encountered. If two values for the same key are equal, the first value encountered is used.

Exceptions

NullPointerException:

if any key, value, or entry is null

Since

19.0

Overrides com.google.common.collect.ImmutableMultimap.entries.

Implements com.google.common.collect.SetMultimap.entries, com.google.common.collect.Multimap.entries.

Returns an immutable collection of all key-value pairs in the multimap. Its iterator traverses the values for the first key, the values for the second key, and so on.

Annotations

@Override

Returns a Collector accumulating entries into an ImmutableSetMultimap. Each input element is mapped to a key and a stream of values, each of which are put into the resulting Multimap, in the encounter order of the stream and the encounter order of the streams of values.

Example:

static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
    Stream.of("banana", "apple", "carrot", "asparagus", "cherry")
        .collect(
            flatteningToImmutableSetMultimap(
                 str -> str.charAt(0),
                 str -> str.substring(1).chars().mapToObj(c -> (char) c));

// is equivalent to

static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
    ImmutableSetMultimap.<Character, Character>builder()
        .putAll('b', Arrays.asList('a', 'n', 'a', 'n', 'a'))
        .putAll('a', Arrays.asList('p', 'p', 'l', 'e'))
        .putAll('c', Arrays.asList('a', 'r', 'r', 'o', 't'))
        .putAll('a', Arrays.asList('s', 'p', 'a', 'r', 'a', 'g', 'u', 's'))
        .putAll('c', Arrays.asList('h', 'e', 'r', 'r', 'y'))
        .build();

// after deduplication, the resulting multimap is equivalent to

static final ImmutableSetMultimap<Character, Character> FIRST_LETTER_MULTIMAP =
    ImmutableSetMultimap.<Character, Character>builder()
        .putAll('b', Arrays.asList('a', 'n'))
        .putAll('a', Arrays.asList('p', 'l', 'e', 's', 'a', 'r', 'g', 'u'))
        .putAll('c', Arrays.asList('a', 'r', 'o', 't', 'h', 'e', 'y'))
        .build();

}

Since

21.0

Implements abstract com.google.common.collect.ImmutableMultimap.get.

Implements com.google.common.collect.SetMultimap.get, com.google.common.collect.Multimap.get.

Returns an immutable set of the values for the given key. If no mappings in the multimap have the provided key, an empty immutable set is returned. The values are in the same order as the parameters used to build this multimap.

Annotations

@Override

Implements abstract com.google.common.collect.ImmutableMultimap.inverse.

Doc from com.google.common.collect.ImmutableMultimap.inverse.

Returns an immutable multimap which is the inverse of this one. For every key-value mapping in the original, the result will have a mapping with key and value reversed.

Because an inverse of a set multimap cannot contain multiple pairs with the same key and value, this method returns an ImmutableSetMultimap rather than the ImmutableMultimap specified in the ImmutableMultimap class.

Annotations

@Override

Hides com.google.common.collect.ImmutableMultimap.of.

Returns the empty multimap.

Performance note: the instance returned is a singleton.

Annotations

@SuppressWarnings:unchecked

Hides com.google.common.collect.ImmutableMultimap.of.

Returns an immutable multimap containing a single entry.

Hides com.google.common.collect.ImmutableMultimap.of.

Returns an immutable multimap containing the given entries, in order. Repeated occurrences of an entry (according to Object#equals) after the first are ignored.

Hides com.google.common.collect.ImmutableMultimap.of.

Returns an immutable multimap containing the given entries, in order. Repeated occurrences of an entry (according to Object#equals) after the first are ignored.

Hides com.google.common.collect.ImmutableMultimap.of.

Returns an immutable multimap containing the given entries, in order. Repeated occurrences of an entry (according to Object#equals) after the first are ignored.

Hides com.google.common.collect.ImmutableMultimap.of.

Returns an immutable multimap containing the given entries, in order. Repeated occurrences of an entry (according to Object#equals) after the first are ignored.

Overrides com.google.common.collect.ImmutableMultimap.removeAll.

Implements com.google.common.collect.SetMultimap.removeAll, com.google.common.collect.Multimap.removeAll.

Guaranteed to throw an exception and leave the multimap unmodified.

Returns:ImmutableSet<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

@Deprecated

@Override

@DoNotCall:Always throws UnsupportedOperationException

Exceptions

UnsupportedOperationException:

always

Overrides com.google.common.collect.ImmutableMultimap.replaceValues.

Implements com.google.common.collect.SetMultimap.replaceValues, com.google.common.collect.Multimap.replaceValues.

Guaranteed to throw an exception and leave the multimap unmodified.

Returns:ImmutableSet<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

@Deprecated

@Override

@DoNotCall:Always throws UnsupportedOperationException

Exceptions

UnsupportedOperationException:

always

Returns a Collector that accumulates elements into an ImmutableSetMultimap whose keys and values are the result of applying the provided mapping functions to the input elements.

For streams with defined encounter order (as defined in the Ordering section of the java.util.stream Javadoc), that order is preserved, but entries are grouped by key.

Example:

static final Multimap<Character, String> FIRST_LETTER_MULTIMAP =
    Stream.of("banana", "apple", "carrot", "asparagus", "cherry")
        .collect(toImmutableSetMultimap(str -> str.charAt(0), str -> str.substring(1)));

// is equivalent to

static final Multimap<Character, String> FIRST_LETTER_MULTIMAP =
    new ImmutableSetMultimap.Builder<Character, String>()
        .put('b', "anana")
        .putAll('a', "pple", "sparagus")
        .putAll('c', "arrot", "herry")
        .build();

Since

21.0