public interface IntStream
filter
and map
, and
consuming operations, such as forEach
, findFirst
, and iterator
. Once an operation has been performed on a stream, it
is considered consumed and no longer usable for other operations.
For sequential stream pipelines, all operations are performed in the encounter order of the pipeline source, if the pipeline source has a defined encounter order.
For parallel stream pipelines, unless otherwise specified, intermediate stream operations preserve the encounter order of their source, and terminal operations respect the encounter order of their source, if the source has an encounter order.
iterator()
or spliterator()
operations to
perform a controlled traversal.
Unless otherwise noted, passing a null
argument to any stream
method may result in a NullPointerException
.
Modifier and Type  Method and Description 

boolean 
allMatch(IntPredicate predicate)
Returns whether all elements of this stream match the provided
predicate.

boolean 
anyMatch(IntPredicate predicate)
Returns whether any elements of this stream match the provided
predicate.

OptionalDouble 
average()
Returns an
OptionalDouble describing the average of elements of this
stream, or an empty optional if this stream is empty. 
Stream<Integer> 
boxed()
Returns a
Stream consisting of the elements of this stream,
boxed to Integer . 
<R> R 
collect(Supplier<R> resultFactory,
ObjIntConsumer<R> accumulator,
BiConsumer<R,R> combiner)
Performs a mutable
reduction operation on the elements of this stream.

long 
count()
Returns the count of elements in this stream.

IntStream 
distinct()
Produces a stream consisting of the distinct elements of this stream.

DoubleStream 
doubles()
Returns a
DoubleStream consisting of the elements of this stream,
converted to double . 
IntStream 
filter(IntPredicate predicate)
Produces a stream consisting of the elements of this stream that match
the given predicate.

OptionalInt 
findAny()
Returns an
OptionalInt describing some element of the stream, or an
empty OptionalInt if the stream is empty. 
OptionalInt 
findFirst()
Returns an
OptionalInt describing the first element of this stream
(in the encounter order), or an empty OptionalInt if the stream is
empty. 
IntStream 
flatMap(FlatMapper.OfIntToInt mapper)
Produces a stream consisting of the results of replacing each
element of this stream with zero or more transformed values, according
to the transformation encoded in the provided
FlatMapper.OfIntToInt . 
IntStream 
flatMap(IntFunction<? extends IntStream> mapper)
Produces a stream consisting of the results of replacing each
element of this stream with the contents of the stream
produced by applying the provided function to each element.

void 
forEach(IntConsumer consumer)
Performs an operation for each element of this stream.

void 
forEachOrdered(IntConsumer consumer)
Performs an operation for each element of this stream, guaranteeing that
each element is processed in encounter order for streams that have a
defined encounter order.

boolean 
isParallel()
Returns whether this stream, when executed, will execute in parallel.

PrimitiveIterator.OfInt 
iterator()
Returns an iterator for the elements of this stream.

IntStream 
limit(long maxSize)
Produces a stream consisting of the elements of this stream,
truncated to be no longer than
maxSize in length. 
LongStream 
longs()
Returns a
LongStream consisting of the elements of this stream,
converted to long . 
IntStream 
map(IntUnaryOperator mapper)
Produces a stream consisting of the results of applying the given
function to the elements of this stream.

DoubleStream 
mapToDouble(IntToDoubleFunction mapper)
Produces a
DoubleStream consisting of the results of applying
the given function to the elements of this stream. 
LongStream 
mapToLong(IntToLongFunction mapper)
Produces a
LongStream consisting of the results of applying
the given function to the elements of this stream. 
<U> Stream<U> 
mapToObj(IntFunction<U> mapper)
Produces an objectvalued
Stream consisting of the results of
applying the given function to the elements of this stream. 
OptionalInt 
max()
Returns an
OptionalInt describing the maximal element of this
stream, or an empty optional if this stream is empty. 
OptionalInt 
min()
Returns an
OptionalInt describing the minimal element of this
stream, or an empty optional if this stream is empty. 
boolean 
noneMatch(IntPredicate predicate)
Returns whether no elements of this stream match the provided
predicate.

IntStream 
parallel()
Produces an equivalent stream that is parallel.

IntStream 
peek(IntConsumer consumer)
Produces a stream consisting of the elements of this stream, additionally
performing the provided action on each element as elements are consumed
from the resulting stream.

OptionalInt 
reduce(IntBinaryOperator op)
Performs a reduction on the
elements of this stream, using an
associative accumulation
function, and return an
OptionalInt describing the reduced value,
if any. 
int 
reduce(int identity,
IntBinaryOperator op)
Performs a reduction on the
elements of this stream, using the provided identity value and
an associative
accumulation function, and return the reduced value.

IntStream 
sequential()
Produces an equivalent stream that is sequential.

