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>
@Deprecated(since="2022-12-01") public static class ImmutableMultimap.Builder<K,V> extends Object
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
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 (imported from Google Collections Library)

  • Constructor Details

    • Builder

      public Builder()
      Deprecated.
      Creates a new builder. The returned builder is equivalent to the builder generated by ImmutableMultimap.builder().

  • Method Details

    • put

      public ImmutableMultimap.Builder<K,V> put(K key, V value)
      Deprecated.
      Adds a key-value mapping to the built multimap.

    • put

      public ImmutableMultimap.Builder<K,V> put(Map.Entry<? extends K,? extends V> entry)
      Deprecated.
      Adds an entry to the built multimap.
      Since:
      11.0

    • putAll

      public ImmutableMultimap.Builder<K,V> putAll(K key, Iterable<? extends V> values)
      Deprecated.
      Stores a collection of values with the same key in the built multimap.
      Throws:
      NullPointerException - if key, values, or any element in values is null. The builder is left in an invalid state.

    • putAll

      public ImmutableMultimap.Builder<K,V> putAll(K key, V... values)
      Deprecated.
      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

      public ImmutableMultimap.Builder<K,V> putAll(Multimap<? extends K,? extends V> multimap)
      Deprecated.
      Stores another multimap's entries in the built multimap. The generated multimap's key and value orderings correspond to the iteration ordering of the multimap.asMap() view, with new keys and values following any existing keys and values.
      Throws:
      NullPointerException - if any key or value in multimap is null. The builder is left in an invalid state.

    • orderKeysBy

      public ImmutableMultimap.Builder<K,V> orderKeysBy(Comparator<? super K> keyComparator)
      Deprecated.
      Specifies the ordering of the generated multimap's keys.
      Since:
      8.0

    • orderValuesBy

      public ImmutableMultimap.Builder<K,V> orderValuesBy(Comparator<? super V> valueComparator)
      Deprecated.
      Specifies the ordering of the generated multimap's values for each key.
      Since:
      8.0

    • build

      public ImmutableMultimap<K,V> build()
      Deprecated.
      Returns a newly-created immutable multimap.