Class Collectors
- java.lang.Object
-
- java.util.stream.Collectors
-
public final class Collectors extends Object
Implementations ofCollector
that implement various useful reduction operations, such as accumulating elements into collections, summarizing elements according to various criteria, etc.The following are examples of using the predefined collectors to perform common mutable reduction tasks:
// Accumulate names into a List List<String> list = people.stream().map(Person::getName).collect(Collectors.toList()); // Accumulate names into a TreeSet Set<String> set = people.stream().map(Person::getName).collect(Collectors.toCollection(TreeSet::new)); // Convert elements to strings and concatenate them, separated by commas String joined = things.stream() .map(Object::toString) .collect(Collectors.joining(", ")); // Compute sum of salaries of employee int total = employees.stream() .collect(Collectors.summingInt(Employee::getSalary))); // Group employees by department Map<Department, List<Employee>> byDept = employees.stream() .collect(Collectors.groupingBy(Employee::getDepartment)); // Compute sum of salaries by department Map<Department, Integer> totalByDept = employees.stream() .collect(Collectors.groupingBy(Employee::getDepartment, Collectors.summingInt(Employee::getSalary))); // Partition students into passing and failing Map<Boolean, List<Student>> passingFailing = students.stream() .collect(Collectors.partitioningBy(s -> s.getGrade() >= PASS_THRESHOLD));
- Since:
- 1.8
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method and Description static <T> Collector<T,?,Double>
averagingDouble(ToDoubleFunction<? super T> mapper)
Returns aCollector
that produces the arithmetic mean of a double-valued function applied to the input elements.static <T> Collector<T,?,Double>
averagingInt(ToIntFunction<? super T> mapper)
Returns aCollector
that produces the arithmetic mean of an integer-valued function applied to the input elements.static <T> Collector<T,?,Double>
averagingLong(ToLongFunction<? super T> mapper)
Returns aCollector
that produces the arithmetic mean of a long-valued function applied to the input elements.static <T,A,R,RR> Collector<T,A,RR>
collectingAndThen(Collector<T,A,R> downstream, Function<R,RR> finisher)
Adapts aCollector
to perform an additional finishing transformation.static <T> Collector<T,?,Long>
counting()
Returns aCollector
accepting elements of typeT
that counts the number of input elements.static <T,K> Collector<T,?,Map<K,List<T>>>
groupingBy(Function<? super T,? 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,K,A,D> Collector<T,?,Map<K,D>>
groupingBy(Function<? super T,? extends K> classifier, Collector<? 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,K,D,A,M extends Map<K,D>>
Collector<T,?,M>groupingBy(Function<? super T,? extends K> classifier, Supplier<M> mapFactory, Collector<? 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,K> Collector<T,?,ConcurrentMap<K,List<T>>>
groupingByConcurrent(Function<? super T,? extends K> classifier)
Returns a concurrentCollector
implementing a "group by" operation on input elements of typeT
, grouping elements according to a classification function.static <T,K,A,D> Collector<T,?,ConcurrentMap<K,D>>
groupingByConcurrent(Function<? super T,? extends K> classifier, Collector<? super T,A,D> downstream)
Returns a concurrentCollector
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,K,A,D,M extends ConcurrentMap<K,D>>
Collector<T,?,M>groupingByConcurrent(Function<? super T,? extends K> classifier, Supplier<M> mapFactory, Collector<? super T,A,D> downstream)
Returns a concurrentCollector
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 Collector<CharSequence,?,String>
joining()
Returns aCollector
that concatenates the input elements into aString
, in encounter order.static Collector<CharSequence,?,String>
joining(CharSequence delimiter)
Returns aCollector
that concatenates the input elements, separated by the specified delimiter, in encounter order.static Collector<CharSequence,?,String>
joining(CharSequence delimiter, CharSequence prefix, CharSequence suffix)
Returns aCollector
that concatenates the input elements, separated by the specified delimiter, with the specified prefix and suffix, in encounter order.static <T,U,A,R> Collector<T,?,R>
mapping(Function<? super T,? extends U> mapper, Collector<? 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> Collector<T,?,Optional<T>>
maxBy(Comparator<? super T> comparator)
Returns aCollector
that produces the maximal element according to a givenComparator
, described as anOptional<T>
.static <T> Collector<T,?,Optional<T>>
minBy(Comparator<? super T> comparator)
Returns aCollector
that produces the minimal element according to a givenComparator
, described as anOptional<T>
.static <T> Collector<T,?,Map<Boolean,List<T>>>
partitioningBy(Predicate<? super T> predicate)
Returns aCollector
which partitions the input elements according to aPredicate
, and organizes them into aMap<Boolean, List<T>>
.static <T,D,A> Collector<T,?,Map<Boolean,D>>
partitioningBy(Predicate<? super T> predicate, Collector<? super T,A,D> downstream)
Returns aCollector
which partitions the input elements according to aPredicate
, reduces the values in each partition according to anotherCollector
, and organizes them into aMap<Boolean, D>
whose values are the result of the downstream reduction.static <T> Collector<T,?,Optional<T>>
reducing(BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
.static <T> Collector<T,?,T>
reducing(T identity, BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
using the provided identity.static <T,U> Collector<T,?,U>
reducing(U identity, Function<? super T,? extends U> mapper, BinaryOperator<U> op)
Returns aCollector
which performs a reduction of its input elements under a specified mapping function andBinaryOperator
.static <T> Collector<T,?,DoubleSummaryStatistics>
summarizingDouble(ToDoubleFunction<? super T> mapper)
Returns aCollector
which applies andouble
-producing mapping function to each input element, and returns summary statistics for the resulting values.static <T> Collector<T,?,IntSummaryStatistics>
summarizingInt(ToIntFunction<? super T> mapper)
Returns aCollector
which applies anint
-producing mapping function to each input element, and returns summary statistics for the resulting values.static <T> Collector<T,?,LongSummaryStatistics>
summarizingLong(ToLongFunction<? super T> mapper)
Returns aCollector
which applies anlong
-producing mapping function to each input element, and returns summary statistics for the resulting values.static <T> Collector<T,?,Double>
summingDouble(ToDoubleFunction<? super T> mapper)
Returns aCollector
that produces the sum of a double-valued function applied to the input elements.static <T> Collector<T,?,Integer>
summingInt(ToIntFunction<? super T> mapper)
Returns aCollector
that produces the sum of a integer-valued function applied to the input elements.static <T> Collector<T,?,Long>
summingLong(ToLongFunction<? super T> mapper)
Returns aCollector
that produces the sum of a long-valued function applied to the input elements.static <T,C extends Collection<T>>
Collector<T,?,C>toCollection(Supplier<C> collectionFactory)
Returns aCollector
that accumulates the input elements into a newCollection
, in encounter order.static <T,K,U> Collector<T,?,ConcurrentMap<K,U>>
toConcurrentMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper)
Returns a concurrentCollector
that accumulates elements into aConcurrentMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T,K,U> Collector<T,?,ConcurrentMap<K,U>>
toConcurrentMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> mergeFunction)
Returns a concurrentCollector
that accumulates elements into aConcurrentMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T,K,U,M extends ConcurrentMap<K,U>>
Collector<T,?,M>toConcurrentMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> mergeFunction, Supplier<M> mapSupplier)
Returns a concurrentCollector
that accumulates elements into aConcurrentMap
whose keys and values are the result of applying the provided mapping functions to the input elements.static <T> Collector<T,?,List<T>>
toList()
Returns aCollector
that accumulates the input elements into a newList
.static <T,K,U> Collector<T,?,Map<K,U>>
toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> 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,K,U> Collector<T,?,Map<K,U>>
toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> 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,K,U,M extends Map<K,U>>
Collector<T,?,M>toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> mergeFunction, 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> Collector<T,?,Set<T>>
toSet()
Returns aCollector
that accumulates the input elements into a newSet
.
-
-
-
Method Detail
toCollection
public static <T,C extends Collection<T>> Collector<T,?,C> toCollection(Supplier<C> collectionFactory)
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 elements -
C
- the type of the resultingCollection
- Parameters:
-
collectionFactory
- 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> Collector<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(Supplier)
.- Type Parameters:
-
T
- the type of the input elements - Returns:
-
a
Collector
which collects all the input elements into aList
, in encounter order
toSet
public static <T> Collector<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(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
joining
public static Collector<CharSequence,?,String> joining()
Returns aCollector
that concatenates the input elements into aString
, in encounter order.- Returns:
-
a
Collector
that concatenates the input elements into aString
, in encounter order
joining
public static Collector<CharSequence,?,String> joining(CharSequence delimiter)
Returns aCollector
that concatenates the input elements, separated by the specified delimiter, in encounter order.- Parameters:
-
delimiter
- the delimiter to be used between each element - Returns:
-
A
Collector
which concatenates CharSequence elements, separated by the specified delimiter, in encounter order
joining
public static Collector<CharSequence,?,String> joining(CharSequence delimiter, CharSequence prefix, CharSequence suffix)
Returns aCollector
that concatenates the input elements, separated by the specified delimiter, with the specified prefix and suffix, in encounter order.- Parameters:
-
delimiter
- the delimiter to be used between each element -
prefix
- the sequence of characters to be used at the beginning of the joined result -
suffix
- the sequence of characters to be used at the end of the joined result - Returns:
-
A
Collector
which concatenates CharSequence elements, separated by the specified delimiter, in encounter order
mapping
public static <T,U,A,R> Collector<T,?,R> mapping(Function<? super T,? extends U> mapper, Collector<? 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.- 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())));
- Type Parameters:
-
T
- the type of the input elements -
U
- type of elements accepted by downstream collector -
A
- intermediate accumulation type of the downstream collector -
R
- result type of collector - Parameters:
-
mapper
- a function to be applied to the input elements -
downstream
- 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
collectingAndThen
public static <T,A,R,RR> Collector<T,A,RR> collectingAndThen(Collector<T,A,R> downstream, 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 elements -
A
- intermediate accumulation type of the downstream collector -
R
- result type of the downstream collector -
RR
- result type of the resulting collector - Parameters:
-
downstream
- a collector -
finisher
- 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> Collector<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.- Implementation Requirements:
-
This produces a result equivalent to:
reducing(0L, e -> 1L, Long::sum)
- Type Parameters:
-
T
- the type of the input elements - Returns:
-
a
Collector
that counts the input elements
minBy
public static <T> Collector<T,?,Optional<T>> minBy(Comparator<? super T> comparator)
Returns aCollector
that produces the minimal element according to a givenComparator
, described as anOptional<T>
.- Implementation Requirements:
-
This produces a result equivalent to:
reducing(BinaryOperator.minBy(comparator))
- Type Parameters:
-
T
- the type of the input elements - Parameters:
-
comparator
- aComparator
for comparing elements - Returns:
-
a
Collector
that produces the minimal value
maxBy
public static <T> Collector<T,?,Optional<T>> maxBy(Comparator<? super T> comparator)
Returns aCollector
that produces the maximal element according to a givenComparator
, described as anOptional<T>
.- Implementation Requirements:
-
This produces a result equivalent to:
reducing(BinaryOperator.maxBy(comparator))
- Type Parameters:
-
T
- the type of the input elements - Parameters:
-
comparator
- aComparator
for comparing elements - Returns:
-
a
Collector
that produces the maximal value
summingInt
public static <T> Collector<T,?,Integer> summingInt(ToIntFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a function extracting the property to be summed - Returns:
-
a
Collector
that produces the sum of a derived property
summingLong
public static <T> Collector<T,?,Long> summingLong(ToLongFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a function extracting the property to be summed - Returns:
-
a
Collector
that produces the sum of a derived property
summingDouble
public static <T> Collector<T,?,Double> summingDouble(ToDoubleFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a function extracting the property to be summed - Returns:
-
a
Collector
that produces the sum of a derived property
averagingInt
public static <T> Collector<T,?,Double> averagingInt(ToIntFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a function extracting the property to be summed - Returns:
-
a
Collector
that produces the sum of a derived property
averagingLong
public static <T> Collector<T,?,Double> averagingLong(ToLongFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a function extracting the property to be summed - Returns:
-
a
Collector
that produces the sum of a derived property
averagingDouble
public static <T> Collector<T,?,Double> averagingDouble(ToDoubleFunction<? super T> mapper)
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
.- 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. - Type Parameters:
-
T
- the type of the input elements - Parameters:
-
mapper
- a function extracting the property to be summed - Returns:
-
a
Collector
that produces the sum of a derived property
reducing
public static <T> Collector<T,?,T> reducing(T identity, BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
using the provided identity.- 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, useStream.reduce(Object, BinaryOperator)
} instead. - 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(BinaryOperator)
,reducing(Object, Function, BinaryOperator)
reducing
public static <T> Collector<T,?,Optional<T>> reducing(BinaryOperator<T> op)
Returns aCollector
which performs a reduction of its input elements under a specifiedBinaryOperator
. The result is described as anOptional<T>
.- 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, useStream.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))));
- 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, BinaryOperator)
,reducing(Object, Function, BinaryOperator)
reducing
public static <T,U> Collector<T,?,U> reducing(U identity, Function<? super T,? extends U> mapper, 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, BinaryOperator)
which allows a transformation of the elements before reduction.- 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, useStream.map(Function)
andStream.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))));
- Type Parameters:
-
T
- the type of the input elements -
U
- 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 value -
op
- aBinaryOperator<U>
used to reduce the mapped values - Returns:
-
a
Collector
implementing the map-reduce operation - See Also:
-
reducing(Object, BinaryOperator)
,reducing(BinaryOperator)
groupingBy
public static <T,K> Collector<T,?,Map<K,List<T>>> groupingBy(Function<? super T,? 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.- Implementation Requirements:
-
This produces a result similar to:
groupingBy(classifier, toList());
- Implementation Note:
-
The returned
Collector
is not concurrent. For parallel stream pipelines, thecombiner
function operates by merging the keys from one map into another, which can be an expensive operation. If preservation of the order in which elements appear in the resultingMap
collector is not required, usinggroupingByConcurrent(Function)
may offer better parallel performance. - Type Parameters:
-
T
- the type of the input elements -
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(Function, Collector)
,groupingBy(Function, Supplier, Collector)
,groupingByConcurrent(Function)
groupingBy
public static <T,K,A,D> Collector<T,?,Map<K,D>> groupingBy(Function<? super T,? extends K> classifier, Collector<? 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())));
- Implementation Note:
-
The returned
Collector
is not concurrent. For parallel stream pipelines, thecombiner
function operates by merging the keys from one map into another, which can be an expensive operation. If preservation of the order in which elements are presented to the downstream collector is not required, usinggroupingByConcurrent(Function, Collector)
may offer better parallel performance. - Type Parameters:
-
T
- the type of the input elements -
K
- the type of the keys -
A
- the intermediate accumulation type of the downstream collector -
D
- the result type of the downstream reduction - Parameters:
-
classifier
- a classifier function mapping input elements to keys -
downstream
- aCollector
implementing the downstream reduction - Returns:
-
a
Collector
implementing the cascaded group-by operation - See Also:
-
groupingBy(Function)
,groupingBy(Function, Supplier, Collector)
,groupingByConcurrent(Function, Collector)
groupingBy
public static <T,K,D,A,M extends Map<K,D>> Collector<T,?,M> groupingBy(Function<? super T,? extends K> classifier, Supplier<M> mapFactory, Collector<? 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())));
- Implementation Note:
-
The returned
Collector
is not concurrent. For parallel stream pipelines, thecombiner
function operates by merging the keys from one map into another, which can be an expensive operation. If preservation of the order in which elements are presented to the downstream collector is not required, usinggroupingByConcurrent(Function, Supplier, Collector)
may offer better parallel performance. - Type Parameters:
-
T
- the type of the input elements -
K
- the type of the keys -
A
- the intermediate accumulation type of the downstream collector -
D
- the result type of the downstream reduction -
M
- the type of the resultingMap
- Parameters:
-
classifier
- a classifier function mapping input elements to keys -
downstream
- aCollector
implementing the downstream reduction -
mapFactory
- 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(Function, Collector)
,groupingBy(Function)
,groupingByConcurrent(Function, Supplier, Collector)
groupingByConcurrent
public static <T,K> Collector<T,?,ConcurrentMap<K,List<T>>> groupingByConcurrent(Function<? super T,? extends K> classifier)
Returns a concurrentCollector
implementing a "group by" operation on input elements of typeT
, grouping elements according to a classification function.This is a
concurrent
andunordered
Collector.The classification function maps elements to some key type
K
. The collector produces aConcurrentMap<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, or serializability of the
Map
orList
objects returned, or of the thread-safety of theList
objects returned.- Implementation Requirements:
-
This produces a result similar to:
groupingByConcurrent(classifier, toList());
- Type Parameters:
-
T
- the type of the input elements -
K
- the type of the keys - Parameters:
-
classifier
- a classifier function mapping input elements to keys - Returns:
-
a concurrent, unordered
Collector
implementing the group-by operation - See Also:
-
groupingBy(Function)
,groupingByConcurrent(Function, Collector)
,groupingByConcurrent(Function, Supplier, Collector)
groupingByConcurrent
public static <T,K,A,D> Collector<T,?,ConcurrentMap<K,D>> groupingByConcurrent(Function<? super T,? extends K> classifier, Collector<? super T,A,D> downstream)
Returns a concurrentCollector
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
.This is a
concurrent
andunordered
Collector.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:
ConcurrentMap<City, Set<String>> namesByCity = people.stream().collect(groupingByConcurrent(Person::getCity, mapping(Person::getLastName, toSet())));
- Type Parameters:
-
T
- the type of the input elements -
K
- the type of the keys -
A
- the intermediate accumulation type of the downstream collector -
D
- the result type of the downstream reduction - Parameters:
-
classifier
- a classifier function mapping input elements to keys -
downstream
- aCollector
implementing the downstream reduction - Returns:
-
a concurrent, unordered
Collector
implementing the cascaded group-by operation - See Also:
-
groupingBy(Function, Collector)
,groupingByConcurrent(Function)
,groupingByConcurrent(Function, Supplier, Collector)
groupingByConcurrent
public static <T,K,A,D,M extends ConcurrentMap<K,D>> Collector<T,?,M> groupingByConcurrent(Function<? super T,? extends K> classifier, Supplier<M> mapFactory, Collector<? super T,A,D> downstream)
Returns a concurrentCollector
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
. TheConcurrentMap
produced by the Collector is created with the supplied factory function.This is a
concurrent
andunordered
Collector.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:
ConcurrentMap<City, Set<String>> namesByCity = people.stream().collect(groupingBy(Person::getCity, ConcurrentSkipListMap::new, mapping(Person::getLastName, toSet())));
- Type Parameters:
-
T
- the type of the input elements -
K
- the type of the keys -
A
- the intermediate accumulation type of the downstream collector -
D
- the result type of the downstream reduction -
M
- the type of the resultingConcurrentMap
- Parameters:
-
classifier
- a classifier function mapping input elements to keys -
downstream
- aCollector
implementing the downstream reduction -
mapFactory
- a function which, when called, produces a new emptyConcurrentMap
of the desired type - Returns:
-
a concurrent, unordered
Collector
implementing the cascaded group-by operation - See Also:
-
groupingByConcurrent(Function)
,groupingByConcurrent(Function, Collector)
,groupingBy(Function, Supplier, Collector)
partitioningBy
public static <T> Collector<T,?,Map<Boolean,List<T>>> partitioningBy(Predicate<? super T> predicate)
Returns aCollector
which partitions the input elements according to aPredicate
, and organizes them into aMap<Boolean, List<T>>
. There are no guarantees on the type, mutability, serializability, or thread-safety of theMap
returned.- Type Parameters:
-
T
- the type of the input elements - Parameters:
-
predicate
- a predicate used for classifying input elements - Returns:
-
a
Collector
implementing the partitioning operation - See Also:
-
partitioningBy(Predicate, Collector)
partitioningBy
public static <T,D,A> Collector<T,?,Map<Boolean,D>> partitioningBy(Predicate<? super T> predicate, Collector<? super T,A,D> downstream)
Returns aCollector
which partitions the input elements according to aPredicate
, reduces the values in each partition according to anotherCollector
, and organizes them into aMap<Boolean, D>
whose values are the result of the downstream reduction.There are no guarantees on the type, mutability, serializability, or thread-safety of the
Map
returned.- Type Parameters:
-
T
- the type of the input elements -
A
- the intermediate accumulation type of the downstream collector -
D
- the result type of the downstream reduction - Parameters:
-
predicate
- a predicate used for classifying input elements -
downstream
- aCollector
implementing the downstream reduction - Returns:
-
a
Collector
implementing the cascaded partitioning operation - See Also:
-
partitioningBy(Predicate)
toMap
public static <T,K,U> Collector<T,?,Map<K,U>> toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> 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(Function, Function, BinaryOperator)
instead.- 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());
- Implementation Note:
-
The returned
Collector
is not concurrent. For parallel stream pipelines, thecombiner
function operates by merging the keys from one map into another, which can be an expensive operation. If it is not required that results are inserted into theMap
in encounter order, usingtoConcurrentMap(Function, Function)
may offer better parallel performance. - Type Parameters:
-
T
- the type of the input elements -
K
- the output type of the key mapping function -
U
- the output type of the value mapping function - Parameters:
-
keyMapper
- a mapping function to produce keys -
valueMapper
- 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(Function, Function, BinaryOperator)
,toMap(Function, Function, BinaryOperator, Supplier)
,toConcurrentMap(Function, Function)
toMap
public static <T,K,U> Collector<T,?,Map<K,U>> toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> 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.- 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));
- Implementation Note:
-
The returned
Collector
is not concurrent. For parallel stream pipelines, thecombiner
function operates by merging the keys from one map into another, which can be an expensive operation. If it is not required that results are merged into theMap
in encounter order, usingtoConcurrentMap(Function, Function, BinaryOperator)
may offer better parallel performance. - Type Parameters:
-
T
- the type of the input elements -
K
- the output type of the key mapping function -
U
- the output type of the value mapping function - Parameters:
-
keyMapper
- a mapping function to produce keys -
valueMapper
- a mapping function to produce values -
mergeFunction
- 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(Function, Function)
,toMap(Function, Function, BinaryOperator, Supplier)
,toConcurrentMap(Function, Function, BinaryOperator)
toMap
public static <T,K,U,M extends Map<K,U>> Collector<T,?,M> toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> mergeFunction, 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.- Implementation Note:
-
The returned
Collector
is not concurrent. For parallel stream pipelines, thecombiner
function operates by merging the keys from one map into another, which can be an expensive operation. If it is not required that results are merged into theMap
in encounter order, usingtoConcurrentMap(Function, Function, BinaryOperator, Supplier)
may offer better parallel performance. - Type Parameters:
-
T
- the type of the input elements -
K
- the output type of the key mapping function -
U
- the output type of the value mapping function -
M
- the type of the resultingMap
- Parameters:
-
keyMapper
- a mapping function to produce keys -
valueMapper
- a mapping function to produce values -
mergeFunction
- 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(Function, Function)
,toMap(Function, Function, BinaryOperator)
,toConcurrentMap(Function, Function, BinaryOperator, Supplier)
toConcurrentMap
public static <T,K,U> Collector<T,?,ConcurrentMap<K,U>> toConcurrentMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper)
Returns a concurrentCollector
that accumulates elements into aConcurrentMap
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, usetoConcurrentMap(Function, Function, BinaryOperator)
instead.- 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(toConcurrentMap(Student::getId, Functions.identity());
This is a
concurrent
andunordered
Collector. - Type Parameters:
-
T
- the type of the input elements -
K
- the output type of the key mapping function -
U
- the output type of the value mapping function - Parameters:
-
keyMapper
- the mapping function to produce keys -
valueMapper
- the mapping function to produce values - Returns:
-
a concurrent, unordered
Collector
which collects elements into aConcurrentMap
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 the input elements - See Also:
-
toMap(Function, Function)
,toConcurrentMap(Function, Function, BinaryOperator)
,toConcurrentMap(Function, Function, BinaryOperator, Supplier)
toConcurrentMap
public static <T,K,U> Collector<T,?,ConcurrentMap<K,U>> toConcurrentMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> mergeFunction)
Returns a concurrentCollector
that accumulates elements into aConcurrentMap
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.- API Note:
-
There are multiple ways to deal with collisions between multiple elements mapping to the same key. The other forms of
toConcurrentMap
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(toConcurrentMap(Person::getName, Person::getAddress, (s, a) -> s + ", " + a));
This is a
concurrent
andunordered
Collector. - Type Parameters:
-
T
- the type of the input elements -
K
- the output type of the key mapping function -
U
- the output type of the value mapping function - Parameters:
-
keyMapper
- a mapping function to produce keys -
valueMapper
- a mapping function to produce values -
mergeFunction
- a merge function, used to resolve collisions between values associated with the same key, as supplied toMap.merge(Object, Object, BiFunction)
- Returns:
-
a concurrent, unordered
Collector
which collects elements into aConcurrentMap
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:
-
toConcurrentMap(Function, Function)
,toConcurrentMap(Function, Function, BinaryOperator, Supplier)
,toMap(Function, Function, BinaryOperator)
toConcurrentMap
public static <T,K,U,M extends ConcurrentMap<K,U>> Collector<T,?,M> toConcurrentMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends U> valueMapper, BinaryOperator<U> mergeFunction, Supplier<M> mapSupplier)
Returns a concurrentCollector
that accumulates elements into aConcurrentMap
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. TheConcurrentMap
is created by a provided supplier function.This is a
concurrent
andunordered
Collector.- Type Parameters:
-
T
- the type of the input elements -
K
- the output type of the key mapping function -
U
- the output type of the value mapping function -
M
- the type of the resultingConcurrentMap
- Parameters:
-
keyMapper
- a mapping function to produce keys -
valueMapper
- a mapping function to produce values -
mergeFunction
- 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 concurrent, unordered
Collector
which collects elements into aConcurrentMap
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:
-
toConcurrentMap(Function, Function)
,toConcurrentMap(Function, Function, BinaryOperator)
,toMap(Function, Function, BinaryOperator, Supplier)
summarizingInt
public static <T> Collector<T,?,IntSummaryStatistics> summarizingInt(ToIntFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a mapping function to apply to each element - Returns:
-
a
Collector
implementing the summary-statistics reduction - See Also:
-
summarizingDouble(ToDoubleFunction)
,summarizingLong(ToLongFunction)
summarizingLong
public static <T> Collector<T,?,LongSummaryStatistics> summarizingLong(ToLongFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- the mapping function to apply to each element - Returns:
-
a
Collector
implementing the summary-statistics reduction - See Also:
-
summarizingDouble(ToDoubleFunction)
,summarizingInt(ToIntFunction)
summarizingDouble
public static <T> Collector<T,?,DoubleSummaryStatistics> summarizingDouble(ToDoubleFunction<? super T> mapper)
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 input elements - Parameters:
-
mapper
- a mapping function to apply to each element - Returns:
-
a
Collector
implementing the summary-statistics reduction - See Also:
-
summarizingLong(ToLongFunction)
,summarizingInt(ToIntFunction)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.