|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableMultimap.Builder<K,V>
public static class ImmutableMultimap.Builder<K,V>
A builder for creating immutable multimap instances, especially
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 Summary | |
|---|---|
ImmutableMultimap.Builder()
Creates a new builder. |
|
| Method Summary | |
|---|---|
ImmutableMultimap<K,V> |
build()
Returns a newly-created immutable multimap. |
ImmutableMultimap.Builder<K,V> |
orderKeysBy(Comparator<? super K> keyComparator)
Specifies the ordering of the generated multimap's keys. |
ImmutableMultimap.Builder<K,V> |
orderValuesBy(Comparator<? super V> valueComparator)
Specifies the ordering of the generated multimap's values for each key. |
ImmutableMultimap.Builder<K,V> |
put(K key,
V value)
Adds a key-value mapping to the built multimap. |
ImmutableMultimap.Builder<K,V> |
put(Map.Entry<? extends K,? extends V> entry)
Adds an entry to the built multimap. |
ImmutableMultimap.Builder<K,V> |
putAll(K key,
Iterable<? extends V> values)
Stores a collection of values with the same key in the built multimap. |
ImmutableMultimap.Builder<K,V> |
putAll(K key,
V... values)
Stores an array of values with the same key in the built multimap. |
ImmutableMultimap.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 |
|---|
public ImmutableMultimap.Builder()
ImmutableMultimap.builder().
| Method Detail |
|---|
public ImmutableMultimap.Builder<K,V> put(K key,
V value)
public ImmutableMultimap.Builder<K,V> put(Map.Entry<? extends K,? extends V> entry)
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.@Beta public ImmutableMultimap.Builder<K,V> orderKeysBy(Comparator<? super K> keyComparator)
@Beta public ImmutableMultimap.Builder<K,V> orderValuesBy(Comparator<? super V> valueComparator)
public ImmutableMultimap<K,V> build()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||