IntStream 
sorted()
Produces a stream consisting of the elements of this stream in sorted
order.

Spliterator.OfInt 
spliterator()
Returns a spliterator for the elements of this stream.

IntStream 
substream(long startingOffset)
Produces a stream consisting of the elements of this stream,
discarding the first
startingOffset elements. 
IntStream 
substream(long startingOffset,
long endingOffset)
Produces a stream consisting of the elements of this stream,
discarding the first
startingOffset elements, and truncating the
remainder to be no longer than maxSize in length. 
int 
sum()
Returns the sum of elements in this stream.

IntSummaryStatistics 
summaryStatistics()
Returns an
IntSummaryStatistics describing various
summary data about the elements of this stream. 
int[] 
toArray()
Produces an array containing the elements of this stream.

IntStream filter(IntPredicate predicate)
This is an intermediate operation.
predicate
 A
noninterfering, stateless predicate to apply to
each element to determine if it should be includedIntStream map(IntUnaryOperator mapper)
This is an intermediate operation.
mapper
 a
noninterfering, stateless function to be applied to
each element<U> Stream<U> mapToObj(IntFunction<U> mapper)
Stream
consisting of the results of
applying the given function to the elements of this stream.
This is an intermediate operation.
mapper
 A
noninterfering, stateless function to be applied to
each elementLongStream mapToLong(IntToLongFunction mapper)
LongStream
consisting of the results of applying
the given function to the elements of this stream.
This is an intermediate operation.
mapper
 A
noninterfering, stateless function to be applied to
each elementDoubleStream mapToDouble(IntToDoubleFunction mapper)
DoubleStream
consisting of the results of applying
the given function to the elements of this stream.
This is an intermediate operation.
mapper
 A
noninterfering, stateless function to be applied to
each elementIntStream flatMap(IntFunction<? extends IntStream> mapper)
This is an intermediate operation.
mapper
 A
noninterfering, stateless function to be applied to
each element which produces an IntStream
of new
valuesStream.flatMap(Function)
This implementation is likely to be less efficient than the other
form of flatMap(FlatMapper.OfIntToInt)
, and is provided for
convenience.
IntStream flatMap(FlatMapper.OfIntToInt mapper)
FlatMapper.OfIntToInt
.
This is an intermediate operation.
mapper
 A
noninterfering, stateless FlatMapper.OfIntToInt
that transforms each element into zero or more resulting
valuesflatMap
is usually less convenient to use than the
flatMap(IntFunction)
form, but is often considerably more
efficient because it eliminates the overhead of stream construction
and traversal.IntStream distinct()
This is a stateful intermediate operation.
IntStream sorted()
This is a stateful intermediate operation.
IntStream peek(IntConsumer consumer)
This is an intermediate operation.
For parallel stream pipelines, the action may be called at whatever time and in whatever thread the element is made available by the upstream operation. If the action modifies shared state, it is responsible for providing the required synchronization.
consumer
 A
noninterfering action to perform on the elements as
they are consumed from the streamlist.stream() .filter(filteringFunction) .peek(e > {System.out.println("Filtered value: " + e); }); .map(mappingFunction) .peek(e > {System.out.println("Mapped value: " + e); }); .collect(Collectors.toIntSummaryStastistics());
IntStream limit(long maxSize)
maxSize
in length.
maxSize
 the number of elements the stream should be limited toIntStream substream(long startingOffset)
startingOffset
elements.
This is a stateful intermediate operation.
startingOffset
 the number of leading elements to be skippedIntStream substream(long startingOffset, long endingOffset)
startingOffset
elements, and truncating the
remainder to be no longer than maxSize
in length.
startingOffset
 the starting position of the substream, inclusiveendingOffset
 the ending position of the substream, exclusivevoid forEach(IntConsumer consumer)
This is a terminal operation.
For parallel stream pipelines, this operation does not guarantee to respect the encounter order of the stream, as doing so would sacrifice the benefit of parallelism. For any given element, the action may be performed at whatever time and in whatever thread the library chooses. If the operation accesses shared state, it is responsible for providing the required synchronization.
consumer
 A
noninterfering action to perform on the elementsvoid forEachOrdered(IntConsumer consumer)
This is a terminal operation.
consumer
 A
noninterfering action to perform on the elementsforEach(IntConsumer)
int[] toArray()
This is a terminal operation.
int reduce(int identity, IntBinaryOperator op)
int result = identity; for (int element : this stream) result = accumulator.apply(result, element) return result;but is not constrained to execute sequentially.
The identity
value must be an identity for the accumulator
function. This means that for all x
,
accumulator.apply(identity, x)
is equal to x
.
The accumulator
function must be an
associative function.
This is a terminal operation.
identity
 The identity value for the accumulating functionop
 An associative
