Package org.eclipse.collections.impl.multimap.bag

Class SynchronizedPutHashBagMultimap<K,V>

java.lang.Object

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

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

org.eclipse.collections.impl.multimap.AbstractSynchronizedPutMultimap<K,V,MutableBag<V>>

org.eclipse.collections.impl.multimap.bag.SynchronizedPutHashBagMultimap<K,V>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, BagMultimap<K,V>, MutableBagIterableMultimap<K,V>, MutableBagMultimap<K,V>, UnsortedBagMultimap<K,V>, Multimap<K,V>, MutableMultimap<K,V>

public final class SynchronizedPutHashBagMultimap<K,V>
extends AbstractSynchronizedPutMultimap<K,V,MutableBag<V>>
implements MutableBagMultimap<K,V>, java.io.Externalizable

A Multimap that is optimized for parallel writes, but is not protected for concurrent reads.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

Fields inherited from class org.eclipse.collections.impl.multimap.AbstractMutableMultimap

map, totalSize

Constructor Summary

Constructors

Constructor	Description
SynchronizedPutHashBagMultimap()
SynchronizedPutHashBagMultimap(int initialCapacity)
SynchronizedPutHashBagMultimap(java.lang.Iterable<Pair<K,V>> inputIterable)
SynchronizedPutHashBagMultimap(Multimap<? extends K,? extends V> multimap)
SynchronizedPutHashBagMultimap(Pair<K,V>... pairs)

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> HashBagMultimap<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> HashBagMultimap<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.
protected MutableBag<V>	createCollection()	Creates the collection of values for a single key.
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)
SynchronizedPutHashBagMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
static <K,V> SynchronizedPutHashBagMultimap<K,V>	newMultimap()
static <K,V> SynchronizedPutHashBagMultimap<K,V>	newMultimap(int initialCapacity, float loadFactor, int concurrencyLevel)
static <K,V> SynchronizedPutHashBagMultimap<K,V>	newMultimap(java.lang.Iterable<Pair<K,V>> inputIterable)
static <K,V> SynchronizedPutHashBagMultimap<K,V>	newMultimap(Multimap<? extends K,? extends V> multimap)
static <K,V> SynchronizedPutHashBagMultimap<K,V>	newMultimap(Pair<K,V>... pairs)
void	putOccurrences(K key, V value, int occurrences)
HashBagMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
HashBagMultimap<K,V>	rejectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
HashBagMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
HashBagMultimap<K,V>	selectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ImmutableBagMultimap<K,V>	toImmutable()	Returns an immutable copy of this Multimap if it is not already immutable.
MutableBagMultimap<K,V>	toMutable()	Returns a mutable copy of this Multimap.
SynchronizedPutHashBagMultimap<K,V>	withKeyMultiValues(K key, V... values)	Puts the key / values combination into the MutableMultimap and returns the MutableMultimap (this).

Methods inherited from class org.eclipse.collections.impl.multimap.AbstractSynchronizedPutMultimap

addToTotalSize, clearTotalSize, createMap, createMapWithKeyCount, decrementTotalSize, getIfAbsentPutAll, incrementTotalSize, put, size, subtractFromTotalSize

Methods inherited from class org.eclipse.collections.impl.multimap.AbstractMutableMultimap

clear, get, getMap, isEmpty, keySet, putAll, putAll, readExternal, remove, removeAll, replaceValues, sizeDistinct, toMap, toMap, writeExternal

Methods inherited from class org.eclipse.collections.impl.multimap.AbstractMultimap

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

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.bag.MutableBagMultimap

get, getIfAbsentPutAll, removeAll, replaceValues, withKeyValue

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

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SynchronizedPutHashBagMultimap

public SynchronizedPutHashBagMultimap()

SynchronizedPutHashBagMultimap

public SynchronizedPutHashBagMultimap(int initialCapacity)

SynchronizedPutHashBagMultimap

public SynchronizedPutHashBagMultimap(Multimap<? extends K,? extends V> multimap)

SynchronizedPutHashBagMultimap

public SynchronizedPutHashBagMultimap(Pair<K,V>... pairs)

SynchronizedPutHashBagMultimap

public SynchronizedPutHashBagMultimap(java.lang.Iterable<Pair<K,V>> inputIterable)

Method Detail

newMultimap

public static <K,V> SynchronizedPutHashBagMultimap<K,V> newMultimap()

newMultimap

public static <K,V> SynchronizedPutHashBagMultimap<K,V> newMultimap(int initialCapacity,
                                                                                float loadFactor,
                                                                                int concurrencyLevel)

newMultimap

public static <K,V> SynchronizedPutHashBagMultimap<K,V> newMultimap(Multimap<? extends K,? extends V> multimap)

newMultimap

public static <K,V> SynchronizedPutHashBagMultimap<K,V> newMultimap(Pair<K,V>... pairs)

newMultimap

public static <K,V> SynchronizedPutHashBagMultimap<K,V> newMultimap(java.lang.Iterable<Pair<K,V>> inputIterable)

withKeyMultiValues

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

Specified by:

withKeyMultiValues in interface MutableMultimap<K,V>

Overrides:

withKeyMultiValues in class AbstractSynchronizedPutMultimap<K,V,MutableBag<V>>

createCollection

protected MutableBag<V> createCollection()

Description copied from class: AbstractMultimap

Creates the collection of values for a single key.

Collections with weak, soft, or phantom references are not supported. Each call to createCollection should create a new instance.

The returned collection class determines whether duplicate key-value pairs are allowed.

Specified by:

createCollection in class AbstractMultimap<K,V,MutableBag<V>>

Returns:

an empty collection of values

forEachKeyMutableBag

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

Specified by:

forEachKeyMutableBag in interface MutableBagMultimap<K,V>

newEmpty

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

Specified by:

newEmpty in interface MutableMultimap<K,V>

Specified by:

newEmpty in interface UnsortedBagMultimap<K,V>

toMutable

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

toImmutable

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

selectKeysValues

public HashBagMultimap<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 MutableBagMultimap<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

public HashBagMultimap<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 MutableBagMultimap<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

public HashBagMultimap<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 MutableBagMultimap<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

public HashBagMultimap<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 MutableBagMultimap<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

public <K2,V2> HashBagMultimap<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 MutableBagMultimap<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

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

Specified by:

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

public <V2> HashBagMultimap<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 MutableBagMultimap<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

flip

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

Specified by:

flip in interface MutableMultimap<K,V>

putOccurrences

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

Specified by:

putOccurrences in interface MutableBagMultimap<K,V>

asSynchronized

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

Specified by:

asSynchronized in interface MutableMultimap<K,V>

Returns:

a synchronized view of this multimap.

See Also:

MutableMapIterable.asSynchronized()