com.google.common.collect
Class ImmutableListMultimap.Builder<K,V>

java.lang.Object
  com.google.common.collect.ImmutableMultimap.Builder<K,V>
      com.google.common.collect.ImmutableListMultimap.Builder<K,V>

Enclosing class:

ImmutableListMultimap<K,V>

public static final class ImmutableListMultimap.Builder<K,V>
extends ImmutableMultimap.Builder<K,V>

A builder for creating immutable ListMultimap instances, especially public static final multimaps ("constant multimaps"). Example:

   static final Multimap<String, Integer> STRING_TO_INTEGER_MULTIMAP =
       new ImmutableListMultimap.Builder<String, Integer>()
           .put("one", 1)
           .putAll("several", 1, 2, 3)
           .putAll("many", 1, 2, 3, 4, 5)
           .build();

Since:

2 (imported from Google Collections Library)

ImmutableListMultimap.Builder

public ImmutableListMultimap.Builder()

Creates a new builder. The returned builder is equivalent to the builder generated by ImmutableListMultimap.builder().

put

public ImmutableListMultimap.Builder<K,V> put(K key,
                                              V value)

Description copied from class: ImmutableMultimap.Builder

Adds a key-value mapping to the built multimap.

Overrides:

put in class ImmutableMultimap.Builder<K,V>

putAll

public ImmutableListMultimap.Builder<K,V> putAll(K key,
                                                 Iterable<? extends V> values)

Description copied from class: ImmutableMultimap.Builder

Stores a collection of values with the same key in the built multimap.

Overrides:

putAll in class ImmutableMultimap.Builder<K,V>

putAll

public ImmutableListMultimap.Builder<K,V> putAll(K key,
                                                 V... values)

Description copied from class: ImmutableMultimap.Builder

Stores an array of values with the same key in the built multimap.

Overrides:

putAll in class ImmutableMultimap.Builder<K,V>

putAll

public ImmutableListMultimap.Builder<K,V> putAll(Multimap<? extends K,? extends V> multimap)

Description copied from class: ImmutableMultimap.Builder

Stores another multimap's entries in the built multimap. The generated multimap's key and value orderings correspond to the iteration ordering of the multimap.asMap() view, with new keys and values following any existing keys and values.

Overrides:

putAll in class ImmutableMultimap.Builder<K,V>

orderKeysBy

@Beta
public ImmutableListMultimap.Builder<K,V> orderKeysBy(Comparator<? super K> keyComparator)

Specifies the ordering of the generated multimap's keys.

Overrides:

orderKeysBy in class ImmutableMultimap.Builder<K,V>

Since:

8

orderValuesBy

@Beta
public ImmutableListMultimap.Builder<K,V> orderValuesBy(Comparator<? super V> valueComparator)

Specifies the ordering of the generated multimap's values for each key.

Overrides:

orderValuesBy in class ImmutableMultimap.Builder<K,V>

Since:

8

build

public ImmutableListMultimap<K,V> build()

Returns a newly-created immutable list multimap.

Overrides:

build in class ImmutableMultimap.Builder<K,V>