compact1, compact2, compact3

java.util.stream

Class StreamSupport

java.lang.Object

java.util.stream.StreamSupport

public class StreamSupport
extends Object

Low-level utility methods for creating and manipulating streams.

This class is mostly for library writers presenting stream views of their data structures; most static stream methods for end users are in <code>Streams</code>.

Unless otherwise stated, streams are created as sequential streams. A sequential stream can be transformed into a parallel stream by calling the parallel() method on the created stream.

Since:

1.8

Constructor Summary

Constructors

Constructor and Description
StreamSupport()

Method Summary

Modifier and Type	Method and Description
static DoubleStream	doubleParallelStream(Spliterator.OfDouble spliterator) Creates a new parallel DoubleStream from a Spliterator.OfDouble.
static DoubleStream	doubleParallelStream(Supplier<? extends Spliterator.OfDouble> supplier, int characteristics) Creates a new parallel DoubleStream from a Supplier of Spliterator.OfDouble.
static DoubleStream	doubleStream(Spliterator.OfDouble spliterator) Creates a new sequential DoubleStream from a Spliterator.OfDouble.
static DoubleStream	doubleStream(Supplier<? extends Spliterator.OfDouble> supplier, int characteristics) Creates a new sequential DoubleStream from a Supplier of Spliterator.OfDouble.
static IntStream	intParallelStream(Spliterator.OfInt spliterator) Creates a new parallel IntStream from a Spliterator.OfInt.
static IntStream	intParallelStream(Supplier<? extends Spliterator.OfInt> supplier, int characteristics) Creates a new parallel IntStream from a Supplier of Spliterator.OfInt.
static IntStream	intStream(Spliterator.OfInt spliterator) Creates a new sequential IntStream from a Spliterator.OfInt.
static IntStream	intStream(Supplier<? extends Spliterator.OfInt> supplier, int characteristics) Creates a new sequential IntStream from a Supplier of Spliterator.OfInt.
static LongStream	longParallelStream(Spliterator.OfLong spliterator) Creates a new parallel LongStream from a Spliterator.OfLong.
static LongStream	longParallelStream(Supplier<? extends Spliterator.OfLong> supplier, int characteristics) Creates a new parallel LongStream from a Supplier of Spliterator.OfLong.
static LongStream	longStream(Spliterator.OfLong spliterator) Creates a new sequential LongStream from a Spliterator.OfLong.
static LongStream	longStream(Supplier<? extends Spliterator.OfLong> supplier, int characteristics) Creates a new sequential LongStream from a Supplier of Spliterator.OfLong.
static <T> Stream<T>	parallelStream(Spliterator<T> spliterator) Creates a new parallel Stream from a Spliterator.
static <T> Stream<T>	parallelStream(Supplier<? extends Spliterator<T>> supplier, int characteristics) Creates a new parallel Stream from a Supplier of Spliterator.
static <T> Stream<T>	stream(Spliterator<T> spliterator) Creates a new sequential Stream from a Spliterator.
static <T> Stream<T>	stream(Supplier<? extends Spliterator<T>> supplier, int characteristics) Creates a new sequential Stream from a Supplier of Spliterator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamSupport

public StreamSupport()

Method Detail

stream

public static <T> Stream<T> stream(Spliterator<T> spliterator)

Creates a new sequential 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(Supplier, int) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Type Parameters:

T - the type of stream elements

Parameters:

spliterator - a Spliterator describing the stream elements

Returns:

a new sequential Stream

parallelStream

public static <T> Stream<T> parallelStream(Spliterator<T> spliterator)

Creates a new 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(Supplier, int) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Type Parameters:

T - the type of stream elements

Parameters:

spliterator - a Spliterator describing the stream elements

Returns:

a new parallel Stream

stream

public static <T> Stream<T> stream(Supplier<? extends Spliterator<T>> supplier,
                                   int characteristics)

Creates a new sequential Stream from a Supplier of Spliterator.

The Supplier.get() method will be invoked on the supplier no more than once, and 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) 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.

Type Parameters:

T - the type of stream elements

Parameters:

supplier - a Supplier of a Spliterator

characteristics - Spliterator characteristics of the supplied Spliterator. The characteristics must be equal to source.get().getCharacteristics().

Returns:

a new sequential Stream

See Also:

stream(Spliterator)

parallelStream

public static <T> Stream<T> parallelStream(Supplier<? extends Spliterator<T>> supplier,
                                           int characteristics)

Creates a new parallel Stream from a Supplier of Spliterator.

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator) 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.

Type Parameters:

T - the type of stream elements

Parameters:

supplier - a Supplier of a Spliterator

