Java Stream: divide into two lists by boolean predicate

by

Collectors.partitioningBy:

Map<Boolean, List<Employee>> partitioned = 
    listOfEmployees.stream().collect(
        Collectors.partitioningBy(Employee::isActive));

The resulting map contains two lists, corresponding to whether or not the predicate was matched:

List<Employee> activeEmployees = partitioned.get(true);
List<Employee> formerEmployees = partitioned.get(false);

There are a couple of reasons to use partitioningBy over groupingBy (as suggested by Juan Carlos Mendoza):

Firstly, the parameter of groupingBy is a Function<Employee, Boolean> (in this case), and so there is a possibility of passing it a function which can return null, meaning there would be a 3rd partition if that function returns null for any of the employees. partitioningBy uses a Predicate<Employee>, so it can only ever return 2 partitions. which would result in a NullPointerException being thrown by the collector: whilst not documented explicitly, an exception is explicitly thrown for null keys, presumably because of the behavior of Map.computeIfAbsent that “If the function returns null no mapping is recorded”, meaning elements would otherwise be dropped silently from the output. (Thanks to lczapski for pointing this out).

Secondly, you get two lists (*) in the resulting map with partitioningBy; with groupingBy, you only get key/value pairs where elements map to the given key:

System.out.println(
    Stream.empty().collect(Collectors.partitioningBy(a -> false)));
// Output: {false=[], true=[]}

System.out.println(
    Stream.empty().collect(Collectors.groupingBy(a -> false)));
// Output: {}

(*) This behavior isn’t documented in the Java 8 Javadoc, but it was added for Java 9.

More Related Contents:

  1. Java 8 Distinct by property
  2. How to force max to return ALL maximum values in a Java Stream?
  3. Java 8: performance of Streams vs Collections
  4. Java 8 Nested (Multi level) group by
  5. Partition a Java 8 Stream
  6. Should I return a Collection or a Stream?
  7. What is difference between Collection.stream().forEach() and Collection.forEach()?
  8. Retrieving a List from a java.util.stream.Stream in Java 8
  9. How do I keep the iteration order of a List when using Collections.toMap() on a stream?
  10. How can I get a List from some class properties with Java 8 Stream?
  11. Why doesn’t java.util.Collection implement the new Stream interface?
  12. Does Java SE 8 have Pairs or Tuples?
  13. In Stream reduce method, must the identity always be 0 for sum and 1 for multiplication?
  14. what’s a good persistent collections framework for use in java?
  15. What Java 8 Stream.collect equivalents are available in the standard Kotlin library?
  16. Finding enum value with Java 8 Stream API
  17. Convert String array to Map using Java 8 Lambda expressions
  18. Is it possible to get next element in the Stream?
  19. Java 8 stream map to list of keys sorted by values
  20. How do I convert a Map to List in Java?
  21. Define a fixed-size list in Java
  22. Sum values from specific field of the objects in a list
  23. How to shuffle an ArrayList [duplicate]
  24. How can I generate a list or array of sequential integers in Java?
  25. Most efficient way to get the last element of a stream
  26. Why does findFirst() throw a NullPointerException if the first element it finds is null?
  27. Equivalent of Scala dropWhile
  28. JDK9 randomization on immutable sets and maps
  29. In what situations is the CopyOnWriteArrayList suitable? [duplicate]
  30. Purpose of third argument to ‘reduce’ function in Java 8 functional programming

Leave a Comment