All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • javadoc.com.google.common.collect.ImmutableListMultimap.Builder.html Maven / Gradle / Ivy

    The newest version!
    






ImmutableListMultimap.Builder (Guava: Google Core Libraries for Java 11.0.1 API)













    






    

    



    
  
    
      Overview 
      Package 
    Class 
      Use 
      Tree 
      Deprecated 
      Index 
      Help 
  
    

    
    		




    


    

 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 





    

    

  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

    

    




    


    

com.google.common.collect

    
Class ImmutableListMultimap.Builder<K,V>
    

    java.lang.Object
  extended by com.google.common.collect.ImmutableMultimap.Builder<K,V>
      extended by com.google.common.collect.ImmutableListMultimap.Builder<K,V>

    

    

    Enclosing class:
    ImmutableListMultimap<K,V>
    

    

    

    

    public static final class ImmutableListMultimap.Builder<K,V>
    extends ImmutableMultimap.Builder<K,V>

    A builder for creating immutable ListMultimap instances, especially public static final multimaps ("constant multimaps"). Example: 

       static final Multimap<String, Integer> STRING_TO_INTEGER_MULTIMAP =
       new ImmutableListMultimap.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 Summary
    ImmutableListMultimap.Builder()
              Creates a new builder.
     
    Method Summary
     ImmutableListMultimap<K,V> build()
              Returns a newly-created immutable list multimap.
     ImmutableListMultimap.Builder<K,V> orderKeysBy(Comparator<? super K> keyComparator)
              Specifies the ordering of the generated multimap's keys.
     ImmutableListMultimap.Builder<K,V> orderValuesBy(Comparator<? super V> valueComparator)
              Specifies the ordering of the generated multimap's values for each key.
     ImmutableListMultimap.Builder<K,V> put(K key, V value)
              Adds a key-value mapping to the built multimap.
     ImmutableListMultimap.Builder<K,V> put(Map.Entry<? extends K,? extends V> entry)
              Adds an entry to the built multimap.
     ImmutableListMultimap.Builder<K,V> putAll(K key, Iterable<? extends V> values)
              Stores a collection of values with the same key in the built multimap.
     ImmutableListMultimap.Builder<K,V> putAll(K key, V... values)
              Stores an array of values with the same key in the built multimap.
     ImmutableListMultimap.Builder<K,V> putAll(Multimap<? extends K,? extends V> multimap)
              Stores another multimap's entries in the built multimap.
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Constructor Detail

    ImmutableListMultimap.Builder

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

    Method Detail

    put

    public ImmutableListMultimap.Builder<K,V> put(K key,
                                              V value)
    Description copied from class: ImmutableMultimap.Builder
    Adds a key-value mapping to the built multimap.

    Overrides:
    put in class ImmutableMultimap.Builder<K,V>

    put

    public ImmutableListMultimap.Builder<K,V> put(Map.Entry<? extends K,? extends V> entry)
    Adds an entry to the built multimap.

    Overrides:
    put in class ImmutableMultimap.Builder<K,V>
    Since:
    11.0

    putAll

    public ImmutableListMultimap.Builder<K,V> putAll(K key,
                                                 Iterable<? extends V> values)
    Description copied from class: ImmutableMultimap.Builder
    Stores a collection of values with the same key in the built multimap.

    Overrides:
    putAll in class ImmutableMultimap.Builder<K,V>

    putAll

    public ImmutableListMultimap.Builder<K,V> putAll(K key,
                                                 V... values)
    Description copied from class: ImmutableMultimap.Builder
    Stores an array of values with the same key in the built multimap.

    Overrides:
    putAll in class ImmutableMultimap.Builder<K,V>

    putAll

    public ImmutableListMultimap.Builder<K,V> putAll(Multimap<? extends K,? extends V> multimap)
    Description copied from class: ImmutableMultimap.Builder
    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.

    Overrides:
    putAll in class ImmutableMultimap.Builder<K,V>

    orderKeysBy

    @Beta
public ImmutableListMultimap.Builder<K,V> orderKeysBy(Comparator<? super K> keyComparator)
    Specifies the ordering of the generated multimap's keys.

    Overrides:
    orderKeysBy in class ImmutableMultimap.Builder<K,V>
    Since:
    8.0

    orderValuesBy

    @Beta
public ImmutableListMultimap.Builder<K,V> orderValuesBy(Comparator<? super V> valueComparator)
    Specifies the ordering of the generated multimap's values for each key.

    Overrides:
    orderValuesBy in class ImmutableMultimap.Builder<K,V>
    Since:
    8.0

    build

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

    Overrides:
    build in class ImmutableMultimap.Builder<K,V>
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
     PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
    SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    Copyright © 2010-2012. All Rights Reserved.



    © 2015 - 2025 Weber Informatics LLC | Privacy Policy