In Java streams is peek really only for debugging?

by

The important thing you have to understand is that streams are driven by the terminal operation. The terminal operation determines whether all elements have to be processed or any at all. So collect is an operation that processes each item, whereas findAny may stop processing items once it encountered a matching element.

And count() may not process any elements at all when it can determine the size of the stream without processing the items. Since this is an optimization not made in Java 8, but which will be in Java 9, there might be surprises when you switch to Java 9 and have code relying on count() processing all items. This is also connected to other implementation-dependent details, e.g. even in Java 9, the reference implementation will not be able to predict the size of an infinite stream source combined with limit while there is no fundamental limitation preventing such prediction.

Since peek allows “performing the provided action on each element as elements are consumed from the resulting stream”, it does not mandate processing of elements but will perform the action depending on what the terminal operation needs. This implies that you have to use it with great care if you need a particular processing, e.g. want to apply an action on all elements. It works if the terminal operation is guaranteed to process all items, but even then, you must be sure that not the next developer changes the terminal operation (or you forget that subtle aspect).

Further, while streams guarantee to maintain the encounter order for a certain combination of operations even for parallel streams, these guarantees do not apply to peek. When collecting into a list, the resulting list will have the right order for ordered parallel streams, but the peek action may get invoked in an arbitrary order and concurrently.

So the most useful thing you can do with peek is to find out whether a stream element has been processed which is exactly what the API documentation says:

This method exists mainly to support debugging, where you want to see the elements as they flow past a certain point in a pipeline

More Related Contents:

  1. How to convert to Java 8 map grouping by Map [closed]
  2. Java 8 List into Map
  3. Java 8 Streams: multiple filters vs. complex condition
  4. Collection to stream to a new collection
  5. Java 8 stream reverse order
  6. In Java, what are the advantages of streams over loops? [closed]
  7. Stream and lazy evaluation
  8. Java 8 stream’s .min() and .max(): why does this compile?
  9. How do I keep the iteration order of a List when using Collections.toMap() on a stream?
  10. Files.walk(), calculate total size
  11. Java 8 Streams – collect vs reduce
  12. How can I get a List from some class properties with Java 8 Stream?
  13. Is it possible to use the Java 8 Stream API on Android API < 24?
  14. Simplest way to print an `IntStream` as a `String`
  15. Sort map by value using lambdas and streams
  16. Grouping by object value, counting and then setting group key by maximum object attribute
  17. Equivalent of Scala dropWhile
  18. Why does Stream.allMatch() return true for an empty stream?
  19. Modifying Objects within stream in Java8 while iterating
  20. Take every nth element from a Java 8 stream
  21. Static context cannot access non-static in Collectors
  22. What Java 8 Stream.collect equivalents are available in the standard Kotlin library?
  23. How to check if exists any duplicate in Java 8 Streams?
  24. Finding enum value with Java 8 Stream API
  25. Java 8, how can I implement a switch statement using streams?
  26. Picking elements of a list until condition is met with Java 8 Lambdas
  27. BigDecimal summary statistics
  28. Does collect operation on Stream close the stream and underlying resources?
  29. How to get multiple values from an object using a single stream operation?
  30. non-interference requirement on Java 8 streams

Leave a Comment