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

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

Enclosing class:

ImmutableSetMultimap<K,V>

public static class ImmutableSetMultimap.Builder<K,V>
extends java.lang.Object

Constructor Summary

ImmutableSetMultimap.Builder()
Creates a new builder.

Method Summary

ImmutableSetMultimap<K,V>	build() Returns a newly-created immutable set multimap.
ImmutableSetMultimap.Builder<K,V>	put(K key, V value) Adds a key-value mapping to the built multimap.
ImmutableSetMultimap.Builder<K,V>	putAll(K key, java.lang.Iterable<? extends V> values) Stores a collection of values with the same key in the built multimap.
ImmutableSetMultimap.Builder<K,V>	putAll(K key, V... values) Stores an array of values with the same key in the built multimap.
ImmutableSetMultimap.Builder<K,V>	putAll(Multimap<? extends K,? extends V> multimap) Stores another multimap's entries in the built multimap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImmutableSetMultimap.Builder

public ImmutableSetMultimap.Builder()

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

Method Detail

put

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

Adds a key-value mapping to the built multimap.

Throws:

java.lang.IllegalArgumentException - if the key-value pair was previously added

putAll

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

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

Throws:

java.lang.NullPointerException - if key, values, or any element in values is null. The builder is left in an invalid state.

java.lang.IllegalArgumentException - if values contains any duplicates or if the one of the key-value pairs was previously added

putAll

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

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

Throws:

java.lang.NullPointerException - if the key or any value is null. The builder is left in an invalid state.

java.lang.IllegalArgumentException - if values contains any duplicates or if the one of the key-value pairs was previously added

putAll

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

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.

Throws:

java.lang.NullPointerException - if any key or value in multimap is null. The builder is left in an invalid state.

java.lang.IllegalArgumentException - if multimap contains any duplicate key-value pairs or if one of the key-value pairs was previously added

build

public ImmutableSetMultimap<K,V> build()

Returns a newly-created immutable set multimap.