public static class ImmutableMultimap.Builder<K,V> extends Object
public static final
multimaps ("constant multimaps"). Example:
static final Multimap<String, Integer> STRING_TO_INTEGER_MULTIMAP = new ImmutableMultimap.Builder<String, Integer>() .put("one", 1) .putAll("several", 1, 2, 3) .putAll("many", 1, 2, 3, 4, 5) .build();
Builder instances can be reused; it is safe to call build()
multiple times to build multiple multimaps in series. Each multimap contains the key-value mappings in the previously created multimaps.
Constructor and Description |
---|
Builder()
Creates a new builder.
|
Modifier and Type | Method and Description |
---|---|
ImmutableMultimap |
build()
Returns a newly-created immutable multimap.
|
ImmutableMultimap |
orderKeysBy(Comparator
Specifies the ordering of the generated multimap's keys.
|
ImmutableMultimap |
orderValuesBy(Comparator
Specifies the ordering of the generated multimap's values for each key.
|
ImmutableMultimap |
put(K key, V value)
Adds a key-value mapping to the built multimap.
|
ImmutableMultimap |
put(Map
Adds an entry to the built multimap.
|
ImmutableMultimap |
putAll(Iterable
Adds entries to the built multimap.
|
ImmutableMultimap |
putAll(K key, Iterable
Stores a collection of values with the same key in the built multimap.
|
ImmutableMultimap |
putAll(K key, V... values)
Stores an array of values with the same key in the built multimap.
|
ImmutableMultimap |
putAll(Multimap
Stores another multimap's entries in the built multimap.
|
public Builder()
ImmutableMultimap.builder()
.
public ImmutableMultimap.Builder <K ,V> put(K key, V value)
public ImmutableMultimap.Builder <K ,V> put(Map .Entry <? extends K ,? extends V> entry)
@Beta public ImmutableMultimap.Builder <K ,V> putAll(Iterable <? extends Map .Entry <? extends K ,? extends V>> entries)
public ImmutableMultimap.Builder <K ,V> putAll(K key, Iterable <? extends V> values)
NullPointerException
- if
key
,
values
, or any element in
values
is null. The builder is left in an invalid state.
public ImmutableMultimap.Builder <K ,V> putAll(K key, V... values)
NullPointerException
- if the key or any value is null. The builder is left in an invalid state.
public ImmutableMultimap.Builder <K ,V> putAll(Multimap <? extends K ,? extends V> multimap)
multimap.asMap()
view, with new keys and values following any existing keys and values.
NullPointerException
- if any key or value in
multimap
is null. The builder is left in an invalid state.
public ImmutableMultimap.Builder <K ,V> orderKeysBy(Comparator <? super K> keyComparator)
public ImmutableMultimap.Builder <K ,V> orderValuesBy(Comparator <? super V> valueComparator)
public ImmutableMultimap<K ,V> build()