Class AbstractMutableSetMultimap<K,V>

java.lang.Object

org.eclipse.collections.impl.multimap.AbstractMultimap<K, V, MutableSet<V>>

org.eclipse.collections.impl.multimap.AbstractMutableMultimap<K, V, MutableSet<V>>

org.eclipse.collections.impl.multimap.set.AbstractMutableSetMultimap<K,V>

All Implemented Interfaces:

Multimap<K,V>, MutableMultimap<K,V>, MutableSetIterableMultimap<K,V>, MutableSetMultimap<K,V>, SetMultimap<K,V>, UnsortedSetMultimap<K,V>

Direct Known Subclasses:

MultiReaderUnifiedSetMultimap, UnifiedSetMultimap, UnifiedSetWithHashingStrategyMultimap

public abstract class AbstractMutableSetMultimap<K,V>
extends AbstractMutableMultimap<K, V, MutableSet<V>>
implements MutableSetMultimap<K,V>

Field Summary

Fields inherited from class AbstractMutableMultimap

map, totalSize

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMutableSetMultimap()
protected	AbstractMutableSetMultimap(int size)
protected	AbstractMutableSetMultimap(Iterable<Pair<K,V>> inputIterable)
protected	AbstractMutableSetMultimap(Pair<K,V>... pairs)

Method Summary

Modifier and Type	Method	Description
MutableSetMultimap<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.
void	forEachKeyMutableSet(Procedure2<? super K, ? super MutableSet<V>> procedure)
ImmutableSetMultimap<K,V>	toImmutable()	Returns an immutable copy of this Multimap if it is not already immutable.
MutableSetMultimap<K,V>	toMutable()	Returns a mutable copy of this Multimap.

Methods inherited from class AbstractMutableMultimap

addToTotalSize, clear, clearTotalSize, createMap, createMapWithKeyCount, decrementTotalSize, get, getIfAbsentPutAll, getMap, incrementTotalSize, isEmpty, keySet, put, putAll, putAll, readExternal, remove, removeAll, replaceValues, size, sizeDistinct, subtractFromTotalSize, toMap, toMap, writeExternal

Methods inherited from class AbstractMultimap

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, createCollection, createCollectionBlock, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, toString, valuesView

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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 MutableMultimap

add, clear, flip, newEmpty, put, putAll, putAll, putAllPairs, putAllPairs, rejectKeysMultiValues, rejectKeysValues, remove, selectKeysMultiValues, selectKeysValues

Methods inherited from interface MutableSetMultimap

flip, get, getIfAbsentPutAll, newEmpty, rejectKeysMultiValues, rejectKeysValues, removeAll, replaceValues, selectKeysMultiValues, selectKeysValues, withKeyMultiValues, withKeyValue

Constructor Details

AbstractMutableSetMultimap

protected AbstractMutableSetMultimap()

AbstractMutableSetMultimap

protected AbstractMutableSetMultimap(Pair<K,V>... pairs)

AbstractMutableSetMultimap

protected AbstractMutableSetMultimap(Iterable<Pair<K,V>> inputIterable)

AbstractMutableSetMultimap

protected AbstractMutableSetMultimap(int size)

Method Details

toMutable

public MutableSetMultimap<K,V> toMutable()

Description copied from interface: Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface Multimap<K,V>

Specified by:

toMutable in interface UnsortedSetMultimap<K,V>

toImmutable

public ImmutableSetMultimap<K,V> toImmutable()

Description copied from interface: Multimap

Returns an immutable copy of this Multimap if it is not already immutable. If the Multimap is immutable, it will return itself.

The returned Multimap will be Serializable if this Multimap is Serializable.

Specified by:

toImmutable in interface Multimap<K,V>

Specified by:

toImmutable in interface UnsortedSetMultimap<K,V>

forEachKeyMutableSet

public void forEachKeyMutableSet(Procedure2<? super K, ? super MutableSet<V>> procedure)

Specified by:

forEachKeyMutableSet in interface MutableSetMultimap<K,V>

collectKeysValues

public <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 MutableMultimap<K,V>

Specified by:

collectKeysValues in interface MutableSetIterableMultimap<K,V>

Specified by:

collectKeysValues in interface MutableSetMultimap<K,V>

Specified by:

collectKeysValues in interface UnsortedSetMultimap<K,V>

Parameters:

function - a Function2 to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation

collectKeyMultiValues

public <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 MutableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface MutableSetIterableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface MutableSetMultimap<K,V>

Specified by:

collectKeyMultiValues in interface UnsortedSetMultimap<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

public <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 MutableMultimap<K,V>

Specified by:

collectValues in interface MutableSetIterableMultimap<K,V>

Specified by:

collectValues in interface MutableSetMultimap<K,V>

Specified by:

collectValues in interface UnsortedSetMultimap<K,V>

Parameters:

function - a Function to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation

asSynchronized

public MutableSetMultimap<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>

Specified by:

asSynchronized in interface MutableSetIterableMultimap<K,V>

Specified by:

asSynchronized in interface MutableSetMultimap<K,V>

Returns:

a synchronized view of this multimap.

See Also:

• MutableMapIterable.asSynchronized()