added in API level 24

BaseStream

public interface BaseStream
implements AutoCloseable

java.util.stream.BaseStream<T, S extends java.util.stream.BaseStream<T, S>>


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.

Summary

Public methods

abstract void close()

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

abstract boolean isParallel()

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

abstract Iterator<T> iterator()

Returns an iterator for the elements of this stream.

abstract S onClose(Runnable closeHandler)

Returns an equivalent stream with an additional close handler.

abstract S parallel()

Returns an equivalent stream that is parallel.

abstract S sequential()

Returns an equivalent stream that is sequential.

abstract Spliterator<T> spliterator()

Returns a spliterator for the elements of this stream.

abstract S unordered()

Returns an equivalent stream that is unordered.

Inherited methods

Public methods

close

added in API level 24
void close ()

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

See also:

isParallel

added in API level 24
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
boolean true if this stream would execute in parallel if executed

iterator

added in API level 24
Iterator<T> iterator ()

Returns an iterator for the elements of this stream.

This is a terminal operation.

Returns
Iterator<T> the element iterator for this stream

onClose

added in API level 24
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 Runnable: A task to execute when the stream is closed

Returns
S a stream with a handler that is run if the stream is closed

parallel

added in API level 24
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
S a parallel stream

sequential

added in API level 24
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
S a sequential stream

spliterator

added in API level 24
Spliterator<T> spliterator ()

Returns a spliterator for the elements of this stream.

This is a terminal operation.

Returns
Spliterator<T> the element spliterator for this stream

unordered

added in API level 24
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
S an unordered stream