Class MultimapBuilder.MultimapBuilderWithKeys<K0 extends @Nullable Object>

java.lang.Object

com.google.common.collect.MultimapBuilder.MultimapBuilderWithKeys<K0>

Type Parameters:

K0 - The upper bound on the key type of the generated multimap.

Enclosing class:

MultimapBuilder<K0 extends @Nullable Object, V0 extends @Nullable Object>

public abstract static class MultimapBuilder.MultimapBuilderWithKeys<K0 extends @Nullable Object>
extends 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.

Since:

16.0

Author:

Louis Wasserman

Method Summary

Modifier and Type	Method	Description
MultimapBuilder.ListMultimapBuilder<K0, @Nullable Object>	arrayListValues()	Uses an ArrayList to store value collections.
MultimapBuilder.ListMultimapBuilder<K0, @Nullable Object>	arrayListValues(int expectedValuesPerKey)	Uses an ArrayList to store value collections, initialized to expect the specified number of values per key.
<V0 extends Enum<V0>> MultimapBuilder.SetMultimapBuilder<K0,V0>	enumSetValues(Class<V0> valueClass)	Uses an EnumSet to store value collections.
MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object>	hashSetValues()	Uses a hash-based Set to store value collections.
MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object>	hashSetValues(int expectedValuesPerKey)	Uses a hash-based Set to store value collections, initialized to expect the specified number of values per key.
MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object>	linkedHashSetValues()	Uses an insertion-ordered hash-based Set to store value collections.
MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object>	linkedHashSetValues(int expectedValuesPerKey)	Uses an insertion-ordered hash-based Set to store value collections, initialized to expect the specified number of values per key.
MultimapBuilder.ListMultimapBuilder<K0, @Nullable Object>	linkedListValues()	Uses a LinkedList to store value collections.
MultimapBuilder.SortedSetMultimapBuilder<K0, Comparable>	treeSetValues()	Uses a naturally-ordered TreeSet to store value collections.
<V0 extends @Nullable Object> MultimapBuilder.SortedSetMultimapBuilder<K0,V0>	treeSetValues(Comparator<V0> comparator)	Uses a TreeSet ordered by the specified comparator to store value collections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

arrayListValues

public MultimapBuilder.ListMultimapBuilder<K0, @Nullable Object> arrayListValues()

Uses an ArrayList to store value collections.

arrayListValues

public MultimapBuilder.ListMultimapBuilder<K0, @Nullable Object> arrayListValues(int expectedValuesPerKey)

Uses an ArrayList to store value collections, initialized to expect the specified number of values per key.

Throws:

IllegalArgumentException - if expectedValuesPerKey < 0

linkedListValues

public MultimapBuilder.ListMultimapBuilder<K0, @Nullable Object> linkedListValues()

Uses a LinkedList to store value collections.

Performance note: ArrayList and ArrayDeque consistently outperform LinkedList except in certain rare and specific situations. Unless you have spent a lot of time benchmarking your specific needs, use one of those instead. (However, we do not currently offer a Multimap implementation based on ArrayDeque.)

hashSetValues

public MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object> hashSetValues()

Uses a hash-based Set to store value collections.

hashSetValues

public MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object> hashSetValues(int expectedValuesPerKey)

Uses a hash-based Set to store value collections, initialized to expect the specified number of values per key.

Throws:

IllegalArgumentException - if expectedValuesPerKey < 0

linkedHashSetValues

public MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object> linkedHashSetValues()

Uses an insertion-ordered hash-based Set to store value collections.

linkedHashSetValues

public MultimapBuilder.SetMultimapBuilder<K0, @Nullable Object> linkedHashSetValues(int expectedValuesPerKey)

Uses an insertion-ordered hash-based Set to store value collections, initialized to expect the specified number of values per key.

Throws:

IllegalArgumentException - if expectedValuesPerKey < 0

treeSetValues

public MultimapBuilder.SortedSetMultimapBuilder<K0, Comparable> treeSetValues()

Uses a naturally-ordered TreeSet to store value collections.

treeSetValues

public <V0 extends @Nullable Object>
MultimapBuilder.SortedSetMultimapBuilder<K0,V0> treeSetValues(Comparator<V0> comparator)

Uses a TreeSet ordered by the specified comparator to store value collections.

Multimaps generated by the resulting builder will not be serializable if comparator is not serializable.

enumSetValues

public <V0 extends Enum<V0>>
MultimapBuilder.SetMultimapBuilder<K0,V0> enumSetValues(Class<V0> valueClass)

Uses an EnumSet to store value collections.