Package com.google.common.collect
Class ImmutableMultimap.Builder<K,V>
java.lang.Object
com.google.common.collect.ImmutableMultimap.Builder<K,V>
- Direct Known Subclasses:
ImmutableListMultimap.Builder
,ImmutableSetMultimap.Builder
- Enclosing class:
ImmutableMultimap<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.
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Returns a newly-created immutable multimap.orderKeysBy
(Comparator<? super K> keyComparator) Specifies the ordering of the generated multimap's keys.orderValuesBy
(Comparator<? super V> valueComparator) Specifies the ordering of the generated multimap's values for each key.Adds an entry to the built multimap.Adds a key-value mapping to the built multimap.Stores another multimap's entries in the built multimap.Adds entries to the built multimap.Stores a collection of values with the same key in the built multimap.Stores an array of values with the same key in the built multimap.
-
Constructor Details
-
Builder
public Builder()Creates a new builder. The returned builder is equivalent to the builder generated byImmutableMultimap.builder()
.
-
-
Method Details
-
put
Adds a key-value mapping to the built multimap. -
put
Adds an entry to the built multimap.- Since:
- 11.0
-
putAll
@Beta public ImmutableMultimap.Builder<K,V> putAll(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries) Adds entries to the built multimap.- Since:
- 19.0
-
putAll
Stores a collection of values with the same key in the built multimap.- Throws:
NullPointerException
- ifkey
,values
, or any element invalues
is null. The builder is left in an invalid state.
-
putAll
Stores an array of values with the same key in the built multimap.- Throws:
NullPointerException
- if the key or any value is null. The builder is left in an invalid state.
-
putAll
Stores another multimap's entries in the built multimap. The generated multimap's key and value orderings correspond to the iteration ordering of themultimap.asMap()
view, with new keys and values following any existing keys and values.- Throws:
NullPointerException
- if any key or value inmultimap
is null. The builder is left in an invalid state.
-
orderKeysBy
Specifies the ordering of the generated multimap's keys.- Since:
- 8.0
-
orderValuesBy
Specifies the ordering of the generated multimap's values for each key.- Since:
- 8.0
-
build
Returns a newly-created immutable multimap.
-