Stream (stream 1.1.3-SNAPSHOT API)

java.lang.Object
- com.annimon.stream.Stream<T>

Type Parameters:

T - the type of the stream elements
```
public class Stream<T>
extends java.lang.Object
```
A sequence of elements supporting aggregate operations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`allMatch(Predicate<? super T> predicate)` Tests whether all elements match the given predicate.
`boolean`	`anyMatch(Predicate<? super T> predicate)` Tests whether any elements match the given predicate.
`<K> Stream<java.util.List<T>>`	`chunkBy(Function<? super T,? extends K> classifier)` Partitions `Stream` into `List`s according to the given classifier function.
`<R,A> R`	`collect(Collector<? super T,A,R> collector)` Collects elements with `collector` that encapsulates supplier, accumulator and combiner functions.
`<R> R`	`collect(Supplier<R> supplier, BiConsumer<R,? super T> accumulator)` Collects elements to `supplier` provided container by applying the given accumulation function.
`static <T> Stream<T>`	`concat(Stream<? extends T> stream1, Stream<? extends T> stream2)` Concatenates two streams.
`long`	`count()` Counts the number of elements in this stream.
`<R> R`	`custom(Function<Stream<T>,R> function)` Applies custom operator on stream.
`Stream<T>`	`distinct()` Returns `Stream` with distinct elements (as determinated by `hashCode` and `equals` methods).
`Stream<T>`	`dropWhile(Predicate<? super T> predicate)` Drops elements while the predicate is true and returns the rest.
`static <T> Stream<T>`	`empty()` Returns an empty stream.
`Stream<T>`	`filter(Predicate<? super T> predicate)` Returns `Stream` with elements that satisfy the given predicate.
`Stream<T>`	`filterNot(Predicate<? super T> predicate)` Returns `Stream` with elements that does not satisfy the given predicate.
`Optional<T>`	`findFirst()` Returns the first element wrapped by `Optional` class.
`Optional<T>`	`findSingle()` Returns the single element wrapped by `Optional` class.
`<R> Stream<R>`	`flatMap(Function<? super T,? extends Stream<? extends R>> mapper)` Generates `Stream` by concatenating elements that obtained by applying the given function.
`IntStream`	`flatMapToInt(Function<? super T,? extends IntStream> mapper)` Generates `IntStream` by concatenating elements that obtained by applying the given function.
`void`	`forEach(Consumer<? super T> action)` Performs the given action to each element.
`static <T> Stream<T>`	`generate(Supplier<T> supplier)` Creates a `Stream` by elements that generated by `Supplier`.
`java.util.Iterator<? extends T>`	`getIterator()` Deprecated. As of release 1.1.1, replaced by `iterator()`
`<K> Stream<java.util.Map.Entry<K,java.util.List<T>>>`	`groupBy(Function<? super T,? extends K> classifier)` Partitions `Stream` into `Map` entries according to the given classifier function.
`Stream<IntPair<T>>`	`indexed()` Returns `Stream` with indexed elements.
`Stream<IntPair<T>>`	`indexed(int from, int step)` Returns `Stream` with indexed elements.
`static <T> Stream<T>`	`iterate(T seed, UnaryOperator<T> op)` Creates a `Stream` by iterative application `UnaryOperator` function to an initial element `seed`.
`java.util.Iterator<? extends T>`	`iterator()` Returns internal stream iterator.
`Stream<T>`	`limit(long maxSize)` Returns `Stream` with first `maxSize` elements.
`<R> Stream<R>`	`map(Function<? super T,? extends R> mapper)` Returns `Stream` with elements that obtained by applying the given function.
`IntStream`	`mapToInt(ToIntFunction<? super T> mapper)` Returns `IntStream` with elements that obtained by applying the given function.
`Optional<T>`	`max(java.util.Comparator<? super T> comparator)` Finds the maximum element according to the given comparator.
`Optional<T>`	`min(java.util.Comparator<? super T> comparator)` Finds the minimum element according to the given comparator.
`boolean`	`noneMatch(Predicate<? super T> predicate)` Tests whether no elements match the given predicate.
`static <T> Stream<T>`	`of(java.lang.Iterable<? extends T> iterable)` Creates a `Stream` from any class that implements `Iterable` interface.
`static <T> Stream<T>`	`of(java.util.Iterator<? extends T> iterator)` Creates a `Stream` from any class that implements `Iterator` interface.
`static <K,V> Stream<java.util.Map.Entry<K,V>>`	`of(java.util.Map<K,V> map)` Creates a `Stream` from `Map` entries.
`static <T> Stream<T>`	`of(T... elements)` Creates a `Stream` from the specified values.
`static Stream<java.lang.Integer>`	`ofRange(int from, int to)` Deprecated. As of release 1.0.7, replaced by `range(int, int)`
`static Stream<java.lang.Long>`	`ofRange(long from, long to)` Deprecated. As of release 1.0.7, replaced by `range(long, long)`
`static Stream<java.lang.Integer>`	`ofRangeClosed(int from, int to)` Deprecated. As of release 1.0.7, replaced by `rangeClosed(int, int)`
`static Stream<java.lang.Long>`	`ofRangeClosed(long from, long to)` Deprecated. As of release 1.0.7, replaced by `rangeClosed(long, long)`
`Stream<T>`	`peek(Consumer<? super T> action)` Perform provided action to each elements.
`static Stream<java.lang.Integer>`	`range(int from, int to)` Creates a `Stream<Integer>` from not closed range (from `from` inclusive to `to` exclusive and incremental step `1`).
`static Stream<java.lang.Long>`	`range(long from, long to)` Creates a `Stream<Long>` from not closed range (from `from` inclusive to `to` exclusive and incremental step `1`).
`static Stream<java.lang.Integer>`	`rangeClosed(int from, int to)` Creates a `Stream<Integer>` from closed range (from `from` inclusive to `to` inclusive and incremental step `1`).
`static Stream<java.lang.Long>`	`rangeClosed(long from, long to)` Creates a `Stream<Long>` from closed range (from `from` inclusive to `to` inclusive and incremental step `1`).
`Optional<T>`	`reduce(BiFunction<T,T,T> accumulator)` Reduces the elements using provided associative accumulation function.
`<R> R`	`reduce(R identity, BiFunction<? super R,? super T,? extends R> accumulator)` Reduces the elements using provided identity value and the associative accumulation function.
`Stream<T>`	`sample(int stepWidth)` Samples the `Stream` by emitting every n-th element.
`<TT> Stream<TT>`	`select(java.lang.Class<TT> clazz)` Returns a stream consisting of the elements of this stream which are instances of given class.
`T`	`single()` Returns the single element of stream.
`Stream<T>`	`skip(long n)` Skips first `n` elements and returns `Stream` with remaining elements.
`Stream<java.util.List<T>>`	`slidingWindow(int windowSize)` Partitions `Stream` into `List`s of fixed size by sliding over the elements of the stream.
`Stream<java.util.List<T>>`	`slidingWindow(int windowSize, int stepWidth)` Partitions `Stream` into `List`s of fixed size by sliding over the elements of the stream.
`<R extends java.lang.Comparable<? super R>> Stream<T>`	`sortBy(Function<? super T,? extends R> f)` Returns `Stream` with sorted elements (as determinated by `Comparable` interface).
`Stream<T>`	`sorted()` Returns `Stream` with sorted elements (as determinated by `Comparable` interface).
`Stream<T>`	`sorted(java.util.Comparator<? super T> comparator)` Returns `Stream` with sorted elements (as determinated by provided `Comparator`).
`Stream<T>`	`takeWhile(Predicate<? super T> predicate)` Takes elements while the predicate is true.
`java.lang.Object[]`	`toArray()` Collects elements to an array.
`<R> R[]`	`toArray(IntFunction<R[]> generator)` Collects elements to an array, the `generator` constructor of provided.
`static <F,S,R> Stream<R>`	`zip(java.util.Iterator<? extends F> iterator1, java.util.Iterator<? extends S> iterator2, BiFunction<? super F,? super S,? extends R> combiner)` Combines two iterators to a stream by applying specified combiner function to each element at same position.
`static <F,S,R> Stream<R>`	`zip(Stream<? extends F> stream1, Stream<? extends S> stream2, BiFunction<? super F,? super S,? extends R> combiner)` Combines two streams by applying specified combiner function to each element at same position.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - empty
```
public static <T> Stream<T> empty()
```
    Returns an empty stream.
    
    Type Parameters:
    
    T - the type of the stream elements
    
    Returns:
    
    the new empty stream
  - of
