Top Description Constructors Methods
java.util.stream

public final Class StreamSupport

extends Object
Class Inheritance
Imports
java.util.Objects, .Spliterator, java.util.function.Supplier

Low-level utility methods for creating and manipulating streams.

This class is mostly for library writers presenting stream views of data structures; most static stream methods intended for end users are in the various Stream classes.

Since
1.8

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static DoubleStream

Returns:

a new sequential or parallel DoubleStream
doubleStream
(Spliterator.OfDouble
A Spliterator.OfDouble describing the stream elements
spliterator
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel DoubleStream from a Spliterator.OfDouble.

public static DoubleStream

Returns:

a new sequential or parallel DoubleStream
doubleStream
(Supplier<? extends Spliterator.OfDouble>
A Supplier of a Spliterator.OfDouble
supplier
,
int
Spliterator characteristics of the supplied Spliterator.OfDouble. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.
characteristics
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel DoubleStream from a Supplier of Spliterator.OfDouble.

public static IntStream

Returns:

a new sequential or parallel IntStream
intStream
(Spliterator.OfInt
a Spliterator.OfInt describing the stream elements
spliterator
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel IntStream from a Spliterator.OfInt.

public static IntStream

Returns:

a new sequential or parallel IntStream
intStream
(Supplier<? extends Spliterator.OfInt>
a Supplier of a Spliterator.OfInt
supplier
,
int
Spliterator characteristics of the supplied Spliterator.OfInt. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.
characteristics
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel IntStream from a Supplier of Spliterator.OfInt.

public static LongStream

Returns:

a new sequential or parallel LongStream
longStream
(Spliterator.OfLong
a Spliterator.OfLong describing the stream elements
spliterator
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel LongStream from a Spliterator.OfLong.

public static LongStream

Returns:

a new sequential or parallel LongStream
longStream
(Supplier<? extends Spliterator.OfLong>
a Supplier of a Spliterator.OfLong
supplier
,
int
Spliterator characteristics of the supplied Spliterator.OfLong. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.
characteristics
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel LongStream from a Supplier of Spliterator.OfLong.

public static <
the type of stream elements
T
>
Stream<T>

Returns:

a new sequential or parallel Stream
stream
(Spliterator<T>
a Spliterator describing the stream elements
spliterator
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel Stream from a Spliterator.

public static <
the type of stream elements
T
>
Stream<T>

Returns:

a new sequential or parallel Stream
stream
(Supplier<? extends Spliterator<T>>
a Supplier of a Spliterator
supplier
,
int
Spliterator characteristics of the supplied Spliterator. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.
characteristics
,
boolean
if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.
parallel
)

Creates a new sequential or parallel Stream from a Supplier of Spliterator.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

StreamSupportback to summary
private StreamSupport()

Method Detail

doubleStreamback to summary
public static DoubleStream doubleStream(Spliterator.OfDouble spliterator, boolean parallel)

Creates a new sequential or parallel DoubleStream from a Spliterator.OfDouble.

The spliterator is only traversed, split, or queried for estimated size after the terminal operation of the stream pipeline commences.

It is strongly recommended the spliterator report a characteristic of IMMUTABLE or CONCURRENT, or be late-binding. Otherwise, doubleStream(java.util.function.Supplier, int, boolean) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters
spliterator:Spliterator.OfDouble

A Spliterator.OfDouble describing the stream elements

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:DoubleStream

a new sequential or parallel DoubleStream

doubleStreamback to summary
public static DoubleStream doubleStream(Supplier<? extends Spliterator.OfDouble> supplier, int characteristics, boolean parallel)

Creates a new sequential or parallel DoubleStream from a Supplier of Spliterator.OfDouble.

The Supplier#get() method will be invoked on the supplier no more than once, and only after the terminal operation of the stream pipeline commences.

For spliterators that report a characteristic of IMMUTABLE or CONCURRENT, or that are late-binding, it is likely more efficient to use doubleStream(java.util.Spliterator.OfDouble, boolean) instead.

The use of a Supplier in this form provides a level of indirection that reduces the scope of potential interference with the source. Since the supplier is only invoked after the terminal operation commences, any modifications to the source up to the start of the terminal operation are reflected in the stream result. See Non-Interference for more details.

Parameters
supplier:Supplier<? extends Spliterator.OfDouble>

A Supplier of a Spliterator.OfDouble

characteristics:int

Spliterator characteristics of the supplied Spliterator.OfDouble. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:DoubleStream

a new sequential or parallel DoubleStream

See Also
doubleStream(java.util.Spliterator.OfDouble, boolean)
intStreamback to summary
public static IntStream intStream(Spliterator.OfInt spliterator, boolean parallel)

Creates a new sequential or parallel IntStream from a Spliterator.OfInt.

The spliterator is only traversed, split, or queried for estimated size after the terminal operation of the stream pipeline commences.

It is strongly recommended the spliterator report a characteristic of IMMUTABLE or CONCURRENT, or be late-binding. Otherwise, intStream(java.util.function.Supplier, int, boolean) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters
spliterator:Spliterator.OfInt

a Spliterator.OfInt describing the stream elements

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:IntStream

a new sequential or parallel IntStream

intStreamback to summary
public static IntStream intStream(Supplier<? extends Spliterator.OfInt> supplier, int characteristics, boolean parallel)

Creates a new sequential or parallel IntStream from a Supplier of Spliterator.OfInt.

The Supplier#get() method will be invoked on the supplier no more than once, and only after the terminal operation of the stream pipeline commences.

For spliterators that report a characteristic of IMMUTABLE or CONCURRENT, or that are late-binding, it is likely more efficient to use intStream(java.util.Spliterator.OfInt, boolean) instead.

The use of a Supplier in this form provides a level of indirection that reduces the scope of potential interference with the source. Since the supplier is only invoked after the terminal operation commences, any modifications to the source up to the start of the terminal operation are reflected in the stream result. See Non-Interference for more details.

Parameters
supplier:Supplier<? extends Spliterator.OfInt>

a Supplier of a Spliterator.OfInt

characteristics:int

Spliterator characteristics of the supplied Spliterator.OfInt. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:IntStream

a new sequential or parallel IntStream

See Also
intStream(java.util.Spliterator.OfInt, boolean)
longStreamback to summary
public static LongStream longStream(Spliterator.OfLong spliterator, boolean parallel)

Creates a new sequential or parallel LongStream from a Spliterator.OfLong.

The spliterator is only traversed, split, or queried for estimated size after the terminal operation of the stream pipeline commences.

It is strongly recommended the spliterator report a characteristic of IMMUTABLE or CONCURRENT, or be late-binding. Otherwise, longStream(java.util.function.Supplier, int, boolean) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters
spliterator:Spliterator.OfLong

a Spliterator.OfLong describing the stream elements

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:LongStream

a new sequential or parallel LongStream

longStreamback to summary
public static LongStream longStream(Supplier<? extends Spliterator.OfLong> supplier, int characteristics, boolean parallel)

Creates a new sequential or parallel LongStream from a Supplier of Spliterator.OfLong.

The Supplier#get() method will be invoked on the supplier no more than once, and only after the terminal operation of the stream pipeline commences.

For spliterators that report a characteristic of IMMUTABLE or CONCURRENT, or that are late-binding, it is likely more efficient to use longStream(java.util.Spliterator.OfLong, boolean) instead.

The use of a Supplier in this form provides a level of indirection that reduces the scope of potential interference with the source. Since the supplier is only invoked after the terminal operation commences, any modifications to the source up to the start of the terminal operation are reflected in the stream result. See Non-Interference for more details.

Parameters
supplier:Supplier<? extends Spliterator.OfLong>

a Supplier of a Spliterator.OfLong

characteristics:int

Spliterator characteristics of the supplied Spliterator.OfLong. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:LongStream

a new sequential or parallel LongStream

See Also
longStream(java.util.Spliterator.OfLong, boolean)
streamback to summary
public static <T> Stream<T> stream(Spliterator<T> spliterator, boolean parallel)

Creates a new sequential or parallel Stream from a Spliterator.

The spliterator is only traversed, split, or queried for estimated size after the terminal operation of the stream pipeline commences.

It is strongly recommended the spliterator report a characteristic of IMMUTABLE or CONCURRENT, or be late-binding. Otherwise, stream(java.util.function.Supplier, int, boolean) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters
<T>
the type of stream elements
spliterator:Spliterator<T>

a Spliterator describing the stream elements

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:Stream<T>

a new sequential or parallel Stream

streamback to summary
public static <T> Stream<T> stream(Supplier<? extends Spliterator<T>> supplier, int characteristics, boolean parallel)

Creates a new sequential or parallel Stream from a Supplier of Spliterator.

The Supplier#get() method will be invoked on the supplier no more than once, and only after the terminal operation of the stream pipeline commences.

For spliterators that report a characteristic of IMMUTABLE or CONCURRENT, or that are late-binding, it is likely more efficient to use stream(java.util.Spliterator, boolean) instead.

The use of a Supplier in this form provides a level of indirection that reduces the scope of potential interference with the source. Since the supplier is only invoked after the terminal operation commences, any modifications to the source up to the start of the terminal operation are reflected in the stream result. See Non-Interference for more details.

Parameters
<T>
the type of stream elements
supplier:Supplier<? extends Spliterator<T>>

a Supplier of a Spliterator

characteristics:int

Spliterator characteristics of the supplied Spliterator. The characteristics must be equal to supplier.get().characteristics(), otherwise undefined behavior may occur when terminal operation commences.

parallel:boolean

if true then the returned stream is a parallel stream; if false the returned stream is a sequential stream.

Returns:Stream<T>

a new sequential or parallel Stream

See Also
stream(java.util.Spliterator, boolean)