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

Class HashBagMultimap<K,V>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

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

public final class HashBagMultimap<K,V>
extends AbstractMutableBagMultimap<K,V>
implements Externalizable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HashBagMultimap()
HashBagMultimap(Iterable<Pair<K,V>> inputIterable)
HashBagMultimap(Multimap<? extends K,? extends V> multimap)
HashBagMultimap(Pair<K,V>... pairs)

Method Summary

Modifier and Type	Method	Description
<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.
MutableBagMultimap<V,K>	flip()	Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
HashBagMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
static <K, V> HashBagMultimap<K,V>	newMultimap()
static <K, V> HashBagMultimap<K,V>	newMultimap(Iterable<Pair<K,V>> inputIterable)
static <K, V> HashBagMultimap<K,V>	newMultimap(Multimap<? extends K,? extends V> multimap)
static <K, V> HashBagMultimap<K,V>	newMultimap(Pair<K,V>... pairs)
HashBagMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K,? super Iterable<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 Iterable<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.

Methods inherited from class org.eclipse.collections.impl.multimap.bag.AbstractMutableBagMultimap

asSynchronized, collectKeyMultiValues, collectKeysValues, putOccurrences, readExternal, toImmutable, toMutable, writeExternal

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

clear, get, getIfAbsentPutAll, isEmpty, keySet, put, putAll, putAll, remove, removeAll, replaceValues, size, sizeDistinct, toMap, toMap

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

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, 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

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

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

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

Constructor Details

HashBagMultimap

public HashBagMultimap()

HashBagMultimap

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

HashBagMultimap

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

HashBagMultimap

public HashBagMultimap(Iterable<Pair<K,V>> inputIterable)

Method Details

newMultimap

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

newMultimap

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

newMultimap

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

newMultimap

public static <K, V> HashBagMultimap<K,V> newMultimap(Iterable<Pair<K,V>> inputIterable)

newEmpty

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

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>

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

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 Iterable<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 Iterable<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