noninterfering,
stateless function for combining two valuessum()
,
min()
,
max()
,
average()
int sum = integers.reduce(0, (a, b) > a+b);or more compactly:
int sum = integers.reduce(0, Integer::sum);
While this may seem a more roundabout way to perform an aggregation compared to simply mutating a running total in a loop, reduction operations parallelize more gracefully, without needing additional synchronization and with greatly reduced risk of data races.
OptionalInt reduce(IntBinaryOperator op)
OptionalInt
describing the reduced value,
if any. This is equivalent to:
boolean foundAny = false; int result = null; for (int element : this stream) { if (!foundAny) { foundAny = true; result = element; } else result = accumulator.apply(result, element) return foundAny ? OptionalInt.of(result) : OptionalInt.empty();but is not constrained to execute sequentially.
The accumulator
function must be an
associative function.
This is a terminal operation.
op
 An associative
noninterfering,
stateless function for combining two valuesreduce(int, IntBinaryOperator)
<R> R collect(Supplier<R> resultFactory, ObjIntConsumer<R> accumulator, BiConsumer<R,R> combiner)
ArrayList
, and elements are incorporated by updating
the state of the result, rather than by replacing the result. This
produces a result equivalent to:
R result = resultFactory.get(); for (int element : this stream) accumulator.accept(result, element); return result;Like
reduce(int, IntBinaryOperator)
, collect
operations
can be parallelized without requiring additional sychronization.
This is a terminal operation.
R
 Type of the resultresultFactory
 Function that creates a new result container.
For a parallel execution, this function may be
called multiple times and must return a fresh value
each time.accumulator
 An associative
noninterfering,
stateless function for incorporating an additional
element into a resultcombiner
 An associative
noninterfering,
stateless function for combining two values, which
must be compatible with the accumulator functionStream.collect(Supplier, BiConsumer, BiConsumer)
int sum()
return reduce(0, Integer::sum);
OptionalInt min()
OptionalInt
describing the minimal element of this
stream, or an empty optional if this stream is empty. This is a special
case of a reduction
and is equivalent to:
return reduce(Integer::min);
OptionalInt
OptionalInt max()
OptionalInt
describing the maximal element of this
stream, or an empty optional if this stream is empty. This is a special
case of a reduction
and is equivalent to:
return reduce(Integer::max);
OptionalInt
long count()
return mapToLong(e > 1L).sum();
OptionalDouble average()
OptionalDouble
describing the average of elements of this
stream, or an empty optional if this stream is empty. This is a special
case of a reduction.OptionalDouble
IntSummaryStatistics summaryStatistics()
IntSummaryStatistics
describing various
summary data about the elements of this stream. This is a special
case of a reduction.IntSummaryStatistics
describing various
summary data about the elements of this streamboolean anyMatch(IntPredicate predicate)
This is a shortcircuiting terminal operation.
predicate
 A noninterfering,
stateless predicate to apply to elements of this
streamboolean allMatch(IntPredicate predicate)
This is a shortcircuiting terminal operation.
predicate
 A noninterfering,
stateless predicate to apply to elements of this streamboolean noneMatch(IntPredicate predicate)
This is a shortcircuiting terminal operation.
predicate
 A noninterfering,
stateless predicate to apply to elements of this streamOptionalInt findFirst()
OptionalInt
describing the first element of this stream
(in the encounter order), or an empty OptionalInt
if the stream is
empty.
This is a shortcircuiting terminal operation.
OptionalInt
describing the first element of this stream,
or an empty OptionalInt
if the stream is emptyOptionalInt findAny()
OptionalInt
describing some element of the stream, or an
empty OptionalInt
if the stream is empty.
This is a shortcircuiting terminal operation.
The behavior of this operation is explicitly nondeterministic; it is
free to select any element in the stream. This is to allow for maximal
performance in parallel operations; the cost is that multiple invocations
on the same source may not return the same result. (If the first element
in the encounter order is desired, use findFirst()
instead.)
OptionalInt
describing some element of this stream, or an
empty OptionalInt
if the stream is emptyfindFirst()
LongStream longs()
LongStream
consisting of the elements of this stream,
converted to long
.LongStream
consisting of the elements of this stream,
converted to long
DoubleStream doubles()
DoubleStream
consisting of the elements of this stream,
converted to double
.DoubleStream
consisting of the elements of this stream,
converted to double
Stream<Integer> boxed()
Stream
consisting of the elements of this stream,
boxed to Integer
.Stream
consistent of the elements of this stream,
boxed to Integer
IntStream sequential()
This is a stateful intermediate operation.
IntStream parallel()
This is a stateful intermediate operation.
PrimitiveIterator.OfInt iterator()
This is a terminal operation.
Spliterator.OfInt spliterator()
This is a terminal operation.
boolean isParallel()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developertargeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT eab00