characteristics - Spliterator characteristics of the supplied Spliterator. The characteristics must be equal to source.get().getCharacteristics()

Returns:

a new parallel Stream

See Also:

parallelStream(Spliterator)

intStream

public static IntStream intStream(Spliterator.OfInt spliterator)

Creates a new sequential 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, stream(Supplier, int)} should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters:

spliterator - a Spliterator.OfInt describing the stream elements

Returns:

a new sequential IntStream

intParallelStream

public static IntStream intParallelStream(Spliterator.OfInt spliterator)

Creates a new parallel IntStream from a Spliterator.OfInt.

he 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(Supplier, int)} should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters:

spliterator - a Spliterator.OfInt describing the stream elements

Returns:

a new parallel IntStream

intStream

public static IntStream intStream(Supplier<? extends Spliterator.OfInt> supplier,
                                  int characteristics)

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

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator.OfInt) 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 - a Supplier of a Spliterator.OfInt

characteristics - Spliterator characteristics of the supplied Spliterator.OfInt. The characteristics must be equal to source.get().getCharacteristics()

Returns:

a new sequential IntStream

See Also:

intStream(Spliterator.OfInt)

intParallelStream

public static IntStream intParallelStream(Supplier<? extends Spliterator.OfInt> supplier,
                                          int characteristics)

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

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator.OfInt) 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 - a Supplier of a Spliterator.OfInt

characteristics - Spliterator characteristics of the supplied Spliterator.OfInt. The characteristics must be equal to source.get().getCharacteristics()

Returns:

a new parallel IntStream

See Also:

intParallelStream(Spliterator.OfInt)

longStream

public static LongStream longStream(Spliterator.OfLong spliterator)

Creates a new sequential 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, stream(Supplier, int) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters:

spliterator - a Spliterator.OfLong describing the stream elements

Returns:

a new sequential LongStream

longParallelStream

public static LongStream longParallelStream(Spliterator.OfLong spliterator)

Creates a new 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, stream(Supplier, int) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters:

spliterator - a Spliterator.OfLong describing the stream elements

Returns:

a new parallel LongStream

longStream

public static LongStream longStream(Supplier<? extends Spliterator.OfLong> supplier,
                                    int characteristics)

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

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator.OfLong) 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 - a Supplier of a Spliterator.OfLong

characteristics - Spliterator characteristics of the supplied Spliterator.OfLong. The characteristics must be equal to source.get().getCharacteristics()

Returns:

a new sequential LongStream

See Also:

longStream(Spliterator.OfLong)

longParallelStream

public static LongStream longParallelStream(Supplier<? extends Spliterator.OfLong> supplier,
                                            int characteristics)

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

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator.OfLong) 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 - A Supplier of a Spliterator.OfLong

characteristics - Spliterator characteristics of the supplied Spliterator.OfLong. The characteristics must be equal to source.get().getCharacteristics()

Returns:

A new parallel LongStream

See Also:

longParallelStream(Spliterator.OfLong)

doubleStream

public static DoubleStream doubleStream(Spliterator.OfDouble spliterator)

Creates a new sequential 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, stream(Supplier, int) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters:

spliterator - A Spliterator.OfDouble describing the stream elements

Returns:

A new sequential DoubleStream

doubleParallelStream

public static DoubleStream doubleParallelStream(Spliterator.OfDouble spliterator)

Creates a new 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, stream(Supplier, int) should be used to reduce the scope of potential interference with the source. See Non-Interference for more details.

Parameters:

spliterator - A Spliterator.OfDouble describing the stream elements

Returns:

A new parallel DoubleStream

doubleStream

public static DoubleStream doubleStream(Supplier<? extends Spliterator.OfDouble> supplier,
                                        int characteristics)

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

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator.OfDouble) 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 - A Supplier of a Spliterator.OfDouble

characteristics - Spliterator characteristics of the supplied Spliterator.OfDouble. The characteristics must be equal to source.get().getCharacteristics()

Returns:

A new sequential DoubleStream

See Also:

doubleStream(Spliterator.OfDouble)

doubleParallelStream

public static DoubleStream doubleParallelStream(Supplier<? extends Spliterator.OfDouble> supplier,
                                                int characteristics)

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

The Supplier.get() method will be invoked on the supplier no more than once, and 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(Spliterator.OfDouble) 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 - a Supplier of a Spliterator.OfDouble

characteristics - Spliterator characteristics of the supplied Spliterator.OfDouble. The characteristics must be equal to source.get().getCharacteristics()

Returns:

a new parallel DoubleStream

See Also:

doubleParallelStream(Spliterator.OfDouble)