Package com.google.common.collect

Class ImmutableMultimap.Builder<K,​V>

  • Direct Known Subclasses:
    ImmutableListMultimap.Builder, ImmutableSetMultimap.Builder
    Enclosing class:
    ImmutableMultimap<K,​V>
    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: 
     {
        @code

        static final Multimap STRING_TO_INTEGER_MULTIMAP = new ImmutableMultimap.Builder()
                        .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 Detail

      • Builder

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

    • Method Detail

      • put

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

      • putAll

        public ImmutableMultimap.Builder<K,​V> putAll​(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

        public ImmutableMultimap.Builder<K,​V> putAll​(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

        public ImmutableMultimap.Builder<K,​V> putAll​(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

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

      • orderValuesBy

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