Package com.google.common.collect
Class ImmutableSetMultimap.Builder<K,V>
java.lang.Object
com.google.common.collect.ImmutableMultimap.Builder<K,V>
com.google.common.collect.ImmutableSetMultimap.Builder<K,V>
- Enclosing class:
- ImmutableSetMultimap<K,
V>
A builder for creating immutable
SetMultimap instances, especially public static
final multimaps ("constant multimaps"). Example:
static final Multimap<String, Integer> STRING_TO_INTEGER_MULTIMAP =
new ImmutableSetMultimap.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
-
Field Summary
Fields inherited from class com.google.common.collect.ImmutableMultimap.Builder
builderMap, keyComparator, valueComparator -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Returns a newly-created immutable set multimap.(package private) ImmutableSetMultimap.Builder<K,V> combine(ImmutableMultimap.Builder<K, V> other) (package private) Collection<V>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 if it is not already present.Adds a key-value mapping to the built multimap if it is not already present.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 byImmutableSetMultimap.builder().
-
-
Method Details
-
newMutableValueCollection
Collection<V> newMutableValueCollection()- Overrides:
newMutableValueCollectionin classImmutableMultimap.Builder<K,V>
-
put
Adds a key-value mapping to the built multimap if it is not already present.- Overrides:
putin classImmutableMultimap.Builder<K,V>
-
put
Adds an entry to the built multimap if it is not already present.- Overrides:
putin classImmutableMultimap.Builder<K,V> - Since:
- 11.0
-
putAll
public ImmutableSetMultimap.Builder<K,V> putAll(Iterable<? extends Map.Entry<? extends K, ? extends V>> entries) Adds entries to the built multimap.- Overrides:
putAllin classImmutableMultimap.Builder<K,V> - Since:
- 19.0
-
putAll
Description copied from class:ImmutableMultimap.BuilderStores a collection of values with the same key in the built multimap.- Overrides:
putAllin classImmutableMultimap.Builder<K,V>
-
putAll
Description copied from class:ImmutableMultimap.BuilderStores an array of values with the same key in the built multimap.- Overrides:
putAllin classImmutableMultimap.Builder<K,V>
-
putAll
Description copied from class:ImmutableMultimap.BuilderStores 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.- Overrides:
putAllin classImmutableMultimap.Builder<K,V>
-
combine
- Overrides:
combinein classImmutableMultimap.Builder<K,V>
-
orderKeysBy
Specifies the ordering of the generated multimap's keys.- Overrides:
orderKeysByin classImmutableMultimap.Builder<K,V> - Since:
- 8.0
-
orderValuesBy
Specifies the ordering of the generated multimap's values for each key.If this method is called, the sets returned by the
get()method of the generated multimap and itsMultimap.asMap()view areImmutableSortedSetinstances. However, serialization does not preserve that property, though it does maintain the key and value ordering.- Overrides:
orderValuesByin classImmutableMultimap.Builder<K,V> - Since:
- 8.0
-
build
Returns a newly-created immutable set multimap.- Overrides:
buildin classImmutableMultimap.Builder<K,V>
-