1. Description
2. Method Summary
3. Method Details
   1. iterator()
   2. spliterator()
   3. isParallel()
   4. sequential()
   5. parallel()
   6. unordered()
   7. onClose(Runnable)
   8. close()

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  void

  close()

  Closes this stream, causing all close handlers for this stream pipeline to be called.

  boolean

  isParallel()

  Returns whether this stream, if a terminal operation were to be executed, would execute in parallel.

  Iterator<T>

  iterator()

  Returns an iterator for the elements of this stream.

  S

  onClose(Runnable closeHandler)

  Returns an equivalent stream with an additional close handler.

  S

  parallel()

  Returns an equivalent stream that is parallel.

  S

  sequential()

  Returns an equivalent stream that is sequential.

  Spliterator<T>

  spliterator()

  Returns a spliterator for the elements of this stream.

  S

  unordered()

  Returns an equivalent stream that is unordered.

• Method Details

  • iterator

    Iterator<T> iterator()

    Returns an iterator for the elements of this stream.

    This is a terminal operation.

    API Note: This operation is provided as an "escape hatch" to enable arbitrary client-controlled pipeline traversals in the event that the existing operations are not sufficient to the task. Returns: the element iterator for this stream

  • spliterator

    Spliterator<T> spliterator()

    Returns a spliterator for the elements of this stream.

    This is a terminal operation.

    API Note: This operation is provided as an "escape hatch" to enable arbitrary client-controlled pipeline traversals in the event that the existing operations are not sufficient to the task.

    The returned spliterator should report the set of characteristics derived from the stream pipeline (namely the characteristics derived from the stream source spliterator and the intermediate operations). Implementations may report a sub-set of those characteristics. For example, it may be too expensive to compute the entire set for some or all possible stream pipelines.

    Returns: the element spliterator for this stream

  • isParallel

    boolean isParallel()

    Returns whether this stream, if a terminal operation were to be executed, would execute in parallel. Calling this method after invoking an terminal stream operation method may yield unpredictable results.

    Returns: true if this stream would execute in parallel if executed

  • sequential

    S sequential()

    Returns an equivalent stream that is sequential. May return itself, either because the stream was already sequential, or because the underlying stream state was modified to be sequential.

    This is an intermediate operation.

    Returns: a sequential stream

  • parallel

    S parallel()

    Returns an equivalent stream that is parallel. May return itself, either because the stream was already parallel, or because the underlying stream state was modified to be parallel.

    This is an intermediate operation.

    Returns: a parallel stream

  • unordered

    S unordered()

    Returns an equivalent stream that is unordered. May return itself, either because the stream was already unordered, or because the underlying stream state was modified to be unordered.

    This is an intermediate operation.

    Returns: an unordered stream

  • onClose

    S onClose(Runnable closeHandler)

    Returns an equivalent stream with an additional close handler. Close handlers are run when the close() method is called on the stream, and are executed in the order they were added. All close handlers are run, even if earlier close handlers throw exceptions. If any close handler throws an exception, the first exception thrown will be relayed to the caller of close(), with any remaining exceptions added to that exception as suppressed exceptions (unless one of the remaining exceptions is the same exception as the first exception, since an exception cannot suppress itself.) May return itself.

    This is an intermediate operation.

    Parameters: closeHandler - A task to execute when the stream is closed Returns: a stream with a handler that is run if the stream is closed

  • close

    void close()

    Closes this stream, causing all close handlers for this stream pipeline to be called.

    Specified by: close in interface AutoCloseable See Also:

    • AutoCloseable.close()

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.