Class ImmutableMultimap.Builder<K,​V>

  • Direct Known Subclasses:
    ImmutableListMultimap.Builder, ImmutableSetMultimap.Builder
    Enclosing class:
    ImmutableMultimap<K,​V>

    @DoNotMock
    public static class ImmutableMultimap.Builder<K,​V>
    extends java.lang.Object
    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
    • Method Detail

      • put

        @CanIgnoreReturnValue
        public ImmutableMultimap.Builder<K,​Vput​(java.util.Map.Entry<? extends K,​? extends V> entry)
        Adds an entry to the built multimap.
        Since:
        11.0
      • putAll

        @CanIgnoreReturnValue
        public ImmutableMultimap.Builder<K,​VputAll​(java.lang.Iterable<? extends java.util.Map.Entry<? extends K,​? extends V>> entries)
        Adds entries to the built multimap.
        Since:
        19.0
      • putAll

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

        @CanIgnoreReturnValue
        public ImmutableMultimap.Builder<K,​VputAll​(K key,
                                                           V... values)
        Stores an array of values with the same key in the built multimap.
        Throws:
        java.lang.NullPointerException - if the key or any value is null. The builder is left in an invalid state.
      • putAll

        @CanIgnoreReturnValue
        public ImmutableMultimap.Builder<K,​VputAll​(Multimap<? extends K,​? extends V> multimap)
        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:
        java.lang.NullPointerException - if any key or value in multimap is null. The builder is left in an invalid state.
      • orderKeysBy

        @CanIgnoreReturnValue
        public ImmutableMultimap.Builder<K,​VorderKeysBy​(java.util.Comparator<? super K> keyComparator)
        Specifies the ordering of the generated multimap's keys.
        Since:
        8.0
      • orderValuesBy

        @CanIgnoreReturnValue
        public ImmutableMultimap.Builder<K,​VorderValuesBy​(java.util.Comparator<? super V> valueComparator)
        Specifies the ordering of the generated multimap's values for each key.
        Since:
        8.0