Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.collect.MultimapBuilder

An immutable builder for Multimap instances, letting you independently select the desired behaviors (for example, ordering) of the backing map and value-collections. Example:

ListMultimap<UserId, ErrorResponse> errorsByUser =
    MultimapBuilder.linkedHashKeys().arrayListValues().build();
SortedSetMultimap<String, Method> methodsForName =
    MultimapBuilder.treeKeys().treeSetValues(this::compareMethods).build();

MultimapBuilder instances are immutable. Invoking a configuration method has no effect on the receiving instance; you must store and use the new builder instance it returns instead.

The generated multimaps are serializable if the key and value types are serializable, unless stated otherwise in one of the configuration methods.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	MultimapBuilder.ArrayListSupplier<V extends @Nullable Object>
private static class	MultimapBuilder.EnumSetSupplier<V extends Enum<V>>
private static class	MultimapBuilder.HashSetSupplier<V extends @Nullable Object>
private static class	MultimapBuilder.LinkedHashSetSupplier<V extends @Nullable Object>
private static enum	MultimapBuilder.LinkedListSupplier
public abstract static class	MultimapBuilder.ListMultimapBuilder<K0 extends @Nullable Object, V0 extends @Nullable Object> A specialization of `MultimapBuilder` that generates `ListMultimap` instances.
public abstract static class	MultimapBuilder.MultimapBuilderWithKeys< The upper bound on the key type of the generated multimap. K0 extends @Nullable Object> An intermediate stage in a `MultimapBuilder` in which the key-value collection map implementation has been specified, but the value collection implementation has not.
public abstract static class	MultimapBuilder.SetMultimapBuilder<K0 extends @Nullable Object, V0 extends @Nullable Object> A specialization of `MultimapBuilder` that generates `SetMultimap` instances.
public abstract static class	MultimapBuilder.SortedSetMultimapBuilder<K0 extends @Nullable Object, V0 extends @Nullable Object> A specialization of `MultimapBuilder` that generates `SortedSetMultimap` instances.
private static class	MultimapBuilder.TreeSetSupplier<V extends @Nullable Object>

Field Summary

Modifier and Type	Field and Description
private static final int	DEFAULT_EXPECTED_KEYS

Constructor Summary

Access	Constructor and Description
private	MultimapBuilder()

Method Summary

Modifier and Type	Method and Description
public abstract <K extends K0, V extends V0> Multimap<K, V>	build() Returns a new, empty `Multimap` with the specified implementation.
public <K extends K0, V extends V0> Multimap<K, V>	build(Multimap<? extends K, ? extends V> multimap) Returns a `Multimap` with the specified implementation, initialized with the entries of `multimap`.
public static <K0 extends Enum<K0>> MultimapBuilder.MultimapBuilderWithKeys<K0>	enumKeys(Class<K0> keyClass) Uses an `EnumMap` to map keys to value collections.
public static MultimapBuilder.MultimapBuilderWithKeys<@Nullable Object>	hashKeys() Uses a hash table to map keys to value collections.
public static MultimapBuilder.MultimapBuilderWithKeys<@Nullable Object>	hashKeys(int expectedKeys) Uses a hash table to map keys to value collections, initialized to expect the specified number of keys.
public static MultimapBuilder.MultimapBuilderWithKeys<@Nullable Object>	linkedHashKeys() Uses a hash table to map keys to value collections.
public static MultimapBuilder.MultimapBuilderWithKeys<@Nullable Object>	linkedHashKeys(int expectedKeys) Uses an hash table to map keys to value collections, initialized to expect the specified number of keys.
public static MultimapBuilder.MultimapBuilderWithKeys<Comparable<T>>	treeKeys() Uses a naturally-ordered `TreeMap` to map keys to value collections.
public static <K0 extends @Nullable Object> MultimapBuilder.MultimapBuilderWithKeys<K0>	treeKeys(Comparator<K0> comparator) Uses a `TreeMap` sorted by the specified comparator to map keys to value collections.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public abstract Class MultimapBuilder<K0 extends @Nullable Object, V0 extends @Nullable Object>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary