Package org.eclipse.collections.impl.multimap.list

Class ImmutableListMultimapImpl<K,V>

java.lang.Object

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

org.eclipse.collections.impl.multimap.AbstractImmutableMultimap<K,V,ImmutableList<V>>

org.eclipse.collections.impl.multimap.list.ImmutableListMultimapImpl<K,V>

All Implemented Interfaces:

java.io.Serializable, ImmutableMultimap<K,V>, ImmutableListMultimap<K,V>, ListMultimap<K,V>, Multimap<K,V>, OrderedIterableMultimap<K,V>, ReversibleIterableMultimap<K,V>

public final class ImmutableListMultimapImpl<K,V>
extends AbstractImmutableMultimap<K,V,ImmutableList<V>>
implements ImmutableListMultimap<K,V>, java.io.Serializable

The default ImmutableListMultimap implementation.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableListMultimapImpl.ImmutableListMultimapSerializationProxy<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

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

map

Constructor Summary

Constructors

Constructor	Description
ImmutableListMultimapImpl(ImmutableMap<K,ImmutableList<V>> map)
ImmutableListMultimapImpl(MutableMap<K,ImmutableList<V>> map)

Method Summary

Modifier and Type	Method	Description
<K2,V2> ImmutableBagMultimap<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> ImmutableBagMultimap<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> ImmutableListMultimap<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 ImmutableList<V>	createCollection()	Creates the collection of values for a single key.
ImmutableBagMultimap<V,K>	flip()	Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
void	forEachKeyImmutableList(Procedure2<? super K,? super ImmutableList<V>> procedure)
ImmutableListMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
ImmutableListMultimap<K,V>	newWith(K key, V value)
ImmutableListMultimap<K,V>	newWithAll(K key, java.lang.Iterable<? extends V> values)
ImmutableListMultimap<K,V>	newWithout(java.lang.Object key, java.lang.Object value)
ImmutableListMultimap<K,V>	newWithoutAll(java.lang.Object key)
ImmutableListMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ImmutableListMultimap<K,V>	rejectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ImmutableListMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ImmutableListMultimap<K,V>	selectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ImmutableListMultimap<K,V>	toImmutable()	Returns an immutable copy of this Multimap if it is not already immutable.
MutableListMultimap<K,V>	toMutable()	Returns a mutable copy of this Multimap.
private java.lang.Object	writeReplace()

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

get, getMap, isEmpty, keySet, readResolve, size, sizeDistinct, toMap, toMap

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 org.eclipse.collections.api.multimap.list.ImmutableListMultimap

get

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ImmutableListMultimapImpl

public ImmutableListMultimapImpl(MutableMap<K,ImmutableList<V>> map)

ImmutableListMultimapImpl

public ImmutableListMultimapImpl(ImmutableMap<K,ImmutableList<V>> map)

Method Detail

createCollection

protected ImmutableList<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,ImmutableList<V>>

Returns:

an empty collection of values

forEachKeyImmutableList

public void forEachKeyImmutableList(Procedure2<? super K,? super ImmutableList<V>> procedure)

Specified by:

forEachKeyImmutableList in interface ImmutableListMultimap<K,V>

newEmpty

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

Specified by:

newEmpty in interface ImmutableMultimap<K,V>

Specified by:

newEmpty in interface ListMultimap<K,V>

Specified by:

newEmpty in interface Multimap<K,V>

Specified by:

newEmpty in interface OrderedIterableMultimap<K,V>

Specified by:

newEmpty in interface ReversibleIterableMultimap<K,V>

toMutable

public MutableListMultimap<K,V> toMutable()

Description copied from interface: Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface ListMultimap<K,V>

Specified by:

toMutable in interface Multimap<K,V>

toImmutable

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

Specified by:

toImmutable in interface Multimap<K,V>

Overrides:

toImmutable in class AbstractImmutableMultimap<K,V,ImmutableList<V>>

writeReplace

private java.lang.Object writeReplace()

newWith

public ImmutableListMultimap<K,V> newWith(K key,
                                                V value)

Specified by:

newWith in interface ImmutableListMultimap<K,V>

Specified by:

newWith in interface ImmutableMultimap<K,V>

newWithout

public ImmutableListMultimap<K,V> newWithout(java.lang.Object key,
                                                   java.lang.Object value)

Specified by:

newWithout in interface ImmutableListMultimap<K,V>

Specified by:

newWithout in interface ImmutableMultimap<K,V>

newWithAll

public ImmutableListMultimap<K,V> newWithAll(K key,
                                                   java.lang.Iterable<? extends V> values)

Specified by:

newWithAll in interface ImmutableListMultimap<K,V>

Specified by:

newWithAll in interface ImmutableMultimap<K,V>

newWithoutAll

public ImmutableListMultimap<K,V> newWithoutAll(java.lang.Object key)

Specified by:

newWithoutAll in interface ImmutableListMultimap<K,V>

Specified by:

newWithoutAll in interface ImmutableMultimap<K,V>

flip

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

Specified by:

flip in interface ImmutableMultimap<K,V>

Specified by:

flip in interface ListMultimap<K,V>

Specified by:

flip in interface Multimap<K,V>

selectKeysValues

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

Specified by:

selectKeysValues in interface ImmutableMultimap<K,V>

Specified by:

selectKeysValues in interface ListMultimap<K,V>

Specified by:

selectKeysValues in interface Multimap<K,V>

Specified by:

selectKeysValues in interface OrderedIterableMultimap<K,V>

Specified by:

selectKeysValues in interface ReversibleIterableMultimap<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 ImmutableListMultimap<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 ImmutableListMultimap<K,V>

Specified by:

rejectKeysValues in interface ImmutableMultimap<K,V>

Specified by:

rejectKeysValues in interface ListMultimap<K,V>

Specified by:

rejectKeysValues in interface Multimap<K,V>

Specified by:

rejectKeysValues in interface OrderedIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface ReversibleIterableMultimap<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 ImmutableListMultimap<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 ImmutableListMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ImmutableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ListMultimap<K,V>

Specified by:

selectKeysMultiValues in interface Multimap<K,V>

Specified by:

selectKeysMultiValues in interface OrderedIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ReversibleIterableMultimap<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 ImmutableListMultimap<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 ImmutableListMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ImmutableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ListMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface Multimap<K,V>

Specified by:

rejectKeysMultiValues in interface OrderedIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ReversibleIterableMultimap<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> ImmutableBagMultimap<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 ImmutableListMultimap<K,V>

Specified by:

collectKeysValues in interface ImmutableMultimap<K,V>

Specified by:

collectKeysValues in interface ListMultimap<K,V>

Specified by:

collectKeysValues in interface Multimap<K,V>

Specified by:

collectKeysValues in interface OrderedIterableMultimap<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> ImmutableBagMultimap<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 ImmutableListMultimap<K,V>

Specified by:

collectKeyMultiValues in interface ImmutableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface ListMultimap<K,V>

Specified by:

collectKeyMultiValues in interface Multimap<K,V>

Specified by:

collectKeyMultiValues in interface OrderedIterableMultimap<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> ImmutableListMultimap<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 ImmutableListMultimap<K,V>

Specified by:

collectValues in interface ImmutableMultimap<K,V>

Specified by:

collectValues in interface ListMultimap<K,V>

Specified by:

collectValues in interface Multimap<K,V>

Specified by:

collectValues in interface OrderedIterableMultimap<K,V>

Specified by:

collectValues in interface ReversibleIterableMultimap<K,V>

Parameters:

function - a Function to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation