Added in API level 24

BaseStream

interface BaseStream<T : Any!, S : BaseStream<T, S>!> : AutoCloseable
java.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:

<code>int sum = widgets.stream()
                       .filter(w -&gt; w.getColor() == RED)
                       .mapToInt(w -&gt; w.getWeight())
                       .sum();
  </code>
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.

Summary

Public methods
abstract Unit

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

abstract Boolean

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

abstract MutableIterator<T>!

Returns an iterator for the elements of this stream.

abstract S
onClose(closeHandler: Runnable!)

Returns an equivalent stream with an additional close handler.

abstract S

Returns an equivalent stream that is parallel.

abstract S

Returns an equivalent stream that is sequential.

abstract Spliterator<T>!

Returns a spliterator for the elements of this stream.

abstract S

Returns an equivalent stream that is unordered.

Public methods

close

Added in API level 24
abstract fun close(): Unit

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

Exceptions
java.lang.Exception if this resource cannot be closed

isParallel

Added in API level 24
abstract fun isParallel(): 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.

Return
Boolean true if this stream would execute in parallel if executed

iterator

Added in API level 24
abstract fun iterator(): MutableIterator<T>!

Returns an iterator for the elements of this stream.

This is a terminal operation.

Return
MutableIterator<T>! the element iterator for this stream

onClose

Added in API level 24
abstract fun onClose(closeHandler: Runnable!): 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.

Parameters
closeHandler Runnable!: A task to execute when the stream is closed
Return
S a stream with a handler that is run if the stream is closed

parallel

Added in API level 24
abstract fun parallel(): 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.

Return
S a parallel stream

sequential

Added in API level 24
abstract fun sequential(): 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.

Return
S a sequential stream

spliterator

Added in API level 24
abstract fun spliterator(): Spliterator<T>!

Returns a spliterator for the elements of this stream.

This is a terminal operation.

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.

Return
Spliterator<T>! the element spliterator for this stream

unordered

Added in API level 24
abstract fun unordered(): 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.

Return
S an unordered stream