```
public static <K,V> Stream<java.util.Map.Entry<K,V>> of(java.util.Map<K,V> map)
```
    Creates a Stream from Map entries.
    
    Type Parameters:
    
    K - the type of map keys
    
    V - the type of map values
    
    Parameters:
    
    map - the map with elements to be passed to stream
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if map is null
  - of
```
public static <T> Stream<T> of(java.util.Iterator<? extends T> iterator)
```
    Creates a Stream from any class that implements Iterator interface.
    
    Type Parameters:
    
    T - the type of the stream elements
    
    Parameters:
    
    iterator - the iterator with elements to be passed to stream
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if iterator is null
  - of
```
public static <T> Stream<T> of(java.lang.Iterable<? extends T> iterable)
```
    Creates a Stream from any class that implements Iterable interface.
    
    Type Parameters:
    
    T - the type of the stream elements
    
    Parameters:
    
    iterable - the Iterable with elements to be passed to stream
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if iterable is null
  - of
```
public static <T> Stream<T> of(T... elements)
```
    Creates a Stream from the specified values.
    
    Type Parameters:
    
    T - the type of the stream elements
    
    Parameters:
    
    elements - the elements to be passed to stream
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if elements is null
  - range
```
public static Stream<java.lang.Integer> range(int from,
                                              int to)
```
    Creates a Stream<Integer> from not closed range (from from inclusive to to exclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (exclusive)
    
    Returns:
    
    the new stream
    
    See Also:
    
    IntStream.range(int, int)
  - ofRange
```
@Deprecated
public static Stream<java.lang.Integer> ofRange(int from,
                                                             int to)
```
    Deprecated. As of release 1.0.7, replaced by range(int, int)
    
    Creates a Stream<Integer> from not closed range (from from inclusive to to exclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (exclusive)
    
    Returns:
    
    the new stream
  - range
```
public static Stream<java.lang.Long> range(long from,
                                           long to)
```
    Creates a Stream<Long> from not closed range (from from inclusive to to exclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (exclusive)
    
    Returns:
    
    the new stream
  - ofRange
```
@Deprecated
public static Stream<java.lang.Long> ofRange(long from,
                                                          long to)
```
    Deprecated. As of release 1.0.7, replaced by range(long, long)
    
    Creates a Stream<Long> from not closed range (from from inclusive to to exclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (exclusive)
    
    Returns:
    
    the new stream
  - rangeClosed
```
public static Stream<java.lang.Integer> rangeClosed(int from,
                                                    int to)
```
    Creates a Stream<Integer> from closed range (from from inclusive to to inclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (inclusive)
    
    Returns:
    
    the new stream
    
    See Also:
    
    IntStream.rangeClosed(int, int)
  - ofRangeClosed
```
@Deprecated
public static Stream<java.lang.Integer> ofRangeClosed(int from,
                                                                   int to)
```
    Deprecated. As of release 1.0.7, replaced by rangeClosed(int, int)
    
    Creates a Stream<Integer> from closed range (from from inclusive to to inclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (inclusive)
    
    Returns:
    
    the new stream
  - rangeClosed
```
public static Stream<java.lang.Long> rangeClosed(long from,
                                                 long to)
```
    Creates a Stream<Long> from closed range (from from inclusive to to inclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (inclusive)
    
    Returns:
    
    the new stream
  - ofRangeClosed
```
@Deprecated
public static Stream<java.lang.Long> ofRangeClosed(long from,
                                                                long to)
```
    Deprecated. As of release 1.0.7, replaced by rangeClosed(long, long)
    
    Creates a Stream<Long> from closed range (from from inclusive to to inclusive and incremental step 1).
    
    Parameters:
    
    from - the initial value (inclusive)
    
    to - the upper bound (inclusive)
    
    Returns:
    
    the new stream
  - generate
```
public static <T> Stream<T> generate(Supplier<T> supplier)
```
    Creates a Stream by elements that generated by Supplier.
    
    Type Parameters:
    
    T - the type of the stream elements
    
    Parameters:
    
    supplier - the Supplier of generated elements
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if supplier is null
  - iterate
```
public static <T> Stream<T> iterate(T seed,
                                    UnaryOperator<T> op)
```
    Creates a Stream by iterative application UnaryOperator function to an initial element seed. Produces Stream consisting of seed, op(seed), op(op(seed)), etc.
    Example:
```
 seed: 1
 op: (a) -> a + 5
 result: [1, 6, 11, 16, ...]
 
```
    Type Parameters:
    
    T - the type of the stream elements
    
    Parameters:
    
    seed - the initial value
    
    op - operator to produce new element by previous one
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if op is null
  - concat
```
public static <T> Stream<T> concat(Stream<? extends T> stream1,
                                   Stream<? extends T> stream2)
```
    Concatenates two streams.
    Example:
```
 stream 1: [1, 2, 3, 4]
 stream 2: [5, 6]
 result:   [1, 2, 3, 4, 5, 6]
 
```
    Type Parameters:
    
    T - The type of stream elements
    
    Parameters:
    
    stream1 - the first stream
    
    stream2 - the second stream
    
    Returns:
    
    the new concatenated stream
    
    Throws:
    
    java.lang.NullPointerException - if stream1 or stream2 is null
  - zip
```
public static <F,S,R> Stream<R> zip(Stream<? extends F> stream1,
                                    Stream<? extends S> stream2,
                                    BiFunction<? super F,? super S,? extends R> combiner)
```
    Combines two streams by applying specified combiner function to each element at same position.
    Example:
```
 combiner: (a, b) -> a + b
 stream 1: [1, 2, 3, 4]
 stream 2: [5, 6, 7, 8]
 result:   [6, 8, 10, 12]
 
```
    Type Parameters:
    
    F - the type of first stream elements
    
    S - the type of second stream elements
    
    R - the type of elements in resulting stream
    
    Parameters:
    
    stream1 - the first stream
    
    stream2 - the second stream
    
    combiner - the combiner function used to apply to each element
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if stream1 or stream2 is null
  - zip
```
public static <F,S,R> Stream<R> zip(java.util.Iterator<? extends F> iterator1,
                                    java.util.Iterator<? extends S> iterator2,
                                    BiFunction<? super F,? super S,? extends R> combiner)
```
    Combines two iterators to a stream by applying specified combiner function to each element at same position.
    Example:
```
 combiner: (a, b) -> a + b
 stream 1: [1, 2, 3, 4]
 stream 2: [5, 6, 7, 8]
 result:   [6, 8, 10, 12]
 
```
    Type Parameters:
    
    F - the type of first iterator elements
    
    S - the type of second iterator elements
    
    R - the type of elements in resulting stream
    
    Parameters:
    
    iterator1 - the first iterator
    
    iterator2 - the second iterator
    
    combiner - the combiner function used to apply to each element
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if iterator1 or iterator2 is null
    
    Since:
    
    1.1.2
  - getIterator
```
@Deprecated
public java.util.Iterator<? extends T> getIterator()
```
    Deprecated. As of release 1.1.1, replaced by iterator()
    
    Returns internal stream iterator.
    
    Returns:
    
    internal stream iterator
  - iterator
```
public java.util.Iterator<? extends T> iterator()
```
    Returns internal stream iterator.
    
    Returns:
    
    internal stream iterator
  - custom
```
public <R> R custom(Function<Stream<T>,R> function)
```
    Applies custom operator on stream. Transforming function can return Stream for intermediate operations, or any value for terminal operation.
    Operator examples:
```
     // Intermediate operator
     public class Reverse<T> implements Function<Stream<T>, Stream<T>> {
         @Override
         public Stream<T> apply(Stream<T> stream) {
             final Iterator<? extends T> iterator = stream.iterator();
             final ArrayDeque<T> deque = new ArrayDeque<T>();
             while (iterator.hasNext()) {
                 deque.addFirst(iterator.next());
             }
             return Stream.of(deque.iterator());
         }
     }

     // Intermediate operator based on existing stream operators
     public class SkipAndLimit<T> implements UnaryOperator<Stream<T>> {

         private final int skip, limit;

         public SkipAndLimit(int skip, int limit) {
             this.skip = skip;
             this.limit = limit;
         }

         @Override
         public Stream<T> apply(Stream<T> stream) {
             return stream.skip(skip).limit(limit);
         }
     }

     // Terminal operator
     public class Sum implements Function<Stream<Integer>, Integer> {
         @Override
         public Integer apply(Stream<Integer> stream) {
             return stream.reduce(0, new BinaryOperator<Integer>() {
                 @Override
                 public Integer apply(Integer value1, Integer value2) {
                     return value1 + value2;
                 }
             });
         }
     }
 
```
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    function - a transforming function
    
    Returns:
    
    a result of the transforming function
    
    Throws:
    
    java.lang.NullPointerException - if function is null
  - filter
```
public Stream<T> filter(Predicate<? super T> predicate)
```
    Returns Stream with elements that satisfy the given predicate.
    This is an intermediate operation.
    Example:
```
 predicate: (a) -> a > 2
 stream: [1, 2, 3, 4, -8, 0, 11]
 result: [3, 4, 11]
 
```
    Parameters:
    
    predicate - the predicate used to filter elements
    
    Returns:
    
    the new stream
  - filterNot
```
public Stream<T> filterNot(Predicate<? super T> predicate)
```
    Returns Stream with elements that does not satisfy the given predicate.
    This is an intermediate operation.
    
    Parameters:
    
    predicate - the predicate used to filter elements
    
    Returns:
    
    the new stream
  - select
```
public <TT> Stream<TT> select(java.lang.Class<TT> clazz)
```
    Returns a stream consisting of the elements of this stream which are instances of given class.
    This is an intermediate operation.
    
    Type Parameters:
    
    TT - a type of instances to select.
    
    Parameters:
    
    clazz - a class which instances should be selected
    
    Returns:
    
    the new stream of type passed as parameter
  - map
```
public <R> Stream<R> map(Function<? super T,? extends R> mapper)
```
    Returns Stream with elements that obtained by applying the given function.
    This is an intermediate operation.
    Example:
```
 mapper: (a) -> a + 5
 stream: [1, 2, 3, 4]
 result: [6, 7, 8, 9]
 
```
    Type Parameters:
    
    R - the type of elements in resulting stream
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new stream
  - mapToInt
```
public IntStream mapToInt(ToIntFunction<? super T> mapper)
```
    Returns IntStream with elements that obtained by applying the given function.
    This is an intermediate operation.
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new IntStream
    
    See Also:
    
    map(com.annimon.stream.function.Function)
  - flatMap
```
public <R> Stream<R> flatMap(Function<? super T,? extends Stream<? extends R>> mapper)
```
    Generates Stream by concatenating elements that obtained by applying the given function.
    This is an intermediate operation.
    Example:
```
 mapper: (a) -> [a, a + 5]
 stream: [1, 2, 3, 4]
 result: [1, 6, 2, 7, 3, 8, 4, 9]
 
```
    Type Parameters:
    
    R - the type of elements in resulting stream
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new stream
  - flatMapToInt
```
public IntStream flatMapToInt(Function<? super T,? extends IntStream> mapper)
```
    Generates IntStream by concatenating elements that obtained by applying the given function.
    This is an intermediate operation.
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new IntStream
    
    See Also:
    
    flatMap(com.annimon.stream.function.Function)
  - indexed
```
public Stream<IntPair<T>> indexed()
```
    Returns Stream with indexed elements. Indexing starts from 0 with step 1.
    This is an intermediate operation.
    Example:
```
 stream: ["a", "b", "c"]
 result: [(0, "a"), (1, "b"), (2, "c")]
 
```
    Returns:
    
    the new IntPair stream
    
    Since:
    
    1.1.2
  - indexed
```
public Stream<IntPair<T>> indexed(int from,
                                  int step)
```
    Returns Stream with indexed elements.
    This is an intermediate operation.
    Example:
```
 from: 5, step: 10
 stream: ["a", "b", "c"]
 result: [(5, "a"), (15, "b"), (25, "c")]
 
```
    Parameters:
    
    from - the initial value (inclusive)
    
    step - the step
    
    Returns:
    
    the new IntPair stream
    
    Since:
    
    1.1.2
  - distinct
```
public Stream<T> distinct()
```
    Returns Stream with distinct elements (as determinated by hashCode and equals methods).
    This is a stateful intermediate operation.
    Example:
```
 stream: [1, 4, 2, 3, 3, 4, 1]
 result: [1, 4, 2, 3]
 
```
    Returns:
    
    the new stream
  - sorted
```
public Stream<T> sorted()
```
    Returns Stream with sorted elements (as determinated by Comparable interface).
    This is a stateful intermediate operation.
    If the elements of this stream are not Comparable, a java.lang.ClassCastException may be thrown when the terminal operation is executed.
    Example:
```
 stream: [3, 4, 1, 2]
 result: [1, 2, 3, 4]
 
```
    Returns:
    
    the new stream
  - sorted
```
public Stream<T> sorted(java.util.Comparator<? super T> comparator)
```
    Returns Stream with sorted elements (as determinated by provided Comparator).
    This is a stateful intermediate operation.
    Example:
```
 comparator: (a, b) -> -a.compareTo(b)
 stream: [1, 2, 3, 4]
 result: [4, 3, 2, 1]
 
```
    Parameters:
    
    comparator - the Comparator to compare elements
    
    Returns:
    
    the new stream
  - sortBy
```
public <R extends java.lang.Comparable<? super R>> Stream<T> sortBy(Function<? super T,? extends R> f)
```
    Returns Stream with sorted elements (as determinated by Comparable interface). Each element transformed by given function f before comparing.
    This is a stateful intermediate operation.
    Example:
```
 f: (a) -> -a
 stream: [1, 2, 3, 4]
 result: [4, 3, 2, 1]
 
```
    Type Parameters:
    
    R - the type of the result of transforming function
    
    Parameters:
    
    f - the transformation function
    
    Returns:
    
    the new stream
  - groupBy
```
public <K> Stream<java.util.Map.Entry<K,java.util.List<T>>> groupBy(Function<? super T,? extends K> classifier)
```
    Partitions Stream into Map entries according to the given classifier function.
    This is a stateful intermediate operation.
    Example:
```
 classifier: (str) -> str.length()
 stream: ["a", "bc", "d", "ef", "ghij"]
 result: [{1: ["a", "d"]}, {2: ["bc", "ef"]}, {4: ["ghij"]}]
 
```
    Type Parameters:
    
    K - the type of the keys, which are result of the classifier function
    
    Parameters:
    
    classifier - the classifier function
    
    Returns:
    
    the new stream
  - chunkBy
```
public <K> Stream<java.util.List<T>> chunkBy(Function<? super T,? extends K> classifier)
```
    Partitions Stream into Lists according to the given classifier function. In contrast to groupBy(Function), this method assumes that the elements of the stream are sorted. Because of this assumption, it does not need to first collect all elements and then partition them. Instead, it can emit a List of elements when it reaches the first element that does not belong to the same chunk as the previous elements.
    This is an intermediate operation.
    Example:
```
 classifier: (a) -> a % 5 == 0
 stream: [1, 2, 5, 6, 7, 9, 10, 12, 14]
 result: [[1, 2], [5], [6, 7, 9], [10], [12, 14]]
 
```
    Type Parameters:
    
    K - the type of the keys, which are the result of the classifier function
    
    Parameters:
    
    classifier - the classifier function
    
    Returns:
    
    the new stream
  - sample
```
public Stream<T> sample(int stepWidth)
```
    Samples the Stream by emitting every n-th element.
    This is an intermediate operation.
    Example:
```
 stepWidth: 3
 stream: [1, 2, 3, 4, 5, 6, 7, 8]
 result: [1, 4, 7]
 
```
    Parameters:
    
    stepWidth - step width
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.IllegalArgumentException - if stepWidth is zero or negative
  - slidingWindow
```
public Stream<java.util.List<T>> slidingWindow(int windowSize)
```
    Partitions Stream into Lists of fixed size by sliding over the elements of the stream. It starts with the first element and in each iteration moves by 1. This method yields the same results as calling slidingWindow(int, int) with a stepWidth of 1.
    This is an intermediate operation.
    Example:
```
 windowSize: 3
 stream: [1, 2, 3, 4, 5]
 result: [[1, 2, 3], [2, 3, 4], [3, 4, 5]]
 
```
    Parameters:
    
    windowSize - number of elements that will be emitted together in a list
    
    Returns:
    
    the new stream
    
    See Also:
    
    slidingWindow(int, int)
  - slidingWindow
```
public Stream<java.util.List<T>> slidingWindow(int windowSize,
                                               int stepWidth)
```
    Partitions Stream into Lists of fixed size by sliding over the elements of the stream. It starts with the first element and in each iteration moves by the given step width. This method allows, for example, to partition the elements into batches of windowSize elements (by using a step width equal to the specified window size) or to sample every n-th element (by using a window size of 1 and a step width of n).
    This is an intermediate operation.
    Example:
```
 windowSize: 3, stepWidth: 3
 stream: [1, 1, 1, 2, 2, 2, 3, 3, 3]
 result: [[1, 1, 1], [2, 2, 2] [3, 3, 3]]

 windowSize: 2, stepWidth: 3
 stream: [1, 2, 3, 1, 2, 3, 1, 2, 3]
 result: [[1, 2], [1, 2], [1, 2]]

 windowSize: 3, stepWidth: 1
 stream: [1, 2, 3, 4, 5, 6]
 result: [[1, 2, 3], [2, 3, 4], [3, 4, 5], [4, 5, 6]]
 
```
    Parameters:
    
    windowSize - number of elements that will be emitted together in a list
    
    stepWidth - step width
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.IllegalArgumentException - if windowSize is zero or negative
    
    java.lang.IllegalArgumentException - if stepWidth is zero or negative
  - peek
```
public Stream<T> peek(Consumer<? super T> action)
```
    Perform provided action to each elements.
    This is an intermediate operation.
    
    Parameters:
    
    action - the action to be performed on each element
    
    Returns:
    
    the new stream
  - takeWhile
```
public Stream<T> takeWhile(Predicate<? super T> predicate)
```
    Takes elements while the predicate is true.
    This is an intermediate operation.
    Example:
```
 predicate: (a) -> a < 3
 stream: [1, 2, 3, 4, 1, 2, 3, 4]
 result: [1, 2]
 
```
    Parameters:
    
    predicate - the predicate used to take elements
    
    Returns:
    
    the new stream
  - dropWhile
```
public Stream<T> dropWhile(Predicate<? super T> predicate)
```
    Drops elements while the predicate is true and returns the rest.
    This is an intermediate operation.
    Example:
```
 predicate: (a) -> a < 3
 stream: [1, 2, 3, 4, 1, 2, 3, 4]
 result: [3, 4, 1, 2, 3, 4]
 
```
    Parameters:
    
    predicate - the predicate used to drop elements
    
    Returns:
    
    the new stream
  - limit
```
public Stream<T> limit(long maxSize)
```
    Returns Stream with first maxSize elements.
    This is a short-circuiting stateful intermediate operation.
    Example:
```
 maxSize: 3
 stream: [1, 2, 3, 4, 5]
 result: [1, 2, 3]

 maxSize: 10
 stream: [1, 2]
 result: [1, 2]
 
```
    Parameters:
    
    maxSize - the number of elements to limit
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.IllegalArgumentException - if maxSize is negative
  - skip
```
public Stream<T> skip(long n)
```
    Skips first n elements and returns Stream with remaining elements.
    This is a stateful intermediate operation.
    Example:
```
 n: 3
 stream: [1, 2, 3, 4, 5]
 result: [4, 5]

 n: 10
 stream: [1, 2]
 result: []
 
```
    Parameters:
    
    n - the number of elements to skip
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.IllegalArgumentException - if n is negative
  - forEach
```
public void forEach(Consumer<? super T> action)
```
    Performs the given action to each element.
    This is a terminal operation.
    
    Parameters:
    
    action - the action to be performed on each element
  - reduce
```
public <R> R reduce(R identity,
                    BiFunction<? super R,? super T,? extends R> accumulator)
```
    Reduces the elements using provided identity value and the associative accumulation function.
    This is a terminal operation.
    Example:
```
 identity: 0
 accumulator: (a, b) -> a + b
 stream: [1, 2, 3, 4, 5]
 result: 15
 
```
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    identity - the initial value
    
    accumulator - the accumulation function
    
    Returns:
    
    the result of the reduction
  - reduce
```
public Optional<T> reduce(BiFunction<T,T,T> accumulator)
```
    Reduces the elements using provided associative accumulation function.
    This is a terminal operation.
    
    Parameters:
    
    accumulator - the accumulation function
    
    Returns:
    
    the result of the reduction
  - toArray
```
public java.lang.Object[] toArray()
```
    Collects elements to an array.
    This is a terminal operation.
    
    Returns:
    
    the result of collect elements
    
    See Also:
    
    toArray(com.annimon.stream.function.IntFunction)
  - toArray
```
public <R> R[] toArray(IntFunction<R[]> generator)
```
    Collects elements to an array, the generator constructor of provided.
    This is a terminal operation.
    
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    generator - the array constructor reference that accommodates future array of assigned size
    
    Returns:
    
    the result of collect elements
  - collect
```
public <R> R collect(Supplier<R> supplier,
                     BiConsumer<R,? super T> accumulator)
```
    Collects elements to supplier provided container by applying the given accumulation function.
    This is a terminal operation.
    
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    supplier - the supplier function that provides container
    
    accumulator - the accumulation function
    
    Returns:
    
    the result of collect elements
    
    See Also:
    
    collect(com.annimon.stream.Collector)
  - collect
```
public <R,A> R collect(Collector<? super T,A,R> collector)
```
    Collects elements with collector that encapsulates supplier, accumulator and combiner functions.
    This is a terminal operation.
    
    Type Parameters:
    
    R - the type of result
    
    A - the intermediate used by Collector
    
    Parameters:
    
    collector - the Collector
    
    Returns:
    
    the result of collect elements
    
    See Also:
    
    collect(com.annimon.stream.function.Supplier, com.annimon.stream.function.BiConsumer)
  - min
```
public Optional<T> min(java.util.Comparator<? super T> comparator)
```
    Finds the minimum element according to the given comparator.
    This is a terminal operation.
    Example:
```
 comparator: (a, b) -> a.compareTo(b)
 stream: [1, 2, 3, 4, 5]
 result: 1
 
```
    Parameters:
    
    comparator - the Comparator to compare elements
    
    Returns:
    
    the minimum element
  - max
```
public Optional<T> max(java.util.Comparator<? super T> comparator)
```
    Finds the maximum element according to the given comparator.
    This is a terminal operation.
    Example:
```
 comparator: (a, b) -> a.compareTo(b)
 stream: [1, 2, 3, 4, 5]
 result: 5
 
```
    Parameters:
    
    comparator - the Comparator to compare elements
    
    Returns:
    
    the maximum element
  - count
```
public long count()
```
    Counts the number of elements in this stream.
    This is a terminal operation.
    
    Returns:
    
    the count of elements
  - anyMatch
```
public boolean anyMatch(Predicate<? super T> predicate)
```
    Tests whether any elements match the given predicate.
    This is a short-circuiting terminal operation.
    Example:
```
 predicate: (a) -> a == 5
 stream: [1, 2, 3, 4, 5]
 result: true

 predicate: (a) -> a == 5
 stream: [5, 5, 5]
 result: true
 
```
    Parameters:
    
    predicate - the predicate used to match elements
    
    Returns:
    
    true if any elements match the given predicate, otherwise false
  - allMatch
```
public boolean allMatch(Predicate<? super T> predicate)
```
    Tests whether all elements match the given predicate.
    This is a short-circuiting terminal operation.
    Example:
```
 predicate: (a) -> a == 5
 stream: [1, 2, 3, 4, 5]
 result: false

 predicate: (a) -> a == 5
 stream: [5, 5, 5]
 result: true
 
```
    Parameters:
    
    predicate - the predicate used to match elements
    
    Returns:
    
    true if all elements match the given predicate, otherwise false
  - noneMatch
```
public boolean noneMatch(Predicate<? super T> predicate)
```
    Tests whether no elements match the given predicate.
    This is a short-circuiting terminal operation.
    Example:
```
 predicate: (a) -> a == 5
 stream: [1, 2, 3, 4, 5]
 result: false

 predicate: (a) -> a == 5
 stream: [1, 2, 3]
 result: true
 
```
    Parameters:
    
    predicate - the predicate used to match elements
    
    Returns:
    
    true if no elements match the given predicate, otherwise false
  - findFirst
```
public Optional<T> findFirst()
```
    Returns the first element wrapped by Optional class. If stream is empty, returns Optional.empty().
    This is a short-circuiting terminal operation.
    
    Returns:
    
    an Optional with first element or Optional.empty() if stream is empty
  - single
```
public T single()
```
    Returns the single element of stream. If stream is empty, throws NoSuchElementException. If stream contains more than one element, throws IllegalStateException.
    This is a short-circuiting terminal operation.
    Example:
```
 stream: []
 result: NoSuchElementException

 stream: [1]
 result: 1

 stream: [1, 2, 3]
 result: IllegalStateException
 
```
    Returns:
    
    single element of stream
    
    Throws:
    
    java.util.NoSuchElementException - if stream is empty
    
    java.lang.IllegalStateException - if stream contains more than one element
    
    Since:
    
    1.1.2
  - findSingle
```
public Optional<T> findSingle()
```
    Returns the single element wrapped by Optional class. If stream is empty, returns Optional.empty(). If stream contains more than one element, throws IllegalStateException.
    This is a short-circuiting terminal operation.
    Example:
```
 stream: []
 result: Optional.empty()

 stream: [1]
 result: Optional.of(1)

 stream: [1, 2, 3]
 result: IllegalStateException
 
```
    Returns:
    
    an Optional with single element or Optional.empty() if stream is empty
    
    Throws:
    
    java.lang.IllegalStateException - if stream contains more than one element
    
    Since:
    
    1.1.2

Class Stream<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

of

of

of

range

ofRange

range

ofRange

rangeClosed

ofRangeClosed

rangeClosed

ofRangeClosed

generate

iterate

concat

zip

zip

getIterator

iterator

custom

filter

filterNot

select

map

mapToInt

flatMap

flatMapToInt

indexed

indexed

distinct

sorted

sorted

sortBy

groupBy

chunkBy

sample

slidingWindow

slidingWindow

peek

takeWhile

dropWhile

limit

skip

forEach

reduce

reduce

toArray

toArray

collect

collect

min

max

count

anyMatch

allMatch

noneMatch

findFirst

single

findSingle