Package org.eclipse.collections.api.multimap

Interface MutableMultimap<K,V>

All Superinterfaces:
Multimap<K,V>
All Known Subinterfaces:
MutableBagIterableMultimap<K,V>, MutableBagMultimap<K,V>, MutableListMultimap<K,V>, MutableSetIterableMultimap<K,V>, MutableSetMultimap<K,V>, MutableSortedBagMultimap<K,V>, MutableSortedSetMultimap<K,V>
public interface MutableMultimap<K,V> extends Multimap<K,V>
Since:
1.0

  • Method Details

    • newEmpty

      MutableMultimap<K,V> newEmpty()
      Description copied from interface: Multimap
      Creates a new instance of the same implementation type, using the default capacity and growth parameters.
      Specified by:
      newEmpty in interface Multimap<K,V>

    • get

      MutableCollection<V> get(K key)
      Description copied from interface: Multimap
      Returns a view of all values associated with the given key.

      If the given key does not exist, an empty RichIterable is returned.

      Specified by:
      get in interface Multimap<K,V>
      Parameters:
      key - the key to search for

    • put

      boolean put(K key, V value)

    • withKeyValue

      default MutableMultimap<K,V> withKeyValue(K key, V value)
      Puts the key / value combination into the MutableMultimap and returns the MutableMultimap (this).
      Since:
      11.1

    • withKeyMultiValues

      default MutableMultimap<K,V> withKeyMultiValues(K key, V... values)
      Puts the key / values combination into the MutableMultimap and returns the MutableMultimap (this).
      Since:
      11.1

    • add

      default boolean add(Pair<? extends K,? extends V> keyValuePair)
      Modification operation similar to put, however, takes the key-value pair as the input.
      Parameters:
      keyValuePair - key value pair to add in the multimap
      Since:
      6.0
      See Also:

    • remove

      boolean remove(Object key, Object value)

    • putAllPairs

      default boolean putAllPairs(Pair<? extends K,? extends V>... pairs)

    • putAllPairs

      default boolean putAllPairs(Iterable<? extends Pair<? extends K,? extends V>> pairs)

    • putAll

      boolean putAll(K key, Iterable<? extends V> values)

    • putAll

      <KK extends K, VV extends V> boolean putAll(Multimap<KK,VV> multimap)

    • replaceValues

      RichIterable<V> replaceValues(K key, Iterable<? extends V> values)

    • removeAll

      RichIterable<V> removeAll(Object key)

    • getIfAbsentPutAll

      MutableCollection<V> getIfAbsentPutAll(K key, Iterable<? extends V> values)
      Puts values into multimap if there are no values already associated with key. Then returns a view of the values associated with key, like the result of Multimap.get(Object)
      Since:
      10.0

    • clear

      void clear()

    • flip

      MutableMultimap<V,K> flip()
      Description copied from interface: Multimap
      Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
      Specified by:
      flip in interface Multimap<K,V>

    • selectKeysValues

      MutableMultimap<K,V> selectKeysValues(Predicate2<? super K,? super V> predicate)
      Description copied from interface: Multimap
      Returns all elements of the source multimap that satisfies the predicate. This method is also commonly called filter. 
      e.g.
 return multimap.selectKeysValues(new Predicate2<Integer, Person>()
 {
     public boolean accept(Integer age, Person person)
     {
         return (age >= 18)
                  && (person.getAddress().getCity().equals("Metuchen"));
     }
 });
      Specified by:
      selectKeysValues in interface Multimap<K,V>
      Parameters:
      predicate - a Predicate2 to use as the select criteria
      Returns:
      Multimap, which contains elements as a result of the select criteria

    • rejectKeysValues

      MutableMultimap<K,V> rejectKeysValues(Predicate2<? super K,? super V> predicate)
      Description copied from interface: Multimap
      Returns all elements of the source multimap that don't satisfy the predicate. 
      e.g.
 return multimap.rejectKeysValues(new Predicate2<Integer, Person>()
 {
     public boolean accept(Integer age, Person person)
     {
         return (age >= 18)
                  && (person.getAddress().getCity().equals("Metuchen"));
     }
 });
      Specified by:
      rejectKeysValues in interface Multimap<K,V>
      Parameters:
      predicate - a Predicate2 to use as the reject criteria
      Returns:
      Multimap, which contains elements that don't satisfy the predicate

    • selectKeysMultiValues

      MutableMultimap<K,V> selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)
      Description copied from interface: Multimap
      Returns all elements of the source multimap that satisfies the predicate. This method is also commonly called filter. 
      e.g.
 return multimap.selectKeysMultiValues(new Predicate2<Integer, Iterable<Person>>()
 {
     public boolean accept(Integer age, Iterable<Person> values)
     {
         return (age >= 18)
                  && ((RichIterable<Person>)values.size() >= 2);
     }
 });
      Specified by:
      selectKeysMultiValues in interface Multimap<K,V>
      Parameters:
      predicate - a Predicate2 to use as the select criteria
      Returns:
      Multimap, which contains elements as a result of the select criteria

    • rejectKeysMultiValues

      MutableMultimap<K,V> rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)
      Description copied from interface: Multimap
      Returns all elements of the source multimap that don't satisfy the predicate. 
      e.g.
 return multimap.rejectKeysMultiValues(new Predicate2<Integer, Iterable<Person>>()
 {
     public boolean accept(Integer age, Iterable<Person> values)
     {
         return (age >= 18)
                  && ((RichIterable<Person>)values.size() >= 2);
     }
 });
      Specified by:
      rejectKeysMultiValues in interface Multimap<K,V>
      Parameters:
      predicate - a Predicate2 to use as the reject criteria
      Returns:
      Multimap, which contains elements that don't satisfy the predicate

    • collectKeysValues

      <K2, V2> MutableMultimap<K2,V2> collectKeysValues(Function2<? super K,? super V,Pair<K2,V2>> function)
      Description copied from interface: Multimap
      Returns a new multimap with the results of applying the specified function on each key and value of the source multimap. This method is also commonly called transform or map. 
      e.g.
 return multimap.collectKeysValues(new Function2<Integer, Person, Pair<String, String>>()
 {
     public Pair<String, String> valueOf(Integer age, Person person)
     {
         return Tuples.pair(age.toString(), person.getLastName());
     }
 });
      Specified by:
      collectKeysValues in interface Multimap<K,V>
      Parameters:
      function - a Function2 to use for transformation
      Returns:
      Multimap, which contains elements as a result of the transformation

    • collectValues

      <V2> MutableMultimap<K,V2> collectValues(Function<? super V,? extends V2> function)
      Description copied from interface: Multimap
      Returns a new multimap with the results of applying the specified function on each value of the source multimap. This method is also commonly called transform or map. 
      e.g.
 return multimap.collectValues(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getLastName();
     }
 });
      Specified by:
      collectValues in interface Multimap<K,V>
      Parameters:
      function - a Function to use for transformation
      Returns:
      Multimap, which contains elements as a result of the transformation

    • collectKeyMultiValues

      <K2, V2> MutableMultimap<K2,V2> collectKeyMultiValues(Function<? super K,? extends K2> keyFunction, Function<? super V,? extends V2> valueFunction)
      Description copied from interface: Multimap
      Returns a new multimap with the results of applying the specified keyFunction and valueFunction on each key and corresponding values of the source multimap. This method is also commonly called transform or map. 
      e.g.
 return multimap.collectKeyMultiValues(each -> each + 1, Person::getLastName);
      Specified by:
      collectKeyMultiValues in interface Multimap<K,V>
      Parameters:
      keyFunction - Function to use transformation to get the key
      valueFunction - Function to use transformation to get the values
      Returns:
      a new Multimap, which contains elements as a result of the transformation

    • asSynchronized

      MutableMultimap<K,V> asSynchronized()
      Returns a synchronized wrapper backed by this multimap. The preferred way of iterating over a synchronized multimap is to use the forEachKey(), forEachValue(), forEachKeyValue() and forEachKeyMultiValues methods which are properly synchronized internally. 
        MutableMultimap synchedMultimap = multimap.asSynchronized();

  synchedMultimap.forEachKey(key -> ... );
  synchedMultimap.forEachValue(value -> ... );
  synchedMultimap.forEachKeyValue((key, value) -> ... );
  synchedMultimap.forEachKeyMultiValues((key, values) -> ... );

      If you want to iterate imperatively over the keySet(), keysView(), valuesView(), or other views, you will need to protect the iteration by wrapping the code in a synchronized block on the multimap.

      Returns:
      a synchronized view of this multimap.
      Since:
      8.0
      See Also: