Interface MutableBagIterableMultimap<K,V>
-
- All Superinterfaces:
BagMultimap<K,V>,Multimap<K,V>,MutableMultimap<K,V>
- All Known Subinterfaces:
MutableBagMultimap<K,V>,MutableSortedBagMultimap<K,V>
public interface MutableBagIterableMultimap<K,V> extends MutableMultimap<K,V>, BagMultimap<K,V>
- Since:
- 6.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description MutableBagIterableMultimap<K,V>asSynchronized()Returns a synchronized wrapper backed by this multimap.<K2,V2>
MutableBagIterableMultimap<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>
MutableBagIterableMultimap<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> MutableMultimap<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.MutableBagIterableMultimap<V,K>flip()Given a Multimap from Domain->Range return a multimap from Range->Domain.MutableBagIterable<V>get(K key)Returns a view of all values associated with the given key.MutableBagIterable<V>getIfAbsentPutAll(K key, Iterable<? extends V> values)Puts values into multimap if there are no values already associated with key.MutableBagIterableMultimap<K,V>newEmpty()Creates a new instance of the same implementation type, using the default capacity and growth parameters.MutableBagIterableMultimap<K,V>rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)Returns all elements of the source multimap that don't satisfy the predicate.MutableBagIterableMultimap<K,V>rejectKeysValues(Predicate2<? super K,? super V> predicate)Returns all elements of the source multimap that don't satisfy the predicate.MutableBagIterable<V>removeAll(Object key)MutableBagIterable<V>replaceValues(K key, Iterable<? extends V> values)MutableBagIterableMultimap<K,V>selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)Returns all elements of the source multimap that satisfies the predicate.MutableBagIterableMultimap<K,V>selectKeysValues(Predicate2<? super K,? super V> predicate)Returns all elements of the source multimap that satisfies the predicate.default MutableBagIterableMultimap<K,V>withKeyMultiValues(K key, V... values)Puts the key / values combination into the MutableMultimap and returns the MutableMultimap (this).default MutableBagIterableMultimap<K,V>withKeyValue(K key, V value)Puts the key / value combination into the MutableBagIterableMultimap and returns the MutableBagIterableMultimap (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, toImmutable, toMap, toMap, toMutable, valuesView
-
Methods inherited from interface org.eclipse.collections.api.multimap.MutableMultimap
add, clear, put, putAll, putAll, putAllPairs, putAllPairs, remove
-
-
-
-
Method Detail
-
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:
withKeyValuein interfaceMutableMultimap<K,V>- Since:
- 11.1
-
withKeyMultiValues
default MutableBagIterableMultimap<K,V> withKeyMultiValues(K key, V... values)
Description copied from interface:MutableMultimapPuts the key / values combination into the MutableMultimap and returns the MutableMultimap (this).- Specified by:
withKeyMultiValuesin interfaceMutableMultimap<K,V>
-
replaceValues
MutableBagIterable<V> replaceValues(K key, Iterable<? extends V> values)
- Specified by:
replaceValuesin interfaceMutableMultimap<K,V>
-
removeAll
MutableBagIterable<V> removeAll(Object key)
- Specified by:
removeAllin interfaceMutableMultimap<K,V>
-
newEmpty
MutableBagIterableMultimap<K,V> newEmpty()
Description copied from interface:MultimapCreates a new instance of the same implementation type, using the default capacity and growth parameters.
-
get
MutableBagIterable<V> get(K key)
Description copied from interface:MultimapReturns a view of all values associated with the given key.If the given key does not exist, an empty
RichIterableis returned.
-
getIfAbsentPutAll
MutableBagIterable<V> getIfAbsentPutAll(K key, Iterable<? extends V> values)
Description copied from interface:MutableMultimapPuts 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 ofMultimap.get(Object)- Specified by:
getIfAbsentPutAllin interfaceMutableMultimap<K,V>
-
flip
MutableBagIterableMultimap<V,K> flip()
Description copied from interface:MultimapGiven a Multimap from Domain->Range return a multimap from Range->Domain.
-
selectKeysValues
MutableBagIterableMultimap<K,V> selectKeysValues(Predicate2<? super K,? super V> predicate)
Description copied from interface:MultimapReturns 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:
selectKeysValuesin interfaceBagMultimap<K,V>- Specified by:
selectKeysValuesin interfaceMultimap<K,V>- Specified by:
selectKeysValuesin interfaceMutableMultimap<K,V>- Parameters:
predicate- aPredicate2to 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:MultimapReturns 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:
rejectKeysValuesin interfaceBagMultimap<K,V>- Specified by:
rejectKeysValuesin interfaceMultimap<K,V>- Specified by:
rejectKeysValuesin interfaceMutableMultimap<K,V>- Parameters:
predicate- aPredicate2to use as the reject criteria- Returns:
Multimap, which contains elements that don't satisfy thepredicate
-
selectKeysMultiValues
MutableBagIterableMultimap<K,V> selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)
Description copied from interface:MultimapReturns 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:
selectKeysMultiValuesin interfaceBagMultimap<K,V>- Specified by:
selectKeysMultiValuesin interfaceMultimap<K,V>- Specified by:
selectKeysMultiValuesin interfaceMutableMultimap<K,V>- Parameters:
predicate- aPredicate2to 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:MultimapReturns 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:
rejectKeysMultiValuesin interfaceBagMultimap<K,V>- Specified by:
rejectKeysMultiValuesin interfaceMultimap<K,V>- Specified by:
rejectKeysMultiValuesin interfaceMutableMultimap<K,V>- Parameters:
predicate- aPredicate2to use as the reject criteria- Returns:
Multimap, which contains elements that don't satisfy thepredicate
-
collectKeysValues
<K2,V2> MutableBagIterableMultimap<K2,V2> collectKeysValues(Function2<? super K,? super V,Pair<K2,V2>> function)
Description copied from interface:MultimapReturns 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:
collectKeysValuesin interfaceMultimap<K,V>- Specified by:
collectKeysValuesin interfaceMutableMultimap<K,V>- Parameters:
function- aFunction2to 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:MultimapReturns 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:
collectKeyMultiValuesin interfaceMultimap<K,V>- Specified by:
collectKeyMultiValuesin interfaceMutableMultimap<K,V>- Parameters:
keyFunction-Functionto use transformation to get the keyvalueFunction-Functionto 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:MultimapReturns 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:
collectValuesin interfaceMultimap<K,V>- Specified by:
collectValuesin interfaceMutableMultimap<K,V>- Parameters:
function- aFunctionto use for transformation- Returns:
Multimap, which contains elements as a result of the transformation
-
asSynchronized
MutableBagIterableMultimap<K,V> asSynchronized()
Description copied from interface:MutableMultimapReturns 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:
asSynchronizedin interfaceMutableMultimap<K,V>- Returns:
- a synchronized view of this multimap.
- See Also:
MutableMapIterable.asSynchronized()
-
-