Class RemoteCollectors
- java.lang.Object
-
- com.tangosol.util.stream.RemoteCollectors
-
public abstract class RemoteCollectors extends Object
Static factory for variousRemoteCollector
s that can be executed in parallel in a distributed environment.- Since:
- 12.2.1
- Author:
- as 2014.10.01
- See Also:
RemoteCollector
,Collectors
-
-
Constructor Summary
Constructors Constructor Description RemoteCollectors()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <T,U>
RemoteCollector<T,?,Double>averagingDouble(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the arithmetic mean of a double-valued function applied to the input elements.static <T,U>
RemoteCollector<T,?,Double>averagingInt(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the arithmetic mean of an integer-valued function applied to the input elements.static <T,U>
RemoteCollector<T,?,Double>averagingLong(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the arithmetic mean of a long-valued function applied to the input elements.static <T,A,R,RR>
RemoteCollector<T,A,RR>collectingAndThen(RemoteCollector<T,A,R> downstream, Remote.Function<R,RR> finisher)
Adapts aCollector
to perform an additional finishing transformation.static <T> RemoteCollector<T,?,Long>
counting()
Returns aCollector
accepting elements of typeT
that counts the number of input elements.static <T,U,K>
RemoteCollector<T,?,Map<K,List<T>>>groupingBy(ValueExtractor<? super U,? extends K> classifier)
Returns aCollector
implementing a "group by" operation on input elements of typeT
, grouping elements according to a classification function, and returning the results in aMap
.static <T,U,K,D,A,M extends Map<K,D>>
RemoteCollector<T,?,M>groupingBy(ValueExtractor<? super U,? extends K> extractor, Remote.Supplier<M> mapFactory, RemoteCollector<? super T,A,D> downstream)
Returns aCollector
implementing a cascaded "group by" operation on input elements of typeT
, grouping elements according to a classification function, and then performing a reduction operation on the values associated with a given key using the specified downstreamCollector
.static <T,U,K,A,D>
RemoteCollector<T,?,Map<K,D>>groupingBy(ValueExtractor<? super U,? extends K> classifier, RemoteCollector<? super T,A,D> downstream)
Returns aCollector
implementing a cascaded "group by" operation on input elements of typeT
, grouping elements according to a classification function, and then performing a reduction operation on the values associated with a given key using the specified downstreamCollector
.static <T,U,A,R>
RemoteCollector<T,A,R>mapping(Remote.Function<? super T,? extends U> mapper, RemoteCollector<? super U,A,R> downstream)
Adapts aCollector
accepting elements of typeU
to one accepting elements of typeT
by applying a mapping function to each input element before accumulation.static <T> RemoteCollector<T,?,Optional<T>>
maxBy(Remote.Comparator<? super T> comparator)
Returns aCollector
that produces the maximal element according to a givenComparator
, described as anOptional<T>
.static <T,E extends Comparable<? super E>>
RemoteCollector<T,?,Optional<T>>maxBy(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that produces the maximal element according to a givenComparable
attribute, described as anOptional<T>
.static <T> RemoteCollector<T,?,Optional<T>>
minBy(Remote.Comparator<? super T> comparator)
Returns aCollector
that produces the minimal element according to a givenComparator
, described as anOptional<T>
.static <T,E extends Comparable<? super E>>
RemoteCollector<T,?,Optional<T>>minBy(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that produces the minimal element according to a givenComparable
attribute, described as anOptional<T>
.static <T> RemoteCollector<T,?,Optional<T>>
reducing(Remote.BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
.static <T> RemoteCollector<T,SimpleHolder<T>,T>
reducing(T identity, Remote.BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
using the provided identity.static <T,U>
RemoteCollector<T,?,U>reducing(U identity, Remote.BiFunction<? super U,? super T,? extends U> mapper, Remote.BinaryOperator<U> op)
Returns aCollector
which performs a reduction of its input elements under a specified mapping function andBinaryOperator
.static <T,U>
RemoteCollector<T,?,U>reducing(U identity, Remote.Function<? super T,? extends U> mapper, Remote.BinaryOperator<U> op)
Returns aCollector
which performs a reduction of its input elements under a specified mapping function andBinaryOperator
.static <T,U>
RemoteCollector<T,?,com.tangosol.internal.util.DoubleSummaryStatistics>summarizingDouble(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
which applies andouble
-producing mapping function to each input element, and returns summary statistics for the resulting values.static <T,U>
RemoteCollector<T,?,com.tangosol.internal.util.IntSummaryStatistics>summarizingInt(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
which applies anint
-producing mapping function to each input element, and returns summary statistics for the resulting values.static <T,U>
RemoteCollector<T,?,com.tangosol.internal.util.LongSummaryStatistics>summarizingLong(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
which applies anlong
-producing mapping function to each input element, and returns summary statistics for the resulting values.static <T,U>
RemoteCollector<T,?,Double>summingDouble(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the sum of a double-valued function applied to the input elements.static <T,U>
RemoteCollector<T,?,Integer>summingInt(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the sum of a integer-valued function applied to the input elements.static <T,U>
RemoteCollector<T,?,Long>summingLong(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the sum of a long-valued function applied to the input elements.static <T,C extends Collection<T>>
RemoteCollector<T,?,C>toCollection(Remote.Supplier<C> supplier)
Returns aCollector
that accumulates the input elements into a newCollection
, in encounter order.static <T> RemoteCollector<T,?,List<T>>
toList()
Returns aCollector
that accumulates the input elements into a newList
.static <T,U1,U2,K,V>
RemoteCollector<T,?,Map<K,V>>toMap(ValueExtractor<? super U1,? extends K> keyMapper, ValueExtractor<? super U2,? extends V> valueMapper)
Returns aCollector
that accumulates elements into aMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T,U1,U2,K,V>
RemoteCollector<T,?,Map<K,V>>toMap(ValueExtractor<? super U1,? extends K> keyMapper, ValueExtractor<? super U2,? extends V> valueMapper, Remote.BinaryOperator<V> mergeFunction)
Returns aCollector
that accumulates elements into aMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T,U1,U2,K,V,M extends Map<K,V>>
RemoteCollector<T,?,M>toMap(ValueExtractor<? super U1,? extends K> keyExtractor, ValueExtractor<? super U2,? extends V> valueExtractor, Remote.BinaryOperator<V> mergeFunction, Remote.Supplier<M> mapSupplier)
Returns aCollector
that accumulates elements into aMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T> RemoteCollector<T,?,Set<T>>
toSet()
Returns aCollector
that accumulates the input elements into a newSet
.static <T> RemoteCollector<T,?,Collection<T>>
toSortedBag()
Returns aCollector
that accumulates the input elements into a newSortedBag
.static <T> RemoteCollector<T,?,Collection<T>>
toSortedBag(Remote.Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedBag
.static <T,E extends Comparable<? super E>>
RemoteCollector<T,?,Collection<T>>toSortedBag(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that accumulates the input elements into a newSortedBag
.static <T> RemoteCollector<T,?,Collection<T>>
toSortedBag(Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedBag
.static <T> RemoteCollector<T,?,SortedSet<T>>
toSortedSet()
Returns aCollector
that accumulates the input elements into a newSortedSet
.static <T> RemoteCollector<T,?,SortedSet<T>>
toSortedSet(Remote.Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedSet
.static <T,E extends Comparable<? super E>>
RemoteCollector<T,?,SortedSet<T>>toSortedSet(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that accumulates the input elements into a newSortedSet
.static <T> RemoteCollector<T,?,SortedSet<T>>
toSortedSet(Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedSet
.
-
-
-
Method Detail
-
toCollection
public static <T,C extends Collection<T>> RemoteCollector<T,?,C> toCollection(Remote.Supplier<C> supplier)
Returns aCollector
that accumulates the input elements into a newCollection
, in encounter order. TheCollection
is created by the provided factory.- Type Parameters:
T
- the type of the input elementsC
- the type of the resultingCollection
- Parameters:
supplier
- aSupplier
which returns a new, emptyCollection
of the appropriate type- Returns:
- a
Collector
which collects all the input elements into aCollection
, in encounter order
-
toList
public static <T> RemoteCollector<T,?,List<T>> toList()
Returns aCollector
that accumulates the input elements into a newList
. There are no guarantees on the type, mutability, serializability, or thread-safety of theList
returned; if more control over the returnedList
is required, usetoCollection(Remote.Supplier)
.- Type Parameters:
T
- the type of the input elements- Returns:
- a
Collector
which collects all the input elements into aList
, in encounter order
-
toSortedBag
public static <T> RemoteCollector<T,?,Collection<T>> toSortedBag()
Returns aCollector
that accumulates the input elements into a newSortedBag
.- Type Parameters:
T
- the type of the input elements- Returns:
- a
Collector
which collects all the input elements into aList
, in encounter order
-
toSortedBag
public static <T,E extends Comparable<? super E>> RemoteCollector<T,?,Collection<T>> toSortedBag(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that accumulates the input elements into a newSortedBag
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparable
- aValueExtractor
that returns aComparable
value- Returns:
- a
Collector
which collects all the input elements into aList
, in encounter order
-
toSortedBag
public static <T> RemoteCollector<T,?,Collection<T>> toSortedBag(Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedBag
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparator
- a comparator for type T- Returns:
- a
Collector
which collects all the input elements into aList
, in encounter order
-
toSortedBag
public static <T> RemoteCollector<T,?,Collection<T>> toSortedBag(Remote.Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedBag
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparator
- a comparator for type T- Returns:
- a
Collector
which collects all the input elements into aList
, in encounter order
-
toSet
public static <T> RemoteCollector<T,?,Set<T>> toSet()
Returns aCollector
that accumulates the input elements into a newSet
. There are no guarantees on the type, mutability, serializability, or thread-safety of theSet
returned; if more control over the returnedSet
is required, usetoCollection(Remote.Supplier)
.This is an
unordered
Collector.- Type Parameters:
T
- the type of the input elements- Returns:
- a
Collector
which collects all the input elements into aSet
-
toSortedSet
public static <T> RemoteCollector<T,?,SortedSet<T>> toSortedSet()
Returns aCollector
that accumulates the input elements into a newSortedSet
. There are no guarantees on the type, mutability, serializability, or thread-safety of theSortedSet
returned; if more control over the returnedSortedSet
is required, usetoCollection(Remote.Supplier)
.This is an
unordered
Collector.- Type Parameters:
T
- the type of the input elements- Returns:
- a
Collector
which collects all the input elements into aSortedSet
-
toSortedSet
public static <T,E extends Comparable<? super E>> RemoteCollector<T,?,SortedSet<T>> toSortedSet(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that accumulates the input elements into a newSortedSet
. There are no guarantees on the type, mutability, serializability, or thread-safety of theSortedSet
returned; if more control over the returnedSortedSet
is required, usetoCollection(Remote.Supplier)
.This is an
unordered
Collector.- Type Parameters:
T
- the type of the input elements- Parameters:
comparable
- aValueExtractor
that returns aComparable
value- Returns:
- a
Collector
which collects all the input elements into aSortedSet
-
toSortedSet
public static <T> RemoteCollector<T,?,SortedSet<T>> toSortedSet(Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedSet
. There are no guarantees on the type, mutability, serializability, or thread-safety of theSortedSet
returned; if more control over the returnedSortedSet
is required, usetoCollection(Remote.Supplier)
.This is an
unordered
Collector.- Type Parameters:
T
- the type of the input elements- Parameters:
comparator
- a comparator for type T- Returns:
- a
Collector
which collects all the input elements into aSortedSet
-
toSortedSet
public static <T> RemoteCollector<T,?,SortedSet<T>> toSortedSet(Remote.Comparator<? super T> comparator)
Returns aCollector
that accumulates the input elements into a newSortedSet
. There are no guarantees on the type, mutability, serializability, or thread-safety of theSortedSet
returned; if more control over the returnedSortedSet
is required, usetoCollection(Remote.Supplier)
.This is an
unordered
Collector.- Type Parameters:
T
- the type of the input elements- Parameters:
comparator
- a comparator for type T- Returns:
- a
Collector
which collects all the input elements into aSortedSet
-
mapping
public static <T,U,A,R> RemoteCollector<T,A,R> mapping(Remote.Function<? super T,? extends U> mapper, RemoteCollector<? super U,A,R> downstream)
Adapts aCollector
accepting elements of typeU
to one accepting elements of typeT
by applying a mapping function to each input element before accumulation.- Type Parameters:
T
- the type of the input elementsU
- type of elements accepted by downstream collectorA
- intermediate accumulation type of the downstream collectorR
- result type of collector- Parameters:
mapper
- a function to be applied to the input elementsdownstream
- a collector which will accept mapped values- Returns:
- a collector which applies the mapping function to the input elements and provides the mapped results to the downstream collector
- API Note:
- The
mapping()
collectors are most useful when used in a multi-level reduction, such as downstream of agroupingBy
orpartitioningBy
. For example, given a stream ofPerson
, to accumulate the set of last names in each city:Map<City, Set<String>> lastNamesByCity = people.stream().collect(groupingBy(Person::getCity, mapping(Person::getLastName, toSet())));
-
collectingAndThen
public static <T,A,R,RR> RemoteCollector<T,A,RR> collectingAndThen(RemoteCollector<T,A,R> downstream, Remote.Function<R,RR> finisher)
Adapts aCollector
to perform an additional finishing transformation. For example, one could adapt thetoList()
collector to always produce an immutable list with:List<String> people = people.stream().collect(collectingAndThen(toList(), Collections::unmodifiableList));
- Type Parameters:
T
- the type of the input elementsA
- intermediate accumulation type of the downstream collectorR
- result type of the downstream collectorRR
- result type of the resulting collector- Parameters:
downstream
- a collectorfinisher
- a function to be applied to the final result of the downstream collector- Returns:
- a collector which performs the action of the downstream collector, followed by an additional finishing step
-
counting
public static <T> RemoteCollector<T,?,Long> counting()
Returns aCollector
accepting elements of typeT
that counts the number of input elements. If no elements are present, the result is 0.- Type Parameters:
T
- the type of the input elements- Returns:
- a
Collector
that counts the input elements - Implementation Requirements:
- This produces a result equivalent to:
reducing(0L, e -> 1L, Long::sum)
-
minBy
public static <T,E extends Comparable<? super E>> RemoteCollector<T,?,Optional<T>> minBy(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that produces the minimal element according to a givenComparable
attribute, described as anOptional<T>
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparable
- aValueExtractor
that returns aComparable
value- Returns:
- a
Collector
that produces the minimal value - Implementation Requirements:
- This produces a result equivalent to:
reducing(Remote.BinaryOperator.minBy(comparator))
-
minBy
public static <T> RemoteCollector<T,?,Optional<T>> minBy(Remote.Comparator<? super T> comparator)
Returns aCollector
that produces the minimal element according to a givenComparator
, described as anOptional<T>
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparator
- aComparator
for comparing elements- Returns:
- a
Collector
that produces the minimal value - Implementation Requirements:
- This produces a result equivalent to:
reducing(Remote.BinaryOperator.minBy(comparator))
-
maxBy
public static <T,E extends Comparable<? super E>> RemoteCollector<T,?,Optional<T>> maxBy(ValueExtractor<? super T,? extends E> comparable)
Returns aCollector
that produces the maximal element according to a givenComparable
attribute, described as anOptional<T>
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparable
- aValueExtractor
that returns aComparable
value- Returns:
- a
Collector
that produces the minimal value - Implementation Requirements:
- This produces a result equivalent to:
reducing(Remote.BinaryOperator.minBy(comparator))
-
maxBy
public static <T> RemoteCollector<T,?,Optional<T>> maxBy(Remote.Comparator<? super T> comparator)
Returns aCollector
that produces the maximal element according to a givenComparator
, described as anOptional<T>
.- Type Parameters:
T
- the type of the input elements- Parameters:
comparator
- aComparator
for comparing elements- Returns:
- a
Collector
that produces the maximal value - Implementation Requirements:
- This produces a result equivalent to:
reducing(BinaryOperator.maxBy(comparator))
-
summingInt
public static <T,U> RemoteCollector<T,?,Integer> summingInt(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the sum of a integer-valued function applied to the input elements. If no elements are present, the result is 0.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a function extracting the property to be summed- Returns:
- a
Collector
that produces the sum of a derived property
-
summingLong
public static <T,U> RemoteCollector<T,?,Long> summingLong(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the sum of a long-valued function applied to the input elements. If no elements are present, the result is 0.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a function extracting the property to be summed- Returns:
- a
Collector
that produces the sum of a derived property
-
summingDouble
public static <T,U> RemoteCollector<T,?,Double> summingDouble(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the sum of a double-valued function applied to the input elements. If no elements are present, the result is 0.The sum returned can vary depending upon the order in which values are recorded, due to accumulated rounding error in addition of values of differing magnitudes. Values sorted by increasing absolute magnitude tend to yield more accurate results. If any recorded value is a
NaN
or the sum is at any point aNaN
then the sum will beNaN
.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a function extracting the property to be summed- Returns:
- a
Collector
that produces the sum of a derived property
-
averagingInt
public static <T,U> RemoteCollector<T,?,Double> averagingInt(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the arithmetic mean of an integer-valued function applied to the input elements. If no elements are present, the result is 0.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a function extracting the property to be summed- Returns:
- a
Collector
that produces the sum of a derived property
-
averagingLong
public static <T,U> RemoteCollector<T,?,Double> averagingLong(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the arithmetic mean of a long-valued function applied to the input elements. If no elements are present, the result is 0.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a function extracting the property to be averaged- Returns:
- a
Collector
that produces the average of a derived property
-
averagingDouble
public static <T,U> RemoteCollector<T,?,Double> averagingDouble(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
that produces the arithmetic mean of a double-valued function applied to the input elements. If no elements are present, the result is 0.The average returned can vary depending upon the order in which values are recorded, due to accumulated rounding error in addition of values of differing magnitudes. Values sorted by increasing absolute magnitude tend to yield more accurate results. If any recorded value is a
NaN
or the sum is at any point aNaN
then the average will beNaN
.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a function extracting the property to be summed- Returns:
- a
Collector
that produces the sum of a derived property - Implementation Note:
- The
double
format can represent all consecutive integers in the range -253 to 253. If the pipeline has more than 253 values, the divisor in the average computation will saturate at 253, leading to additional numerical errors.
-
reducing
public static <T> RemoteCollector<T,SimpleHolder<T>,T> reducing(T identity, Remote.BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
using the provided identity.- Type Parameters:
T
- element type for the input and output of the reduction- Parameters:
identity
- the identity value for the reduction (also, the value that is returned when there are no input elements)op
- aBinaryOperator<T>
used to reduce the input elements- Returns:
- a
Collector
which implements the reduction operation - See Also:
reducing(Remote.BinaryOperator)
,reducing(Object, Remote.Function, Remote.BinaryOperator)
- API Note:
- The
reducing()
collectors are most useful when used in a multi-level reduction, downstream ofgroupingBy
orpartitioningBy
. To perform a simple reduction on a stream, useRemoteStream.reduce(Object, BinaryOperator)
} instead.
-
reducing
public static <T> RemoteCollector<T,?,Optional<T>> reducing(Remote.BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
. The result is described as anOptional<T>
.- Type Parameters:
T
- element type for the input and output of the reduction- Parameters:
op
- aBinaryOperator<T>
used to reduce the input elements- Returns:
- a
Collector
which implements the reduction operation - See Also:
reducing(Object, Remote.BinaryOperator)
,reducing(Object, Remote.Function, Remote.BinaryOperator)
- API Note:
- The
reducing()
collectors are most useful when used in a multi-level reduction, downstream ofgroupingBy
orpartitioningBy
. To perform a simple reduction on a stream, useRemoteStream.reduce(BinaryOperator)
instead.For example, given a stream of
Person
, to calculate tallest person in each city:Comparator<Person> byHeight = Comparator.comparing(Person::getHeight); Map<City, Person> tallestByCity = people.stream().collect(groupingBy(Person::getCity, reducing(BinaryOperator.maxBy(byHeight))));
-
reducing
public static <T,U> RemoteCollector<T,?,U> reducing(U identity, Remote.Function<? super T,? extends U> mapper, Remote.BinaryOperator<U> op)
Returns aCollector
which performs a reduction of its input elements under a specified mapping function andBinaryOperator
. This is a generalization ofreducing(Object, Remote.BinaryOperator)
which allows a transformation of the elements before reduction.- Type Parameters:
T
- the type of the input elementsU
- the type of the mapped values- Parameters:
identity
- the identity value for the reduction (also, the value that is returned when there are no input elements)mapper
- a mapping function to apply to each input valueop
- aBinaryOperator<U>
used to reduce the mapped values- Returns:
- a
Collector
implementing the map-reduce operation - See Also:
reducing(Object, Remote.BinaryOperator)
,reducing(Remote.BinaryOperator)
- API Note:
- The
reducing()
collectors are most useful when used in a multi-level reduction, downstream ofgroupingBy
orpartitioningBy
. To perform a simple map-reduce on a stream, useRemoteStream.map(Function)
andRemoteStream.reduce(Object, BinaryOperator)
instead.For example, given a stream of
Person
, to calculate the longest last name of residents in each city:Comparator<String> byLength = Comparator.comparing(String::length); Map<City, String> longestLastNameByCity = people.stream().collect(groupingBy(Person::getCity, reducing(Person::getLastName, BinaryOperator.maxBy(byLength))));
-
reducing
public static <T,U> RemoteCollector<T,?,U> reducing(U identity, Remote.BiFunction<? super U,? super T,? extends U> mapper, Remote.BinaryOperator<U> op)
Returns aCollector
which performs a reduction of its input elements under a specified mapping function andBinaryOperator
. This is a generalization ofreducing(Object, Remote.BinaryOperator)
which allows a transformation of the elements before reduction.- Type Parameters:
T
- the type of the input elementsU
- the type of the mapped values- Parameters:
identity
- the identity value for the reduction (also, the value that is returned when there are no input elements)mapper
- a mapping function to apply to each input valueop
- aBinaryOperator<U>
used to reduce the mapped values- Returns:
- a
Collector
implementing the map-reduce operation - See Also:
reducing(Object, Remote.BinaryOperator)
,reducing(Remote.BinaryOperator)
- API Note:
- The
reducing()
collectors are most useful when used in a multi-level reduction, downstream ofgroupingBy
orpartitioningBy
. To perform a simple map-reduce on a stream, useRemoteStream.map(Function)
andRemoteStream.reduce(Object, BinaryOperator)
instead.For example, given a stream of
Person
, to calculate the longest last name of residents in each city:Comparator<String> byLength = Comparator.comparing(String::length); Map<City, String> longestLastNameByCity = people.stream().collect(groupingBy(Person::getCity, reducing(Person::getLastName, BinaryOperator.maxBy(byLength))));
-
groupingBy
public static <T,U,K> RemoteCollector<T,?,Map<K,List<T>>> groupingBy(ValueExtractor<? super U,? extends K> classifier)
Returns aCollector
implementing a "group by" operation on input elements of typeT
, grouping elements according to a classification function, and returning the results in aMap
.The classification function maps elements to some key type
K
. The collector produces aMap<K, List<T>>
whose keys are the values resulting from applying the classification function to the input elements, and whose corresponding values areList
s containing the input elements which map to the associated key under the classification function.There are no guarantees on the type, mutability, serializability, or thread-safety of the
Map
orList
objects returned.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
K
- the type of the keys- Parameters:
classifier
- the classifier function mapping input elements to keys- Returns:
- a
Collector
implementing the group-by operation - See Also:
groupingBy(ValueExtractor, RemoteCollector)
,groupingBy(ValueExtractor, Remote.Supplier, RemoteCollector)
- Implementation Requirements:
- This produces a result similar to:
groupingBy(classifier, toList());
-
groupingBy
public static <T,U,K,A,D> RemoteCollector<T,?,Map<K,D>> groupingBy(ValueExtractor<? super U,? extends K> classifier, RemoteCollector<? super T,A,D> downstream)
Returns aCollector
implementing a cascaded "group by" operation on input elements of typeT
, grouping elements according to a classification function, and then performing a reduction operation on the values associated with a given key using the specified downstreamCollector
.The classification function maps elements to some key type
K
. The downstream collector operates on elements of typeT
and produces a result of typeD
. The resulting collector produces aMap<K, D>
.There are no guarantees on the type, mutability, serializability, or thread-safety of the
Map
returned.For example, to compute the set of last names of people in each city:
Map<City, Set<String>> namesByCity = people.stream().collect(groupingBy(Person::getCity, mapping(Person::getLastName, toSet())));
- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
K
- the type of the keysA
- the intermediate accumulation type of the downstream collectorD
- the result type of the downstream reduction- Parameters:
classifier
- a classifier function mapping input elements to keysdownstream
- aCollector
implementing the downstream reduction- Returns:
- a
Collector
implementing the cascaded group-by operation - See Also:
groupingBy(ValueExtractor)
,groupingBy(ValueExtractor, Remote.Supplier, RemoteCollector)
-
groupingBy
public static <T,U,K,D,A,M extends Map<K,D>> RemoteCollector<T,?,M> groupingBy(ValueExtractor<? super U,? extends K> extractor, Remote.Supplier<M> mapFactory, RemoteCollector<? super T,A,D> downstream)
Returns aCollector
implementing a cascaded "group by" operation on input elements of typeT
, grouping elements according to a classification function, and then performing a reduction operation on the values associated with a given key using the specified downstreamCollector
. TheMap
produced by the Collector is created with the supplied factory function.The classification function maps elements to some key type
K
. The downstream collector operates on elements of typeT
and produces a result of typeD
. The resulting collector produces aMap<K, D>
.For example, to compute the set of last names of people in each city, where the city names are sorted:
Map<City, Set<String>> namesByCity = people.stream().collect(groupingBy(Person::getCity, TreeMap::new, mapping(Person::getLastName, toSet())));
- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
K
- the type of the keysA
- the intermediate accumulation type of the downstream collectorD
- the result type of the downstream reductionM
- the type of the resultingMap
- Parameters:
extractor
- an extractor function mapping input elements to keysdownstream
- aCollector
implementing the downstream reductionmapFactory
- a function which, when called, produces a new emptyMap
of the desired type- Returns:
- a
Collector
implementing the cascaded group-by operation - See Also:
groupingBy(ValueExtractor, RemoteCollector)
,groupingBy(ValueExtractor)
-
toMap
public static <T,U1,U2,K,V> RemoteCollector<T,?,Map<K,V>> toMap(ValueExtractor<? super U1,? extends K> keyMapper, ValueExtractor<? super U2,? extends V> valueMapper)
Returns aCollector
that accumulates elements into aMap
whose keys and values are the result of applying the provided mapping functions to the input elements.If the mapped keys contains duplicates (according to
Object.equals(Object)
), anIllegalStateException
is thrown when the collection operation is performed. If the mapped keys may have duplicates, usetoMap(ValueExtractor, ValueExtractor, Remote.BinaryOperator)
instead.- Type Parameters:
T
- the type of the stream elementsU1
- the type of the objects to extract keys from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
U2
- the type of the objects to extract values from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
K
- the output type of the key mapping functionV
- the output type of the value mapping function- Parameters:
keyMapper
- a mapping function to produce keysvalueMapper
- a mapping function to produce values- Returns:
- a
Collector
which collects elements into aMap
whose keys and values are the result of applying mapping functions to the input elements - See Also:
toMap(ValueExtractor, ValueExtractor, Remote.BinaryOperator)
,toMap(ValueExtractor, ValueExtractor, Remote.BinaryOperator, Remote.Supplier)
- API Note:
- It is common for either the key or the value to be the input
elements. In this case, the utility method
Function.identity()
may be helpful. For example, the following produces aMap
mapping students to their grade point average:
And the following produces aMap<Student, Double> studentToGPA students.stream().collect(toMap(Functions.identity(), student -> computeGPA(student)));
Map
mapping a unique identifier to students:Map<String, Student> studentIdToStudent students.stream().collect(toMap(Student::getId, Functions.identity());
-
toMap
public static <T,U1,U2,K,V> RemoteCollector<T,?,Map<K,V>> toMap(ValueExtractor<? super U1,? extends K> keyMapper, ValueExtractor<? super U2,? extends V> valueMapper, Remote.BinaryOperator<V> mergeFunction)
Returns aCollector
that accumulates elements into aMap
whose keys and values are the result of applying the provided mapping functions to the input elements.If the mapped keys contains duplicates (according to
Object.equals(Object)
), the value mapping function is applied to each equal element, and the results are merged using the provided merging function.- Type Parameters:
T
- the type of the stream elementsU1
- the type of the objects to extract keys from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
U2
- the type of the objects to extract values from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
K
- the output type of the key mapping functionV
- the output type of the value mapping function- Parameters:
keyMapper
- a mapping function to produce keysvalueMapper
- a mapping function to produce valuesmergeFunction
- a merge function, used to resolve collisions between values associated with the same key, as supplied toMap.merge(Object, Object, BiFunction)
- Returns:
- a
Collector
which collects elements into aMap
whose keys are the result of applying a key mapping function to the input elements, and whose values are the result of applying a value mapping function to all input elements equal to the key and combining them using the merge function - See Also:
toMap(ValueExtractor, ValueExtractor)
,toMap(ValueExtractor, ValueExtractor, Remote.BinaryOperator, Remote.Supplier)
- API Note:
- There are multiple ways to deal with collisions between multiple
elements mapping to the same key. The other forms of
toMap
simply use a merge function that throws unconditionally, but you can easily write more flexible merge policies. For example, if you have a stream ofPerson
, and you want to produce a "phone book" mapping name to address, but it is possible that two persons have the same name, you can do as follows to gracefully deals with these collisions, and produce aMap
mapping names to a concatenated list of addresses:Map<String, String> phoneBook people.stream().collect(toMap(Person::getName, Person::getAddress, (s, a) -> s + ", " + a));
-
toMap
public static <T,U1,U2,K,V,M extends Map<K,V>> RemoteCollector<T,?,M> toMap(ValueExtractor<? super U1,? extends K> keyExtractor, ValueExtractor<? super U2,? extends V> valueExtractor, Remote.BinaryOperator<V> mergeFunction, Remote.Supplier<M> mapSupplier)
Returns aCollector
that accumulates elements into aMap
whose keys and values are the result of applying the provided mapping functions to the input elements.If the mapped keys contains duplicates (according to
Object.equals(Object)
), the value mapping function is applied to each equal element, and the results are merged using the provided merging function. TheMap
is created by a provided supplier function.- Type Parameters:
T
- the type of the stream elementsU1
- the type of the objects to extract keys from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
U2
- the type of the objects to extract values from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
K
- the output type of the key mapping functionV
- the output type of the value mapping functionM
- the type of the resultingMap
- Parameters:
keyExtractor
- a mapping function to produce keysvalueExtractor
- a mapping function to produce valuesmergeFunction
- a merge function, used to resolve collisions between values associated with the same key, as supplied toMap.merge(Object, Object, BiFunction)
mapSupplier
- a function which returns a new, emptyMap
into which the results will be inserted- Returns:
- a
Collector
which collects elements into aMap
whose keys are the result of applying a key mapping function to the input elements, and whose values are the result of applying a value mapping function to all input elements equal to the key and combining them using the merge function - See Also:
toMap(ValueExtractor, ValueExtractor)
,toMap(ValueExtractor, ValueExtractor, Remote.BinaryOperator)
-
summarizingInt
public static <T,U> RemoteCollector<T,?,com.tangosol.internal.util.IntSummaryStatistics> summarizingInt(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
which applies anint
-producing mapping function to each input element, and returns summary statistics for the resulting values.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a mapping function to apply to each element- Returns:
- a
Collector
implementing the summary-statistics reduction - See Also:
summarizingDouble(ValueExtractor)
,summarizingLong(ValueExtractor)
-
summarizingLong
public static <T,U> RemoteCollector<T,?,com.tangosol.internal.util.LongSummaryStatistics> summarizingLong(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
which applies anlong
-producing mapping function to each input element, and returns summary statistics for the resulting values.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a mapping function to apply to each element- Returns:
- a
Collector
implementing the summary-statistics reduction - See Also:
summarizingDouble(ValueExtractor)
,summarizingInt(ValueExtractor)
-
summarizingDouble
public static <T,U> RemoteCollector<T,?,com.tangosol.internal.util.DoubleSummaryStatistics> summarizingDouble(ValueExtractor<? super U,? extends Number> extractor)
Returns aCollector
which applies andouble
-producing mapping function to each input element, and returns summary statistics for the resulting values.- Type Parameters:
T
- the type of the stream elementsU
- the type of the objects to extract from, which should be either the same asT
, or the key or value type if theT
isInvocableMap.Entry
- Parameters:
extractor
- a mapping function to apply to each element- Returns:
- a
Collector
implementing the summary-statistics reduction - See Also:
summarizingLong(ValueExtractor)
,summarizingInt(ValueExtractor)
-
-