Package org.eclipse.collections.api.multimap.bag

Interface MutableBagIterableMultimap<K,V>

All Superinterfaces:
BagMultimap<K,V>, Multimap<K,V>, MutableMultimap<K,V>
All Known Subinterfaces:
MutableBagMultimap<K,V>, MutableSortedBagMultimap<K,V>
All Known Implementing Classes:
AbstractMutableBagMultimap, HashBagMultimap, HashBagMultimapWithHashingStrategy, MultiReaderHashBagMultimap, SynchronizedBagMultimap, SynchronizedPutHashBagMultimap, SynchronizedSortedBagMultimap, TreeBagMultimap, TreeBagMultimap, TreeBagMultimap
public interface MutableBagIterableMultimap<K,V> extends MutableMultimap<K,V>, BagMultimap<K,V>
Since:
6.0

  • Method Details

    • withKeyValue

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

    • withKeyMultiValues

      default MutableBagIterableMultimap<K,V> withKeyMultiValues(K key, V... values)
      Description copied from interface: MutableMultimap
      Puts the key / values combination into the MutableMultimap and returns the MutableMultimap (this).
      Specified by:
      withKeyMultiValues in interface MutableMultimap<K,V>

    • replaceValues

      MutableBagIterable<V> replaceValues(K key, Iterable<? extends V> values)
      Specified by:
      replaceValues in interface MutableMultimap<K,V>

    • removeAll

      MutableBagIterable<V> removeAll(Object key)
      Specified by:
      removeAll in interface MutableMultimap<K,V>

    • newEmpty

      MutableBagIterableMultimap<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 BagMultimap<K,V>
      Specified by:
      newEmpty in interface Multimap<K,V>
      Specified by:
      newEmpty in interface MutableMultimap<K,V>

    • get

      MutableBagIterable<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 BagMultimap<K,V>
      Specified by:
      get in interface Multimap<K,V>
      Specified by:
      get in interface MutableMultimap<K,V>
      Parameters:
      key - the key to search for

    • getIfAbsentPutAll

      MutableBagIterable<V> getIfAbsentPutAll(K key, Iterable<? extends V> values)
      Description copied from interface: MutableMultimap
      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)
      Specified by:
      getIfAbsentPutAll in interface MutableMultimap<K,V>

    • flip

      MutableBagIterableMultimap<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 BagMultimap<K,V>
      Specified by:
      flip in interface Multimap<K,V>
      Specified by:
      flip in interface MutableMultimap<K,V>

    • selectKeysValues

      MutableBagIterableMultimap<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 BagMultimap<K,V>
      Specified by:
      selectKeysValues in interface Multimap<K,V>
      Specified by:
      selectKeysValues in interface MutableMultimap<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

      MutableBagIterableMultimap<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 BagMultimap<K,V>
      Specified by:
      rejectKeysValues in interface Multimap<K,V>
      Specified by:
      rejectKeysValues in interface MutableMultimap<K,V>
      Parameters:
      predicate - a Predicate2 to use as the reject criteria
      Returns:
      Multimap, which contains elements that don't satisfy the predicate

    • selectKeysMultiValues

      MutableBagIterableMultimap<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 BagMultimap<K,V>
      Specified by:
      selectKeysMultiValues in interface Multimap<K,V>
      Specified by:
      selectKeysMultiValues in interface MutableMultimap<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

      MutableBagIterableMultimap<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 BagMultimap<K,V>
      Specified by:
      rejectKeysMultiValues in interface Multimap<K,V>
      Specified by:
      rejectKeysMultiValues in interface MutableMultimap<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> MutableBagIterableMultimap<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>
      Specified by:
      collectKeysValues in interface MutableMultimap<K,V>
      Parameters:
      function - a Function2 to use for transformation
      Returns:
      Multimap, which contains elements as a result of the transformation

    • collectKeyMultiValues

      <K2, V2> MutableBagIterableMultimap<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>
      Specified by:
      collectKeyMultiValues in interface MutableMultimap<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

    • 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>
      Specified by:
      collectValues in interface MutableMultimap<K,V>
      Parameters:
      function - a Function to use for transformation
      Returns:
      Multimap, which contains elements as a result of the transformation

    • asSynchronized

      MutableBagIterableMultimap<K,V> asSynchronized()
      Description copied from interface: MutableMultimap
      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.

      Specified by:
      asSynchronized in interface MutableMultimap<K,V>
      Returns:
      a synchronized view of this multimap.
      See Also: