Package org.eclipse.collections.api.multimap.set

Interface ImmutableSetMultimap<K,V>

All Superinterfaces:

ImmutableMultimap<K,V>, ImmutableSetIterableMultimap<K,V>, Multimap<K,V>, SetMultimap<K,V>, UnsortedSetMultimap<K,V>

All Known Implementing Classes:

ImmutableSetMultimapImpl

public interface ImmutableSetMultimap<K,V>
extends UnsortedSetMultimap<K,V>, ImmutableSetIterableMultimap<K,V>

Since:

1.0

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> ImmutableBagMultimap<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.
ImmutableSetMultimap<V,K>	flip()	Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
void	forEachKeyImmutableSet(Procedure2<? super K,? super ImmutableSet<V>> procedure)
ImmutableSet<V>	get(K key)	Returns a view of all values associated with the given key.
ImmutableSetMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
ImmutableSetMultimap<K,V>	newWith(K key, V value)
ImmutableSetMultimap<K,V>	newWithAll(K key, Iterable<? extends V> values)
ImmutableSetMultimap<K,V>	newWithout(Object key, Object value)
ImmutableSetMultimap<K,V>	newWithoutAll(Object key)
ImmutableSetMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ImmutableSetMultimap<K,V>	rejectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ImmutableSetMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K,? super RichIterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ImmutableSetMultimap<K,V>	selectKeysValues(Predicate2<? super K,? super V> predicate)	Returns all elements of the source multimap that satisfies the predicate.

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.set.UnsortedSetMultimap

toImmutable, toMutable

Method Details

forEachKeyImmutableSet

void forEachKeyImmutableSet(Procedure2<? super K,? super ImmutableSet<V>> procedure)

Since:

11.0

get

ImmutableSet<V> get(K key)

Description copied from interface: Multimap

Returns a view of all values associated with the given key.

If the given key does not exist, an empty RichIterable is returned.

Specified by:

get in interface ImmutableMultimap<K,V>

Specified by:

get in interface ImmutableSetIterableMultimap<K,V>

Specified by:

get in interface Multimap<K,V>

Specified by:

get in interface SetMultimap<K,V>

Specified by:

get in interface UnsortedSetMultimap<K,V>

Parameters:

key - the key to search for

newEmpty

ImmutableSetMultimap<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 ImmutableMultimap<K,V>

Specified by:

newEmpty in interface ImmutableSetIterableMultimap<K,V>

Specified by:

newEmpty in interface Multimap<K,V>

Specified by:

newEmpty in interface SetMultimap<K,V>

Specified by:

newEmpty in interface UnsortedSetMultimap<K,V>

newWith

ImmutableSetMultimap<K,V> newWith(K key,
 V value)

Specified by:

newWith in interface ImmutableMultimap<K,V>

Specified by:

newWith in interface ImmutableSetIterableMultimap<K,V>

newWithout

ImmutableSetMultimap<K,V> newWithout(Object key,
 Object value)

Specified by:

newWithout in interface ImmutableMultimap<K,V>

Specified by:

newWithout in interface ImmutableSetIterableMultimap<K,V>

newWithAll

ImmutableSetMultimap<K,V> newWithAll(K key,
 Iterable<? extends V> values)

Specified by:

newWithAll in interface ImmutableMultimap<K,V>

Specified by:

newWithAll in interface ImmutableSetIterableMultimap<K,V>

newWithoutAll

ImmutableSetMultimap<K,V> newWithoutAll(Object key)

Specified by:

newWithoutAll in interface ImmutableMultimap<K,V>

Specified by:

newWithoutAll in interface ImmutableSetIterableMultimap<K,V>

flip

ImmutableSetMultimap<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 ImmutableMultimap<K,V>

Specified by:

flip in interface ImmutableSetIterableMultimap<K,V>

Specified by:

flip in interface Multimap<K,V>

Specified by:

flip in interface SetMultimap<K,V>

selectKeysValues

ImmutableSetMultimap<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 ImmutableMultimap<K,V>

Specified by:

selectKeysValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

selectKeysValues in interface Multimap<K,V>

Specified by:

selectKeysValues in interface SetMultimap<K,V>

Specified by:

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

ImmutableSetMultimap<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 ImmutableMultimap<K,V>

Specified by:

rejectKeysValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface Multimap<K,V>

Specified by:

rejectKeysValues in interface SetMultimap<K,V>

Specified by:

rejectKeysValues in interface UnsortedSetMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

selectKeysMultiValues

ImmutableSetMultimap<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 ImmutableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface Multimap<K,V>

Specified by:

selectKeysMultiValues in interface SetMultimap<K,V>

Specified by:

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

ImmutableSetMultimap<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 ImmutableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface Multimap<K,V>

Specified by:

rejectKeysMultiValues in interface SetMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface UnsortedSetMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

collectKeysValues

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

Specified by:

collectKeysValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

collectKeysValues in interface Multimap<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

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

Specified by:

collectKeyMultiValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

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

<V2> ImmutableBagMultimap<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 ImmutableMultimap<K,V>

Specified by:

collectValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

collectValues in interface Multimap<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