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

Interface MutableBagMultimap<K,V>

All Superinterfaces:

BagMultimap<K,V>, Multimap<K,V>, MutableBagIterableMultimap<K,V>, MutableMultimap<K,V>, UnsortedBagMultimap<K,V>

All Known Implementing Classes:

AbstractMutableBagMultimap, HashBagMultimap, HashBagMultimapWithHashingStrategy, MultiReaderHashBagMultimap, SynchronizedBagMultimap, SynchronizedPutHashBagMultimap

public interface MutableBagMultimap<K,V>
extends MutableBagIterableMultimap<K,V>, UnsortedBagMultimap<K,V>

Since:

1.0

Method Summary

Modifier and Type	Method	Description
MutableBagMultimap<K,V>	asSynchronized()	Returns a synchronized wrapper backed by this multimap.
<K2, V2> MutableBagMultimap<K2,V2>	collectKeyMultiValues(Function<? super K,? extends K2> keyFunction, Function<? super V,? extends V2> valueFunction)	Returns a new multimap with the results of applying the specified keyFunction and valueFunction on each key and corresponding values of the source multimap.
<K2, V2> MutableBagMultimap<K2,V2>	collectKeysValues(Function2<? super K,? super V,Pair<K2,V2>> function)	Returns a new multimap with the results of applying the specified function on each key and value of the source multimap.
<V2> MutableBagMultimap<K,V2>	collectValues(Function<? super V,? extends V2> function)	Returns a new multimap with the results of applying the specified function on each value of the source multimap.
MutableBagMultimap<V,K>	flip()	Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
void	forEachKeyMutableBag(Procedure2<? super K,? super MutableBag<V>> procedure)
MutableBag<V>	get(K key)	Returns a view of all values associated with the given key.
MutableBag<V>	getIfAbsentPutAll(K key, Iterable<? extends V> values)	Puts values into multimap if there are no values already associated with key.
MutableBagMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
void	putOccurrences(K key, V value, int occurrences)
MutableBagMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
MutableBagMultimap<K,V>	rejectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
MutableBag<V>	removeAll(Object key)
MutableBag<V>	replaceValues(K key, Iterable<? extends V> values)
MutableBagMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
MutableBagMultimap<K,V>	selectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that satisfies the predicate.
default MutableBagMultimap<K,V>	withKeyMultiValues(K key, V... values)	Puts the key / values combination into the MutableMultimap and returns the MutableMultimap (this).
default MutableBagMultimap<K,V>	withKeyValue(K key, V value)	Puts the key / value combination into the MutableBagMultimap and returns the MutableBagMultimap (this).

Methods inherited from interface org.eclipse.collections.api.multimap.Multimap

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keySet, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, size, sizeDistinct, toMap, toMap, valuesView

Methods inherited from interface org.eclipse.collections.api.multimap.MutableMultimap

add, clear, put, putAll, putAll, putAllPairs, putAllPairs, remove

Methods inherited from interface org.eclipse.collections.api.multimap.bag.UnsortedBagMultimap

toImmutable, toMutable

Method Details

withKeyValue

default MutableBagMultimap<K,V> withKeyValue(K key,
 V value)

Puts the key / value combination into the MutableBagMultimap and returns the MutableBagMultimap (this).

Specified by:

withKeyValue in interface MutableBagIterableMultimap<K,V>

Specified by:

withKeyValue in interface MutableMultimap<K,V>

Since:

11.1

withKeyMultiValues

default MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

withKeyMultiValues in interface MutableMultimap<K,V>

forEachKeyMutableBag

void forEachKeyMutableBag(Procedure2<? super K,? super MutableBag<V>> procedure)

Since:

11.0

replaceValues

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

Specified by:

replaceValues in interface MutableBagIterableMultimap<K,V>

Specified by:

replaceValues in interface MutableMultimap<K,V>

removeAll

MutableBag<V> removeAll(Object key)

Specified by:

removeAll in interface MutableBagIterableMultimap<K,V>

Specified by:

removeAll in interface MutableMultimap<K,V>

newEmpty

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

newEmpty in interface MutableMultimap<K,V>

Specified by:

newEmpty in interface UnsortedBagMultimap<K,V>

get

MutableBag<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 MutableBagIterableMultimap<K,V>

Specified by:

get in interface MutableMultimap<K,V>

Specified by:

get in interface UnsortedBagMultimap<K,V>

Parameters:

key - the key to search for

getIfAbsentPutAll

MutableBag<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 MutableBagIterableMultimap<K,V>

Specified by:

getIfAbsentPutAll in interface MutableMultimap<K,V>

putOccurrences

void putOccurrences(K key,
 V value,
 int occurrences)

flip

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

flip in interface MutableMultimap<K,V>

selectKeysValues

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

selectKeysValues in interface MutableMultimap<K,V>

Specified by:

selectKeysValues in interface UnsortedBagMultimap<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

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface MutableMultimap<K,V>

Specified by:

rejectKeysValues in interface UnsortedBagMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

selectKeysMultiValues

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface MutableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface UnsortedBagMultimap<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

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface MutableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface UnsortedBagMultimap<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> MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

collectKeysValues in interface MutableMultimap<K,V>

Specified by:

collectKeysValues in interface UnsortedBagMultimap<K,V>

Parameters:

function - a Function2 to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation

collectKeyMultiValues

<K2,
V2> MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface MutableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface UnsortedBagMultimap<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> MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

collectValues in interface MutableMultimap<K,V>

Specified by:

collectValues in interface UnsortedBagMultimap<K,V>

Parameters:

function - a Function to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation

asSynchronized

MutableBagMultimap<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 MutableBagIterableMultimap<K,V>

Specified by:

asSynchronized in interface MutableMultimap<K,V>

Returns:

a synchronized view of this multimap.

See Also:

• MutableMapIterable.asSynchronized()