Liking cljdoc? Tell your friends :D

jdk.util.stream.BaseStream

Base interface for streams, which are sequences of elements supporting sequential and parallel aggregate operations. The following example illustrates an aggregate operation using the stream types Stream and IntStream, computing the sum of the weights of the red widgets:

int sum = widgets.stream()
                 .filter(w -> w.getColor() == RED)
                 .mapToInt(w -> w.getWeight())
                 .sum();

See the class documentation for Stream and the package documentation for java.util.stream for additional specification of streams, stream operations, stream pipelines, and parallelism, which governs the behavior of all stream types.

Base interface for streams, which are sequences of elements supporting
sequential and parallel aggregate operations.  The following example
illustrates an aggregate operation using the stream types Stream
and IntStream, computing the sum of the weights of the red widgets:



    int sum = widgets.stream()
                     .filter(w -> w.getColor() == RED)
                     .mapToInt(w -> w.getWeight())
                     .sum();

See the class documentation for Stream and the package documentation
for java.util.stream for additional
specification of streams, stream operations, stream pipelines, and
parallelism, which governs the behavior of all stream types.
raw docstring

closeclj

(close this)

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

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

iteratorclj

(iterator this)

Returns an iterator for the elements of this stream.

This is a terminal operation.

returns: the element iterator for this stream - java.util.Iterator<T>

Returns an iterator for the elements of this stream.

 This is a terminal
 operation.

returns: the element iterator for this stream - `java.util.Iterator<T>`
raw docstring

on-closeclj

(on-close this close-handler)

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.

close-handler - A task to execute when the stream is closed - java.lang.Runnable

returns: a stream with a handler that is run if the stream is closed - S

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.

close-handler - A task to execute when the stream is closed - `java.lang.Runnable`

returns: a stream with a handler that is run if the stream is closed - `S`
raw docstring

parallelclj

(parallel this)

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 - S

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 - `S`
raw docstring

parallel?clj

(parallel? this)

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 - boolean

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 - `boolean`
raw docstring

sequentialclj

(sequential this)

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 - S

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 - `S`
raw docstring

spliteratorclj

(spliterator this)

Returns a spliterator for the elements of this stream.

This is a terminal operation.

returns: the element spliterator for this stream - java.util.Spliterator<T>

Returns a spliterator for the elements of this stream.

 This is a terminal
 operation.

returns: the element spliterator for this stream - `java.util.Spliterator<T>`
raw docstring

unorderedclj

(unordered this)

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 - S

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 - `S`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close