Package org.eclipse.collections.api.bimap

Interface ImmutableBiMap<K,V>

All Superinterfaces:

BiMap<K,V>, ImmutableMapIterable<K,V>, InternalIterable<V>, Iterable<V>, MapIterable<K,V>, RichIterable<V>

public interface ImmutableBiMap<K,V>
extends BiMap<K,V>, ImmutableMapIterable<K,V>

A BiMap whose contents cannot be altered after initialization.

Since:

4.2

Method Summary

Modifier and Type	Method	Description
default <K1, V1, V2> ImmutableMap<K1,V2>	aggregateBy(Function<? super K,? extends K1> keyFunction, Function<? super V,? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V1,? extends V2> nonMutatingAggregator)	Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions.
default <KK, VV> ImmutableMap<KK,VV>	aggregateBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
default <KK, VV> ImmutableMap<KK,VV>	aggregateInPlaceBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Procedure2<? super VV,? super V> mutatingAggregator)	Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
<V1> ImmutableBagIterable<V1>	collect(Function<? super V,? extends V1> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
<K2, V2> ImmutableBiMap<K2,V2>	collect(Function2<? super K,? super V,Pair<K2,V2>> function)	For each key and value of the map the function is evaluated.
<V1> ImmutableBagIterable<V1>	collectIf(Predicate<? super V> predicate, Function<? super V,? extends V1> function)	Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
<R> ImmutableBiMap<R,V>	collectKeysUnique(Function2<? super K,? super V,? extends R> function)	For each key and value of the map the function is evaluated.
<R> ImmutableBiMap<K,R>	collectValues(Function2<? super K,? super V,? extends R> function)	For each key and value of the map the function is evaluated.
<P, V1> ImmutableBagIterable<V1>	collectWith(Function2<? super V,? super P,? extends V1> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<V1> ImmutableBagIterable<V1>	flatCollect(Function<? super V,? extends Iterable<V1>> function)	flatCollect is a special case of RichIterable.collect(Function).
default <P, V1> ImmutableBagIterable<V1>	flatCollectWith(Function2<? super V,? super P,? extends Iterable<V1>> function, P parameter)	Same as flatCollect, only with a Function2 that is passed an extra parameter.
ImmutableSetMultimap<V,K>	flip()	Given a map from Domain -> Range return a multimap from Range -> Domain.
ImmutableBiMap<V,K>	flipUniqueValues()	Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
<V1> ImmutableSetMultimap<V1,V>	groupBy(Function<? super V,? extends V1> function)	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V1> ImmutableSetMultimap<V1,V>	groupByEach(Function<? super V,? extends Iterable<V1>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
default <VV> ImmutableBiMap<VV,V>	groupByUniqueKey(Function<? super V,? extends VV> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
ImmutableBiMap<V,K>	inverse()	Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.
ImmutableBiMap<K,V>	newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
ImmutableBiMap<K,V>	newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
ImmutableBiMap<K,V>	newWithKeyValue(K key, V value)
ImmutableBiMap<K,V>	newWithMap(Map<? extends K,? extends V> map)
ImmutableBiMap<K,V>	newWithMapIterable(MapIterable<? extends K,? extends V> mapIterable)
ImmutableBiMap<K,V>	newWithoutAllKeys(Iterable<? extends K> keys)
ImmutableBiMap<K,V>	newWithoutKey(K key)
PartitionImmutableSet<V>	partition(Predicate<? super V> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionImmutableSet<V>	partitionWith(Predicate2<? super V,? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
default <KK> ImmutableMapIterable<KK,V>	reduceBy(Function<? super V,? extends KK> groupBy, Function2<? super V,? super V,? extends V> reduceFunction)	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
ImmutableSet<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
ImmutableBiMap<K,V>	reject(Predicate2<? super K,? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
<P> ImmutableSet<V>	rejectWith(Predicate2<? super V,? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
ImmutableSet<V>	select(Predicate<? super V> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
ImmutableBiMap<K,V>	select(Predicate2<? super K,? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
<S> ImmutableSet<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> ImmutableSet<V>	selectWith(Predicate2<? super V,? super P> predicate, P parameter)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
ImmutableBiMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each value of the map and returns this.
<S> ImmutableSet<Pair<V,S>>	zip(Iterable<S> that)	Deprecated. in 8.0.
ImmutableSet<Pair<V,Integer>>	zipWithIndex()	Deprecated. in 8.0.

Methods inherited from interface org.eclipse.collections.api.bimap.BiMap

toImmutable

Methods inherited from interface org.eclipse.collections.api.map.ImmutableMapIterable

castToMap, countBy, countByEach, countByWith

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.eclipse.collections.api.map.MapIterable

containsKey, containsValue, detect, detectOptional, equals, forEach, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getOrDefault, hashCode, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView

Methods inherited from interface org.eclipse.collections.api.RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Method Details

newWithKeyValue

ImmutableBiMap<K,V> newWithKeyValue(K key,
 V value)

Specified by:

newWithKeyValue in interface ImmutableMapIterable<K,V>

newWithAllKeyValues

ImmutableBiMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)

Specified by:

newWithAllKeyValues in interface ImmutableMapIterable<K,V>

newWithMap

ImmutableBiMap<K,V> newWithMap(Map<? extends K,? extends V> map)

Specified by:

newWithMap in interface ImmutableMapIterable<K,V>

newWithMapIterable

ImmutableBiMap<K,V> newWithMapIterable(MapIterable<? extends K,? extends V> mapIterable)

Specified by:

newWithMapIterable in interface ImmutableMapIterable<K,V>

newWithAllKeyValueArguments

ImmutableBiMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)

Specified by:

newWithAllKeyValueArguments in interface ImmutableMapIterable<K,V>

newWithoutKey

ImmutableBiMap<K,V> newWithoutKey(K key)

Specified by:

newWithoutKey in interface ImmutableMapIterable<K,V>

newWithoutAllKeys

ImmutableBiMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)

Specified by:

newWithoutAllKeys in interface ImmutableMapIterable<K,V>

inverse

ImmutableBiMap<V,K> inverse()

Description copied from interface: BiMap

Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.

Specified by:

inverse in interface BiMap<K,V>

flip

ImmutableSetMultimap<V,K> flip()

Description copied from interface: MapIterable

Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.

Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However, since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus, we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.

Specified by:

flip in interface BiMap<K,V>

Specified by:

flip in interface ImmutableMapIterable<K,V>

Specified by:

flip in interface MapIterable<K,V>

flipUniqueValues

ImmutableBiMap<V,K> flipUniqueValues()

Description copied from interface: MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

     MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable<String, Integer> result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 

Specified by:

flipUniqueValues in interface BiMap<K,V>

Specified by:

flipUniqueValues in interface ImmutableMapIterable<K,V>

Specified by:

flipUniqueValues in interface MapIterable<K,V>

tap

ImmutableBiMap<K,V> tap(Procedure<? super V> procedure)

Description copied from interface: MapIterable

Executes the Procedure for each value of the map and returns this.

 return peopleByCity.tap(person -> LOGGER.info(person.getName()));
 

Specified by:

tap in interface BiMap<K,V>

Specified by:

tap in interface ImmutableMapIterable<K,V>

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface RichIterable<K>

See Also:

• RichIterable.forEach(Procedure)

select

ImmutableBiMap<K,V> select(Predicate2<? super K,? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.

 MapIterable<City, Person> selected =
     peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
 

Specified by:

select in interface BiMap<K,V>

Specified by:

select in interface ImmutableMapIterable<K,V>

Specified by:

select in interface MapIterable<K,V>

reject

ImmutableBiMap<K,V> reject(Predicate2<? super K,? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.

 MapIterable<City, Person> rejected =
     peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
 

Specified by:

reject in interface BiMap<K,V>

Specified by:

reject in interface ImmutableMapIterable<K,V>

Specified by:

reject in interface MapIterable<K,V>

collect

<K2,
V2> ImmutableBiMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)

Description copied from interface: BiMap

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

 MapIterable<String, String> collected =
     peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
 

Implementations are expected to delegate to MutableBiMap.put(Object, Object), newWithKeyValue(Object, Object), or equivalent, not MutableBiMap.forcePut(Object, Object).

Specified by:

collect in interface BiMap<K,V>

Specified by:

collect in interface ImmutableMapIterable<K,V>

Specified by:

collect in interface MapIterable<K,V>

collectValues

<R> ImmutableBiMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)

Description copied from interface: BiMap

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

 MapIterable<City, String> collected =
     peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
 

Implementations are expected to delegate to MutableBiMap.put(Object, Object), newWithKeyValue(Object, Object), or equivalent, not MutableBiMap.forcePut(Object, Object).

Specified by:

collectValues in interface BiMap<K,V>

Specified by:

collectValues in interface ImmutableMapIterable<K,V>

Specified by:

collectValues in interface MapIterable<K,V>

collectKeysUnique

<R> ImmutableBiMap<R,V> collectKeysUnique(Function2<? super K,? super V,? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the keys projected from the function rather than the original keys.

Specified by:

collectKeysUnique in interface BiMap<K,V>

Specified by:

collectKeysUnique in interface ImmutableMapIterable<K,V>

Specified by:

collectKeysUnique in interface MapIterable<K,V>

select

ImmutableSet<V> select(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
 

Specified by:

select in interface BiMap<K,V>

Specified by:

select in interface ImmutableMapIterable<K,V>

Specified by:

select in interface RichIterable<K>

selectWith

<P> ImmutableSet<V> selectWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
 

Specified by:

selectWith in interface BiMap<K,V>

Specified by:

selectWith in interface ImmutableMapIterable<K,V>

Specified by:

selectWith in interface RichIterable<K>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

reject

ImmutableSet<V> reject(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));
 

Specified by:

reject in interface BiMap<K,V>

Specified by:

reject in interface ImmutableMapIterable<K,V>

Specified by:

reject in interface RichIterable<K>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

<P> ImmutableSet<V> rejectWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 

Specified by:

rejectWith in interface BiMap<K,V>

Specified by:

rejectWith in interface ImmutableMapIterable<K,V>

Specified by:

rejectWith in interface RichIterable<K>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

partition

PartitionImmutableSet<V> partition(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 

Specified by:

partition in interface BiMap<K,V>

Specified by:

partition in interface ImmutableMapIterable<K,V>

Specified by:

partition in interface RichIterable<K>

partitionWith

<P> PartitionImmutableSet<V> partitionWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 

Specified by:

partitionWith in interface BiMap<K,V>

Specified by:

partitionWith in interface RichIterable<K>

selectInstancesOf

<S> ImmutableSet<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

 RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 

Specified by:

selectInstancesOf in interface BiMap<K,V>

Specified by:

selectInstancesOf in interface ImmutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface RichIterable<K>

collect

<V1> ImmutableBagIterable<V1> collect(Function<? super V,? extends V1> function)

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 RichIterable<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName());
 

Specified by:

collect in interface RichIterable<K>

collectWith

<P,
V1> ImmutableBagIterable<V1> collectWith(Function2<? super V,? super P,? extends V1> function,
 P parameter)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 

Specified by:

collectWith in interface RichIterable<K>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

• RichIterable.collect(Function)

collectIf

<V1> ImmutableBagIterable<V1> collectIf(Predicate<? super V> predicate,
 Function<? super V,? extends V1> function)

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

Example using a Java 8 lambda and method reference:

 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
 

Example using Predicates factory:

 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
 

Specified by:

collectIf in interface RichIterable<K>

flatCollect

<V1> ImmutableBagIterable<V1> flatCollect(Function<? super V,? extends Iterable<V1>> function)

Description copied from interface: RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 RichIterable<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 RichIterable<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface RichIterable<K>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollectWith

default <P,
V1> ImmutableBagIterable<V1> flatCollectWith(Function2<? super V,? super P,? extends Iterable<V1>> function,
 P parameter)

Description copied from interface: RichIterable

Same as flatCollect, only with a Function2 that is passed an extra parameter.

Specified by:

flatCollectWith in interface RichIterable<K>

Since:

9.2

groupBy

<V1> ImmutableSetMultimap<V1,V> groupBy(Function<? super V,? extends V1> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

Example using a Java 8 method reference:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
 

Specified by:

groupBy in interface BiMap<K,V>

Specified by:

groupBy in interface ImmutableMapIterable<K,V>

Specified by:

groupBy in interface RichIterable<K>

groupByEach

<V1> ImmutableSetMultimap<V1,V> groupByEach(Function<? super V,? extends Iterable<V1>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface BiMap<K,V>

Specified by:

groupByEach in interface ImmutableMapIterable<K,V>

Specified by:

groupByEach in interface RichIterable<K>

groupByUniqueKey

default <VV> ImmutableBiMap<VV,V> groupByUniqueKey(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface BiMap<K,V>

Specified by:

groupByUniqueKey in interface ImmutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

• RichIterable.groupBy(Function)

aggregateInPlaceBy

default <KK,
VV> ImmutableMap<KK,VV> aggregateInPlaceBy(Function<? super V,? extends KK> groupBy,
 Function0<? extends VV> zeroValueFactory,
 Procedure2<? super VV,? super V> mutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

aggregateInPlaceBy in interface ImmutableMapIterable<K,V>

Specified by:

aggregateInPlaceBy in interface RichIterable<K>

Since:

11.0

aggregateBy

default <KK,
VV> ImmutableMap<KK,VV> aggregateBy(Function<? super V,? extends KK> groupBy,
 Function0<? extends VV> zeroValueFactory,
 Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).

Specified by:

aggregateBy in interface ImmutableMapIterable<K,V>

Specified by:

aggregateBy in interface RichIterable<K>

Since:

11.0

aggregateBy

default <K1,
V1,
V2> ImmutableMap<K1,V2> aggregateBy(Function<? super K,? extends K1> keyFunction,
 Function<? super V,? extends V1> valueFunction,
 Function0<? extends V2> zeroValueFactory,
 Function2<? super V2,? super V1,? extends V2> nonMutatingAggregator)

Description copied from interface: MapIterable

Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with.

 MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9));

 MapIterable<String, Long> result = map.aggregateBy(
         eachKey -> {
             return eachKey.equals("oneToFive")  ? "lessThanSix" : "greaterOrEqualsToSix";
         },
         each -> each.sumOfInt(Integer::intValue),
         () -> 0L,
         (argument1, argument2) -> argument1 + argument2);

 MapIterable<String, Long> expected =
         Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue),
                 "greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue));
 Assert.assertEquals(expected, result);
 

Specified by:

aggregateBy in interface ImmutableMapIterable<K,V>

Specified by:

aggregateBy in interface MapIterable<K,V>

Since:

11.0

reduceBy

default <KK> ImmutableMapIterable<KK,V> reduceBy(Function<? super V,? extends KK> groupBy,
 Function2<? super V,? super V,? extends V> reduceFunction)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map.

Specified by:

reduceBy in interface ImmutableMapIterable<K,V>

Specified by:

reduceBy in interface RichIterable<K>

zip

@Deprecated
<S> ImmutableSet<Pair<V,S>> zip(Iterable<S> that)

Deprecated.

in 8.0. Use OrderedIterable.zip(Iterable) instead.

Description copied from interface: RichIterable

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface BiMap<K,V>

Specified by:

zip in interface ImmutableMapIterable<K,V>

Specified by:

zip in interface RichIterable<K>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

@Deprecated
ImmutableSet<Pair<V,Integer>> zipWithIndex()

Deprecated.

in 8.0. Use OrderedIterable.zipWithIndex() instead.

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface BiMap<K,V>

Specified by:

zipWithIndex in interface ImmutableMapIterable<K,V>

Specified by:

zipWithIndex in interface RichIterable<K>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

• RichIterable.zip(Iterable)