static interface
Stream.Builder<T>
A mutable builder for a Stream
.
boolean
allMatch(Predicate<? super T> predicate)
Returns whether all elements of this stream match the provided predicate.
boolean
anyMatch(Predicate<? super T> predicate)
Returns whether any elements of this stream match the provided predicate.
static <T> Stream.Builder<T>
builder()
Returns a builder for a Stream
.
<R> R
collect(Supplier<R> supplier, BiConsumer<R,? super T> accumulator, BiConsumer<R,R> combiner)
Performs a
mutable reductionoperation on the elements of this stream.
<R,A>
R
collect(Collector<? super T,A,R> collector)
Performs a
mutable reductionoperation on the elements of this stream using a
Collector
.
static <T> Stream<T>
concat(Stream<? extends T> a, Stream<? extends T> b)
Creates a lazily concatenated stream whose elements are all the elements of the first stream followed by all the elements of the second stream.
long
count()
Returns the count of elements in this stream.
Stream<T>
distinct()
Returns a stream consisting of the distinct elements (according to
Object.equals(Object)
) of this stream.
default Stream<T>
dropWhile(Predicate<? super T> predicate)
Returns, if this stream is ordered, a stream consisting of the remaining elements of this stream after dropping the longest prefix of elements that match the given predicate.
static <T> Stream<T>
empty()
Returns an empty sequential Stream
.
Stream<T>
filter(Predicate<? super T> predicate)
Returns a stream consisting of the elements of this stream that match the given predicate.
Optional<T>
findAny()
Returns an
Optional
describing some element of the stream, or an empty
Optional
if the stream is empty.
Optional<T>
findFirst()
Returns an
Optional
describing the first element of this stream, or an empty
Optional
if the stream is empty.
<R> Stream<R>
flatMap(Function<? super T,? extends Stream<? extends R>> mapper)
Returns a stream consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element.
DoubleStream
flatMapToDouble(Function<? super T,? extends DoubleStream> mapper)
Returns an DoubleStream
consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element.
IntStream
flatMapToInt(Function<? super T,? extends IntStream> mapper)
Returns an IntStream
consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element.
LongStream
flatMapToLong(Function<? super T,? extends LongStream> mapper)
Returns an LongStream
consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element.
void
forEach(Consumer<? super T> action)
Performs an action for each element of this stream.
void
forEachOrdered(Consumer<? super T> action)
Performs an action for each element of this stream, in the encounter order of the stream if the stream has a defined encounter order.
static <T> Stream<T>
generate(Supplier<? extends T> s)
Returns an infinite sequential unordered stream where each element is generated by the provided Supplier
.
static <T> Stream<T>
iterate(T seed, Predicate<? super T> hasNext, UnaryOperator<T> next)
Returns a sequential ordered Stream
produced by iterative application of the given next
function to an initial element, conditioned on satisfying the given hasNext
predicate.
static <T> Stream<T>
iterate(T seed, UnaryOperator<T> f)
Returns an infinite sequential ordered Stream
produced by iterative application of a function f
to an initial element seed
, producing a Stream
consisting of seed
, f(seed)
, f(f(seed))
, etc.
Stream<T>
limit(long maxSize)
Returns a stream consisting of the elements of this stream, truncated to be no longer than maxSize
in length.
<R> Stream<R>
map(Function<? super T,? extends R> mapper)
Returns a stream consisting of the results of applying the given function to the elements of this stream.
DoubleStream
mapToDouble(ToDoubleFunction<? super T> mapper)
Returns a DoubleStream
consisting of the results of applying the given function to the elements of this stream.
IntStream
mapToInt(ToIntFunction<? super T> mapper)
Returns an IntStream
consisting of the results of applying the given function to the elements of this stream.
LongStream
mapToLong(ToLongFunction<? super T> mapper)
Returns a LongStream
consisting of the results of applying the given function to the elements of this stream.
Optional<T>
max(Comparator<? super T> comparator)
Returns the maximum element of this stream according to the provided Comparator
.
Optional<T>
min(Comparator<? super T> comparator)
Returns the minimum element of this stream according to the provided Comparator
.
boolean
noneMatch(Predicate<? super T> predicate)
Returns whether no elements of this stream match the provided predicate.
static <T> Stream<T>
of(T t)
Returns a sequential Stream
containing a single element.
static <T> Stream<T>
of(T... values)
Returns a sequential ordered stream whose elements are the specified values.
static <T> Stream<T>
ofNullable(T t)
Returns a sequential Stream
containing a single element, if non-null, otherwise returns an empty Stream
.
Stream<T>
peek(Consumer<? super T> action)
Returns 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.
Optional<T>
reduce(BinaryOperator<T> accumulator)
Performs a
reductionon the elements of this stream, using an
associativeaccumulation function, and returns an
Optional
describing the reduced value, if any.
T
reduce(T identity, BinaryOperator<T> accumulator)
Performs a
reductionon the elements of this stream, using the provided identity value and an
associativeaccumulation function, and returns the reduced value.
<U> U
reduce(U identity, BiFunction<U,? super T,U> accumulator, BinaryOperator<U> combiner)
Performs a
reductionon the elements of this stream, using the provided identity, accumulation and combining functions.
Stream<T>
skip(long n)
Returns a stream consisting of the remaining elements of this stream after discarding the first n
elements of the stream.
Stream<T>
sorted()
Returns a stream consisting of the elements of this stream, sorted according to natural order.
Stream<T>
sorted(Comparator<? super T> comparator)
Returns a stream consisting of the elements of this stream, sorted according to the provided Comparator
.
default Stream<T>
takeWhile(Predicate<? super T> predicate)
Returns, if this stream is ordered, a stream consisting of the longest prefix of elements taken from this stream that match the given predicate.
Object[]
toArray()
Returns an array containing the elements of this stream.
<A> A[]
toArray(IntFunction<A[]> generator)
Returns an array containing the elements of this stream, using the provided generator
function to allocate the returned array, as well as any additional arrays that might be required for a partitioned execution or for resizing.
close, isParallel, iterator, onClose, parallel, sequential, spliterator, unordered
Stream<T> filter(Predicate<? super T> predicate)
This is an intermediate operation.
predicate
- a non-interfering, stateless predicate to apply to each element to determine if it should be included
<R> Stream<R> map(Function<? super T,? extends R> mapper)
This is an intermediate operation.
R
- The element type of the new stream
mapper
- a non-interfering, stateless function to apply to each element
IntStream mapToInt(ToIntFunction<? super T> mapper)
Returns an
IntStream
consisting of the results of applying the given function to the elements of this stream.
This is an intermediate operation.
mapper
- a non-interfering, stateless function to apply to each element
LongStream mapToLong(ToLongFunction<? super T> mapper)
Returns a
LongStream
consisting of the results of applying the given function to the elements of this stream.
This is an intermediate operation.
mapper
- a non-interfering, stateless function to apply to each element
DoubleStream mapToDouble(ToDoubleFunction<? super T> mapper)
Returns a
DoubleStream
consisting of the results of applying the given function to the elements of this stream.
This is an intermediate operation.
mapper
- a non-interfering, stateless function to apply to each element
<R> Stream<R> flatMap(Function<? super T,? extends Stream<? extends R>> mapper)
Returns a stream consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element. Each mapped stream is
closed
after its contents have been placed into this stream. (If a mapped stream is
null
an empty stream is used, instead.)
This is an intermediate operation.
flatMap()
operation has the effect of applying a one-to-many transformation to the elements of the stream, and then flattening the resulting elements into a new stream.
Examples.
If orders
is a stream of purchase orders, and each purchase order contains a collection of line items, then the following produces a stream containing all the line items in all the orders:
orders.flatMap(order -> order.getLineItems().stream())...
If path
is the path to a file, then the following produces a stream of the words
contained in that file:
Stream<String> lines = Files.lines(path, StandardCharsets.UTF_8);
Stream<String> words = lines.flatMap(line -> Stream.of(line.split(" +")));
The mapper
function passed to flatMap
splits a line, using a simple regular expression, into an array of words, and then creates a stream of words from that array.
R
- The element type of the new stream
mapper
- a non-interfering, stateless function to apply to each element which produces a stream of new values
IntStream flatMapToInt(Function<? super T,? extends IntStream> mapper)
Returns an
IntStream
consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element. Each mapped stream is
closed
after its contents have been placed into this stream. (If a mapped stream is
null
an empty stream is used, instead.)
This is an intermediate operation.
mapper
- a non-interfering, stateless function to apply to each element which produces a stream of new values
flatMap(Function)
LongStream flatMapToLong(Function<? super T,? extends LongStream> mapper)
Returns an
LongStream
consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element. Each mapped stream is
closed
after its contents have been placed into this stream. (If a mapped stream is
null
an empty stream is used, instead.)
This is an intermediate operation.
mapper
- a non-interfering, stateless function to apply to each element which produces a stream of new values
flatMap(Function)
DoubleStream flatMapToDouble(Function<? super T,? extends DoubleStream> mapper)
Returns an
DoubleStream
consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element. Each mapped stream is
closed
after its contents have placed been into this stream. (If a mapped stream is
null
an empty stream is used, instead.)
This is an intermediate operation.
mapper
- a non-interfering, stateless function to apply to each element which produces a stream of new values
flatMap(Function)
Stream<T> distinct()
Returns a stream consisting of the distinct elements (according to
Object.equals(Object)
) of this stream.
For ordered streams, the selection of distinct elements is stable (for duplicated elements, the element appearing first in the encounter order is preserved.) For unordered streams, no stability guarantees are made.
This is a stateful intermediate operation.
distinct()
in parallel pipelines is relatively expensive (requires that the operation act as a full barrier, with substantial buffering overhead), and stability is often not needed. Using an unordered stream source (such as generate(Supplier)
) or removing the ordering constraint with BaseStream.unordered()
may result in significantly more efficient execution for distinct()
in parallel pipelines, if the semantics of your situation permit. If consistency with encounter order is required, and you are experiencing poor performance or memory utilization with distinct()
in parallel pipelines, switching to sequential execution with BaseStream.sequential()
may improve performance.
Stream<T> sorted()
Returns a stream consisting of the elements of this stream, sorted according to natural order. If the elements of this stream are not
Comparable
, a
java.lang.ClassCastException
may be thrown when the terminal operation is executed.
For ordered streams, the sort is stable. For unordered streams, no stability guarantees are made.
This is a stateful intermediate operation.
Stream<T> sorted(Comparator<? super T> comparator)
Returns a stream consisting of the elements of this stream, sorted according to the provided
Comparator
.
For ordered streams, the sort is stable. For unordered streams, no stability guarantees are made.
This is a stateful intermediate operation.
comparator
- a non-interfering, stateless Comparator
to be used to compare stream elements
Stream<T> peek(Consumer<? super T> action)
Returns 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.
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.
Stream.of("one", "two", "three", "four")
.filter(e -> e.length() > 3)
.peek(e -> System.out.println("Filtered value: " + e))
.map(String::toUpperCase)
.peek(e -> System.out.println("Mapped value: " + e))
.collect(Collectors.toList());
In cases where the stream implementation is able to optimize away the production of some or all the elements (such as with short-circuiting operations like findFirst
, or in the example described in count()
), the action will not be invoked for those elements.
action
- a non-interfering action to perform on the elements as they are consumed from the stream
Stream<T> limit(long maxSize)
limit()
is generally a cheap operation on sequential stream pipelines, it can be quite expensive on ordered parallel pipelines, especially for large values of maxSize
, since limit(n)
is constrained to return not just any n elements, but the first n elements in the encounter order. Using an unordered stream source (such as generate(Supplier)
) or removing the ordering constraint with BaseStream.unordered()
may result in significant speedups of limit()
in parallel pipelines, if the semantics of your situation permit. If consistency with encounter order is required, and you are experiencing poor performance or memory utilization with limit()
in parallel pipelines, switching to sequential execution with BaseStream.sequential()
may improve performance.
maxSize
- the number of elements the stream should be limited to
IllegalArgumentException
- if maxSize
is negative
Stream<T> skip(long n)
Returns a stream consisting of the remaining elements of this stream after discarding the first
n
elements of the stream. If this stream contains fewer than
n
elements then an empty stream will be returned.
This is a stateful intermediate operation.
skip()
is generally a cheap operation on sequential stream pipelines, it can be quite expensive on ordered parallel pipelines, especially for large values of n
, since skip(n)
is constrained to skip not just any n elements, but the first n elements in the encounter order. Using an unordered stream source (such as generate(Supplier)
) or removing the ordering constraint with BaseStream.unordered()
may result in significant speedups of skip()
in parallel pipelines, if the semantics of your situation permit. If consistency with encounter order is required, and you are experiencing poor performance or memory utilization with skip()
in parallel pipelines, switching to sequential execution with BaseStream.sequential()
may improve performance.
n
- the number of leading elements to skip
IllegalArgumentException
- if n
is negative
default Stream<T> takeWhile(Predicate<? super T> predicate)
Returns, if this stream is ordered, a stream consisting of the longest prefix of elements taken from this stream that match the given predicate. Otherwise returns, if this stream is unordered, a stream consisting of a subset of elements taken from this stream that match the given predicate.
If this stream is ordered then the longest prefix is a contiguous sequence of elements of this stream that match the given predicate. The first element of the sequence is the first element of this stream, and the element immediately following the last element of the sequence does not match the given predicate.
If this stream is unordered, and some (but not all) elements of this stream match the given predicate, then the behavior of this operation is nondeterministic; it is free to take any subset of matching elements (which includes the empty set).
Independent of whether this stream is ordered or unordered if all elements of this stream match the given predicate then this operation takes all elements (the result is the same as the input), or if no elements of the stream match the given predicate then no elements are taken (the result is an empty stream).
This is a short-circuiting stateful intermediate operation.
takeWhile()
is generally a cheap operation on sequential stream pipelines, it can be quite expensive on ordered parallel pipelines, since the operation is constrained to return not just any valid prefix, but the longest prefix of elements in the encounter order. Using an unordered stream source (such as generate(Supplier)
) or removing the ordering constraint with BaseStream.unordered()
may result in significant speedups of takeWhile()
in parallel pipelines, if the semantics of your situation permit. If consistency with encounter order is required, and you are experiencing poor performance or memory utilization with takeWhile()
in parallel pipelines, switching to sequential execution with BaseStream.sequential()
may improve performance.
spliterator
of this stream, wraps that spliterator so as to support the semantics of this operation on traversal, and returns a new stream associated with the wrapped spliterator. The returned stream preserves the execution characteristics of this stream (namely parallel or sequential execution as per BaseStream.isParallel()
) but the wrapped spliterator may choose to not support splitting. When the returned stream is closed, the close handlers for both the returned and this stream are invoked.
predicate
- a non-interfering, stateless predicate to apply to elements to determine the longest prefix of elements.
default Stream<T> dropWhile(Predicate<? super T> predicate)
Returns, if this stream is ordered, a stream consisting of the remaining elements of this stream after dropping the longest prefix of elements that match the given predicate. Otherwise returns, if this stream is unordered, a stream consisting of the remaining elements of this stream after dropping a subset of elements that match the given predicate.
If this stream is ordered then the longest prefix is a contiguous sequence of elements of this stream that match the given predicate. The first element of the sequence is the first element of this stream, and the element immediately following the last element of the sequence does not match the given predicate.
If this stream is unordered, and some (but not all) elements of this stream match the given predicate, then the behavior of this operation is nondeterministic; it is free to drop any subset of matching elements (which includes the empty set).
Independent of whether this stream is ordered or unordered if all elements of this stream match the given predicate then this operation drops all elements (the result is an empty stream), or if no elements of the stream match the given predicate then no elements are dropped (the result is the same as the input).
This is a stateful intermediate operation.
dropWhile()
is generally a cheap operation on sequential stream pipelines, it can be quite expensive on ordered parallel pipelines, since the operation is constrained to return not just any valid prefix, but the longest prefix of elements in the encounter order. Using an unordered stream source (such as generate(Supplier)
) or removing the ordering constraint with BaseStream.unordered()
may result in significant speedups of dropWhile()
in parallel pipelines, if the semantics of your situation permit. If consistency with encounter order is required, and you are experiencing poor performance or memory utilization with dropWhile()
in parallel pipelines, switching to sequential execution with BaseStream.sequential()
may improve performance.
spliterator
of this stream, wraps that spliterator so as to support the semantics of this operation on traversal, and returns a new stream associated with the wrapped spliterator. The returned stream preserves the execution characteristics of this stream (namely parallel or sequential execution as per BaseStream.isParallel()
) but the wrapped spliterator may choose to not support splitting. When the returned stream is closed, the close handlers for both the returned and this stream are invoked.
predicate
- a non-interfering, stateless predicate to apply to elements to determine the longest prefix of elements.
void forEach(Consumer<? super T> action)
Performs an action for each element of this stream.
This is a terminal operation.
The behavior of this operation is explicitly nondeterministic. 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 action accesses shared state, it is responsible for providing the required synchronization.
action
- a non-interfering action to perform on the elements
void forEachOrdered(Consumer<? super T> action)
Performs an action for each element of this stream, in the encounter order of the stream if the stream has a defined encounter order.
This is a terminal operation.
This operation processes the elements one at a time, in encounter order if one exists. Performing the action for one element happens-before performing the action for subsequent elements, but for any given element, the action may be performed in whatever thread the library chooses.
action
- a non-interfering action to perform on the elements
forEach(Consumer)
Object[] toArray()
This is a terminal operation.
Object
, containing the elements of this stream
<A> A[] toArray(IntFunction<A[]> generator)
Returns an array containing the elements of this stream, using the provided
generator
function to allocate the returned array, as well as any additional arrays that might be required for a partitioned execution or for resizing.
This is a terminal operation.
Person[] men = people.stream()
.filter(p -> p.getGender() == MALE)
.toArray(Person[]::new);
A
- the component type of the resulting array
generator
- a function which produces a new array of the desired type and the provided length
ArrayStoreException
- if the runtime type of any element of this stream is not assignable to the runtime component type of the generated array
T reduce(T identity, BinaryOperator<T> accumulator)
Performs a
reductionon the elements of this stream, using the provided identity value and an
associativeaccumulation function, and returns the reduced value. This is equivalent to:
T result = identity;
for (T 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 t
, accumulator.apply(identity, t)
is equal to t
. The accumulator
function must be an associative function.
This is a terminal operation.
Integer sum = integers.reduce(0, (a, b) -> a+b);
or:
Integer 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.
identity
- the identity value for the accumulating function
accumulator
- an associative, non-interfering, stateless function for combining two values
Optional<T> reduce(BinaryOperator<T> accumulator)
Performs a
reductionon the elements of this stream, using an
associativeaccumulation function, and returns an
Optional
describing the reduced value, if any. This is equivalent to:
boolean foundAny = false;
T result = null;
for (T element : this stream) {
if (!foundAny) {
foundAny = true;
result = element;
}
else
result = accumulator.apply(result, element);
}
return foundAny ? Optional.of(result) : Optional.empty();
but is not constrained to execute sequentially.
The accumulator
function must be an associative function.
This is a terminal operation.
accumulator
- an associative, non-interfering, stateless function for combining two values
Optional
describing the result of the reduction
NullPointerException
- if the result of the reduction is null
reduce(Object, BinaryOperator)
, min(Comparator)
, max(Comparator)
<U> U reduce(U identity, BiFunction<U,? super T,U> accumulator, BinaryOperator<U> combiner)
Performs a
reductionon the elements of this stream, using the provided identity, accumulation and combining functions. This is equivalent to:
U result = identity;
for (T 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 combiner function. This means that for all u
, combiner(identity, u)
is equal to u
. Additionally, the combiner
function must be compatible with the accumulator
function; for all u
and t
, the following must hold:
combiner.apply(u, accumulator.apply(identity, t)) == accumulator.apply(u, t)
This is a terminal operation.
map
and reduce
operations. The accumulator
function acts as a fused mapper and accumulator, which can sometimes be more efficient than separate mapping and reduction, such as when knowing the previously reduced value allows you to avoid some computation.
U
- The type of the result
identity
- the identity value for the combiner function
accumulator
- an associative, non-interfering, stateless function for incorporating an additional element into a result
combiner
- an associative, non-interfering, stateless function for combining two values, which must be compatible with the accumulator function
reduce(BinaryOperator)
, reduce(Object, BinaryOperator)
<R> R collect(Supplier<R> supplier, BiConsumer<R,? super T> accumulator, BiConsumer<R,R> combiner)
Performs a
mutable reductionoperation on the elements of this stream. A mutable reduction is one in which the reduced value is a mutable result container, such as an
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 = supplier.get();
for (T element : this stream)
accumulator.accept(result, element);
return result;
Like reduce(Object, BinaryOperator)
, collect
operations can be parallelized without requiring additional synchronization.
This is a terminal operation.
collect()
. For example, the following will accumulate strings into an ArrayList
:
List<String> asList = stringStream.collect(ArrayList::new, ArrayList::add,
ArrayList::addAll);
The following will take a stream of strings and concatenates them into a single string:
String concat = stringStream.collect(StringBuilder::new, StringBuilder::append,
StringBuilder::append)
.toString();
R
- the type of the mutable result container
supplier
- a function that creates a new mutable result container. For a parallel execution, this function may be called multiple times and must return a fresh value each time.
accumulator
- an associative, non-interfering, stateless function that must fold an element into a result container.
combiner
- an associative, non-interfering, stateless function that accepts two partial result containers and merges them, which must be compatible with the accumulator function. The combiner function must fold the elements from the second result container into the first result container.
<R,A> R collect(Collector<? super T,A,R> collector)
Performs a
mutable reductionoperation on the elements of this stream using a
Collector
. A
Collector
encapsulates the functions used as arguments to
collect(Supplier, BiConsumer, BiConsumer)
, allowing for reuse of collection strategies and composition of collect operations such as multiple-level grouping or partitioning.
If the stream is parallel, and the Collector
is concurrent
, and either the stream is unordered or the collector is unordered
, then a concurrent reduction will be performed (see Collector
for details on concurrent reduction.)
This is a terminal operation.
When executed in parallel, multiple intermediate results may be instantiated, populated, and merged so as to maintain isolation of mutable data structures. Therefore, even when executed in parallel with non-thread-safe data structures (such as ArrayList
), no additional synchronization is needed for a parallel reduction.
List<String> asList = stringStream.collect(Collectors.toList());
The following will classify Person
objects by city:
Map<String, List<Person>> peopleByCity
= personStream.collect(Collectors.groupingBy(Person::getCity));
The following will classify Person
objects by state and city, cascading two Collector
s together:
Map<String, Map<String, List<Person>>> peopleByStateAndCity
= personStream.collect(Collectors.groupingBy(Person::getState,
Collectors.groupingBy(Person::getCity)));
R
- the type of the result
A
- the intermediate accumulation type of the Collector
collector
- the Collector
describing the reduction
collect(Supplier, BiConsumer, BiConsumer)
, Collectors
Optional<T> min(Comparator<? super T> comparator)
Returns the minimum element of this stream according to the provided
Comparator
. This is a special case of a
reduction.
This is a terminal operation.
comparator
- a non-interfering, stateless Comparator
to compare elements of this stream
Optional
describing the minimum element of this stream, or an empty Optional
if the stream is empty
NullPointerException
- if the minimum element is null
Optional<T> max(Comparator<? super T> comparator)
Returns the maximum element of this stream according to the provided
Comparator
. This is a special case of a
reduction.
This is a terminal operation.
comparator
- a non-interfering, stateless Comparator
to compare elements of this stream
Optional
describing the maximum element of this stream, or an empty Optional
if the stream is empty
NullPointerException
- if the maximum element is null
long count()
Returns the count of elements in this stream. This is a special case of a
reductionand is equivalent to:
return mapToLong(e -> 1L).sum();
This is a terminal operation.
List<String> l = Arrays.asList("A", "B", "C", "D");
long count = l.stream().peek(System.out::println).count();
The number of elements covered by the stream source, a List
, is known and the intermediate operation, peek
, does not inject into or remove elements from the stream (as may be the case for flatMap
or filter
operations). Thus the count is the size of the List
and there is no need to execute the pipeline and, as a side-effect, print out the list elements.
boolean anyMatch(Predicate<? super T> predicate)
Returns whether any elements of this stream match the provided predicate. May not evaluate the predicate on all elements if not necessary for determining the result. If the stream is empty then
false
is returned and the predicate is not evaluated.
This is a short-circuiting terminal operation.
predicate
- a non-interfering, stateless predicate to apply to elements of this stream
true
if any elements of the stream match the provided predicate, otherwise false
boolean allMatch(Predicate<? super T> predicate)
Returns whether all elements of this stream match the provided predicate. May not evaluate the predicate on all elements if not necessary for determining the result. If the stream is empty then
true
is returned and the predicate is not evaluated.
This is a short-circuiting terminal operation.
true
(regardless of P(x)).
predicate
- a non-interfering, stateless predicate to apply to elements of this stream
true
if either all elements of the stream match the provided predicate or the stream is empty, otherwise false
boolean noneMatch(Predicate<? super T> predicate)
Returns whether no elements of this stream match the provided predicate. May not evaluate the predicate on all elements if not necessary for determining the result. If the stream is empty then
true
is returned and the predicate is not evaluated.
This is a short-circuiting terminal operation.
true
, regardless of P(x).
predicate
- a non-interfering, stateless predicate to apply to elements of this stream
true
if either no elements of the stream match the provided predicate or the stream is empty, otherwise false
Optional<T> findFirst()
Returns an
Optional
describing the first element of this stream, or an empty
Optional
if the stream is empty. If the stream has no encounter order, then any element may be returned.
This is a short-circuiting terminal operation.
Optional
describing the first element of this stream, or an empty Optional
if the stream is empty
NullPointerException
- if the element selected is null
Optional<T> findAny()
Returns an
Optional
describing some element of the stream, or an empty
Optional
if the stream is empty.
This is a short-circuiting 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 a stable result is desired, use findFirst()
instead.)
Optional
describing some element of this stream, or an empty Optional
if the stream is empty
NullPointerException
- if the element selected is null
findFirst()
static <T> Stream.Builder<T> builder()
Returns a builder for a Stream
.
T
- type of elements
static <T> Stream<T> empty()
Returns an empty sequential Stream
.
T
- the type of stream elements
static <T> Stream<T> of(T t)
Returns a sequential Stream
containing a single element.
T
- the type of stream elements
t
- the single element
static <T> Stream<T> ofNullable(T t)
Returns a sequential Stream
containing a single element, if non-null, otherwise returns an empty Stream
.
T
- the type of stream elements
t
- the single element
@SafeVarargs static <T> Stream<T> of(T... values)
Returns a sequential ordered stream whose elements are the specified values.
T
- the type of stream elements
values
- the elements of the new stream
static <T> Stream<T> iterate(T seed, UnaryOperator<T> f)
Returns an infinite sequential ordered
Stream
produced by iterative application of a function
f
to an initial element
seed
, producing a
Stream
consisting of
seed
,
f(seed)
,
f(f(seed))
, etc.
The first element (position 0
) in the Stream
will be the provided seed
. For n > 0
, the element at position n
, will be the result of applying the function f
to the element at position n - 1
.
The action of applying f
for one element happens-before the action of applying f
for subsequent elements. For any given element the action may be performed in whatever thread the library chooses.
T
- the type of stream elements
seed
- the initial element
f
- a function to be applied to the previous element to produce a new element
Stream
static <T> Stream<T> iterate(T seed, Predicate<? super T> hasNext, UnaryOperator<T> next)
Returns a sequential ordered
Stream
produced by iterative application of the given
next
function to an initial element, conditioned on satisfying the given
hasNext
predicate. The stream terminates as soon as the
hasNext
predicate returns false.
Stream.iterate
should produce the same sequence of elements as produced by the corresponding for-loop:
for (T index=seed; hasNext.test(index); index = next.apply(index)) {
...
}
The resulting sequence may be empty if the hasNext
predicate does not hold on the seed value. Otherwise the first element will be the supplied seed
value, the next element (if present) will be the result of applying the next
function to the seed
value, and so on iteratively until the hasNext
predicate indicates that the stream should terminate.
The action of applying the hasNext
predicate to an element happens-before the action of applying the next
function to that element. The action of applying the next
function for one element happens-before the action of applying the hasNext
predicate for subsequent elements. For any given element an action may be performed in whatever thread the library chooses.
T
- the type of stream elements
seed
- the initial element
hasNext
- a predicate to apply to elements to determine when the stream must terminate.
next
- a function to be applied to the previous element to produce a new element
Stream
static <T> Stream<T> generate(Supplier<? extends T> s)
Returns an infinite sequential unordered stream where each element is generated by the provided Supplier
. This is suitable for generating constant streams, streams of random elements, etc.
T
- the type of stream elements
s
- the Supplier
of generated elements
Stream
static <T> Stream<T> concat(Stream<? extends T> a, Stream<? extends T> b)
This method operates on the two input streams and binds each stream to its source. As a result subsequent modifications to an input stream source may not be reflected in the concatenated stream result.
Stream<T> concat = Stream.of(s1, s2, s3, s4).flatMap(s -> s);
StackOverflowError
.
Subsequent changes to the sequential/parallel execution mode of the returned stream are not guaranteed to be propagated to the input streams.
T
- The type of stream elements
a
- the first stream
b
- the second stream
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4