LongStream (stream 1.2.2 API)

java.lang.Object
- com.annimon.stream.LongStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public final class LongStream
extends java.lang.Object
implements java.io.Closeable
```
A sequence of long-valued elements supporting aggregate operations.

Since:

1.1.4

See Also:

Stream

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LongStream.LongMapMultiConsumer
Represents an operation on two input arguments.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LongStream.LongMapMultiConsumer` Represents an operation on two input arguments.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allMatch(LongPredicate predicate)` Tests whether all elements match the given predicate.
`boolean`	`anyMatch(LongPredicate predicate)` Tests whether all elements match the given predicate.
`LongStream`	`append(LongStream stream)` Appends given `LongStream` to current and returns a new stream.
`Stream<java.lang.Long>`	`boxed()` Returns a `Stream` consisting of the elements of this stream, each boxed to an `Long`.
`void`	`close()` Causes close handler to be invoked if it exists.
`<R> R`	`collect(Supplier<R> supplier, ObjLongConsumer<R> accumulator)` Collects elements to `supplier` provided container by applying the given accumulation function.
`static LongStream`	`concat(LongStream a, LongStream b)` Lazily concatenates two streams.
`static LongStream`	`concat(LongStream a, LongStream b, LongStream... rest)` Lazily concatenates three or more streams.
`long`	`count()` Returns the count of elements in this stream.
`<R> R`	`custom(Function<LongStream,R> function)` Applies custom operator on stream.
`LongStream`	`distinct()` Returns a stream consisting of the distinct elements of this stream.
`LongStream`	`dropWhile(LongPredicate predicate)` Drops elements while the predicate is true and returns the rest.
`static LongStream`	`empty()` Returns an empty stream.
`LongStream`	`filter(LongPredicate predicate)` Returns `LongStream` with elements that satisfy the given predicate.
`LongStream`	`filterIndexed(IndexedLongPredicate predicate)` Returns a `LongStream` with elements that satisfy the given `IndexedLongPredicate`.
`LongStream`	`filterIndexed(int from, int step, IndexedLongPredicate predicate)` Returns a `LongStream` with elements that satisfy the given `IndexedLongPredicate`.
`LongStream`	`filterNot(LongPredicate predicate)` Returns `LongStream` with elements that does not satisfy the given predicate.
`OptionalLong`	`findFirst()` Returns the first element wrapped by `OptionalLong` class.
`long`	`findFirstOrElse(long other)` Returns the first element if stream is not empty, otherwise returns `other`.
`OptionalLong`	`findLast()` Returns the last element wrapped by `OptionalLong` class.
`OptionalLong`	`findSingle()` Returns the single element wrapped by `OptionalLong` class.
`LongStream`	`flatMap(LongFunction<? extends LongStream> 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.
`void`	`forEach(LongConsumer action)` Performs an action for each element of this stream.
`void`	`forEachIndexed(IndexedLongConsumer action)` Performs the given indexed action on each element.
`void`	`forEachIndexed(int from, int step, IndexedLongConsumer action)` Performs the given indexed action on each element.
`static LongStream`	`generate(LongSupplier s)` Creates a `LongStream` by elements that generated by `LongSupplier`.
`static LongStream`	`iterate(long seed, LongPredicate predicate, LongUnaryOperator op)` Creates an `LongStream` by iterative application `LongUnaryOperator` function to an initial element `seed`, conditioned on satisfying the supplied predicate.
`static LongStream`	`iterate(long seed, LongUnaryOperator f)` Creates a `LongStream` by iterative application `LongUnaryOperator` function to an initial element `seed`.
`PrimitiveIterator.OfLong`	`iterator()` Returns internal `LongStream` iterator.
`LongStream`	`limit(long maxSize)` Returns a stream consisting of the elements of this stream, truncated to be no longer than `maxSize` in length.
`LongStream`	`map(LongUnaryOperator mapper)` Returns an `LongStream` consisting of the results of applying the given function to the elements of this stream.
`LongStream`	`mapIndexed(IndexedLongUnaryOperator mapper)` Returns a `LongStream` with elements that obtained by applying the given `IndexedLongUnaryOperator`.
`LongStream`	`mapIndexed(int from, int step, IndexedLongUnaryOperator mapper)` Returns a `LongStream` with elements that obtained by applying the given `IndexedLongUnaryOperator`.
`LongStream`	`mapMulti(LongStream.LongMapMultiConsumer 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`	`mapToDouble(LongToDoubleFunction mapper)` Returns an `DoubleStream` consisting of the results of applying the given function to the elements of this stream.
`IntStream`	`mapToInt(LongToIntFunction mapper)` Returns an `IntStream` consisting of the results of applying the given function to the elements of this stream.
`<R> Stream<R>`	`mapToObj(LongFunction<? extends R> mapper)` Returns a `Stream` consisting of the results of applying the given function to the elements of this stream.
`OptionalLong`	`max()` Returns an `OptionalLong` describing the maximum element of this stream, or an empty optional if this stream is empty.
`OptionalLong`	`min()` Returns an `OptionalLong` describing the minimum element of this stream, or an empty optional if this stream is empty.
`boolean`	`noneMatch(LongPredicate predicate)` Tests whether no elements match the given predicate.
`static LongStream`	`of(long... values)` Creates a `LongStream` from the specified values.
`static LongStream`	`of(long t)` Returns stream which contains single element passed as param
`static LongStream`	`of(PrimitiveIterator.OfLong iterator)` Creates a `LongStream` from `PrimitiveIterator.OfLong`.
`LongStream`	`onClose(java.lang.Runnable closeHandler)` Adds close handler to the current stream.
`LongStream`	`peek(LongConsumer action)` Performs provided action on each element.
`LongStream`	`prepend(LongStream stream)` Prepends given `LongStream` to current and returns a new stream.
`static LongStream`	`range(long startInclusive, long endExclusive)` Returns a sequential ordered `LongStream` from `startInclusive` (inclusive) to `endExclusive` (exclusive) by an incremental step of `1`.
`static LongStream`	`rangeClosed(long startInclusive, long endInclusive)` Returns a sequential ordered `LongStream` from `startInclusive` (inclusive) to `endInclusive` (inclusive) by an incremental step of `1`.
`OptionalLong`	`reduce(LongBinaryOperator accumulator)` Performs a reduction on the elements of this stream, using an associative accumulation function, and returns an `OptionalLong` describing the reduced value, if any.
`long`	`reduce(long identity, LongBinaryOperator accumulator)` Performs a reduction on the elements of this stream, using the provided identity value and an associative accumulation function, and returns the reduced value.
`LongStream`	`sample(int stepWidth)` Samples the `LongStream` by emitting every n-th element.
`LongStream`	`scan(LongBinaryOperator accumulator)` Returns a `LongStream` produced by iterative application of a accumulation function to reduction value and next element of the current stream.
`LongStream`	`scan(long identity, LongBinaryOperator accumulator)` Returns a `LongStream` produced by iterative application of a accumulation function to an initial element `identity` and next element of the current stream.
`long`	`single()` Returns the single element of stream.
`LongStream`	`skip(long n)` Skips first `n` elements and returns `LongStream` with remaining elements.
`LongStream`	`sorted()` Returns a stream consisting of the elements of this stream in sorted order.
`LongStream`	`sorted(java.util.Comparator<java.lang.Long> comparator)` Returns a stream consisting of the elements of this stream in sorted order as determinated by provided `Comparator`.
`long`	`sum()` Returns the sum of elements in this stream.
`LongStream`	`takeUntil(LongPredicate stopPredicate)` Takes elements while the predicate returns `false`.
`LongStream`	`takeWhile(LongPredicate predicate)` Takes elements while the predicate returns `true`.
`long[]`	`toArray()` Returns an array containing the elements of this stream.

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

- Method Detail
  - empty
```
@NotNull
public static LongStream empty()
```
    Returns an empty stream.
    
    Returns:
    
    the empty stream
  - of
```
@NotNull
public static LongStream of(@NotNull
                                     PrimitiveIterator.OfLong iterator)
```
    Creates a LongStream from PrimitiveIterator.OfLong.
    
    Parameters:
    
    iterator - the iterator with elements to be passed to stream
    
    Returns:
    
    the new LongStream
    
    Throws:
    
    java.lang.NullPointerException - if iterator is null
  - of
```
@NotNull
public static LongStream of(@NotNull
                                     long... values)
```
    Creates a LongStream from the specified values.
    
    Parameters:
    
    values - the elements of the new stream
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if values is null
  - of
```
@NotNull
public static LongStream of(long t)
```
    Returns stream which contains single element passed as param
    
    Parameters:
    
    t - element of the stream
    
    Returns:
    
    the new stream
  - range
```
@NotNull
public static LongStream range(long startInclusive,
                                        long endExclusive)
```
    Returns a sequential ordered LongStream from startInclusive (inclusive) to endExclusive (exclusive) by an incremental step of 1.
    
    Parameters:
    
    startInclusive - the (inclusive) initial value
    
    endExclusive - the exclusive upper bound
    
    Returns:
    
    a sequential LongStream for the range of long elements
  - rangeClosed
```
@NotNull
public static LongStream rangeClosed(long startInclusive,
                                              long endInclusive)
```
    Returns a sequential ordered LongStream from startInclusive (inclusive) to endInclusive (inclusive) by an incremental step of 1.
    
    Parameters:
    
    startInclusive - the (inclusive) initial value
    
    endInclusive - the inclusive upper bound
    
    Returns:
    
    a sequential LongStream for the range of long elements
  - generate
```
@NotNull
public static LongStream generate(@NotNull
                                           LongSupplier s)
```
    Creates a LongStream by elements that generated by LongSupplier.
    
    Parameters:
    
    s - the LongSupplier for generated elements
    
    Returns:
    
    a new infinite sequential LongStream
    
    Throws:
    
    java.lang.NullPointerException - if s is null
  - iterate
```
@NotNull
public static LongStream iterate(long seed,
                                          @NotNull
                                          LongUnaryOperator f)
```
    Creates a LongStream by iterative application LongUnaryOperator function to an initial element seed. Produces LongStream consisting of seed, f(seed), f(f(seed)), etc.
    The first element (position 0) in the LongStream 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.
    Example:
```
 seed: 1
 f: (a) -> a + 5
 result: [1, 6, 11, 16, ...]
 
```
    Parameters:
    
    seed - the initial element
    
    f - a function to be applied to the previous element to produce a new element
    
    Returns:
    
    a new sequential LongStream
    
    Throws:
    
    java.lang.NullPointerException - if f is null
  - iterate
```
@NotNull
public static LongStream iterate(long seed,
                                          @NotNull
                                          LongPredicate predicate,
                                          @NotNull
                                          LongUnaryOperator op)
```
    Creates an LongStream by iterative application LongUnaryOperator function to an initial element seed, conditioned on satisfying the supplied predicate.
    Example:
```
 seed: 0
 predicate: (a) -> a < 20
 f: (a) -> a + 5
 result: [0, 5, 10, 15]
 
```
    Parameters:
    
    seed - the initial value
    
    predicate - a predicate to determine when the stream must terminate
    
    op - operator to produce new element by previous one
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if op is null
    
    Since:
    
    1.1.5
  - concat
```
@NotNull
public static LongStream concat(@NotNull
                                         LongStream a,
                                         @NotNull
                                         LongStream b)
```
    Lazily concatenates two streams.
    Example:
```
 stream a: [1, 2, 3, 4]
 stream b: [5, 6]
 result:   [1, 2, 3, 4, 5, 6]
 
```
    Parameters:
    
    a - the first stream
    
    b - the second stream
    
    Returns:
    
    the new concatenated stream
    
    Throws:
    
    java.lang.NullPointerException - if a or b is null
  - concat
```
@NotNull
public static LongStream concat(@NotNull
                                         LongStream a,
                                         @NotNull
                                         LongStream b,
                                         @NotNull
                                         LongStream... rest)
```
    Lazily concatenates three or more streams.
    Example:
```
 stream a: [1, 2, 3, 4]
 stream b: [5, 6]
 stream c: [7]
 stream d: [8, 9, 10]
 result:   [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 
```
    Parameters:
    
    a - the first stream
    
    b - the second stream
    
    rest - the rest of streams
    
    Returns:
    
    the new concatenated stream
    
    Throws:
    
    java.lang.NullPointerException - if a or b or rest is null
    
    Since:
    
    1.2.2
  - iterator
```
public PrimitiveIterator.OfLong iterator()
```
    Returns internal LongStream iterator.
    
    Returns:
    
    internal LongStream iterator.
  - custom
```
@Nullable
public <R> R custom(@NotNull
                              Function<LongStream,R> function)
```
    Applies custom operator on stream. Transforming function can return LongStream for intermediate operations, or any value for terminal operation.
    Operator examples:
```
     // Intermediate operator
     public class Zip implements Function<LongStream, LongStream> {

         private final LongStream secondStream;
         private final LongBinaryOperator combiner;

         public Zip(LongStream secondStream, LongBinaryOperator combiner) {
             this.secondStream = secondStream;
             this.combiner = combiner;
         }

         @Override
         public LongStream apply(LongStream firstStream) {
             final PrimitiveIterator.OfLong it1 = firstStream.iterator();
             final PrimitiveIterator.OfLong it2 = secondStream.iterator();
             return LongStream.of(new PrimitiveIterator.OfLong() {
                 @Override
                 public boolean hasNext() {
                     return it1.hasNext() && it2.hasNext();
                 }

                 @Override
                 public long nextLong() {
                     return combiner.applyAsLong(it1.nextLong(), it2.nextLong());
                 }
             });
         }
     }

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

         private final int skip, limit;

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

         @Override
         public LongStream apply(LongStream stream) {
             return stream.skip(skip).limit(limit);
         }
     }

     // Terminal operator
     public class LongSummaryStatistics implements Function<LongStream, long[]> {
         @Override
         public long[] apply(LongStream stream) {
             long count = 0;
             long sum = 0;
             final PrimitiveIterator.OfLong it = stream.iterator();
             while (it.hasNext()) {
                 count++;
                 sum += it.nextLong();
             }
             return new long[] {count, sum};
         }
     }
 
```
    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
    
    See Also:
    
    Stream.custom(com.annimon.stream.function.Function)
  - boxed
```
@NotNull
public Stream<java.lang.Long> boxed()
```
    Returns a Stream consisting of the elements of this stream, each boxed to an Long.
    This is an lazy intermediate operation.
    
    Returns:
    
    a Stream consistent of the elements of this stream, each boxed to an Long
  - prepend
```
@NotNull
public LongStream prepend(@NotNull
                                   LongStream stream)
```
    Prepends given LongStream to current and returns a new stream. This is similar to LongStream.concat(stream, this)
    Example:
```
 current: [1, 2, 3]
 stream:  [4, 5, 6]
 result:  [4, 5, 6, 1, 2, 3]
 
```
    Parameters:
    
    stream - the stream to prepend
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.2
    
    See Also:
    
    concat(LongStream, LongStream)
  - append
```
@NotNull
public LongStream append(@NotNull
                                  LongStream stream)
```
    Appends given LongStream to current and returns a new stream. This is similar to LongStream.concat(this, stream)
    Example:
```
 current: [1, 2, 3]
 stream:  [4, 5, 6]
 result:  [1, 2, 3, 4, 5, 6]
 
```
    Parameters:
    
    stream - the stream to append
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.2
    
    See Also:
    
    concat(LongStream, LongStream)
  - filter
```
@NotNull
public LongStream filter(@NotNull
                                  LongPredicate predicate)
```
    Returns LongStream 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
  - filterIndexed
```
@NotNull
public LongStream filterIndexed(@NotNull
                                         IndexedLongPredicate predicate)
```
    Returns a LongStream with elements that satisfy the given IndexedLongPredicate.
    This is an intermediate operation.
    Example:
```
 predicate: (index, value) -> (index + value) > 6
 stream: [1, 2, 3, 4, 0, 11]
 index:  [0, 1, 2, 3, 4,  5]
 sum:    [1, 3, 5, 7, 4, 16]
 filter: [         7,    16]
 result: [4, 11]
 
```
    Parameters:
    
    predicate - the IndexedLongPredicate used to filter elements
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.1
  - filterIndexed
```
@NotNull
public LongStream filterIndexed(int from,
                                         int step,
                                         @NotNull
                                         IndexedLongPredicate predicate)
```
    Returns a LongStream with elements that satisfy the given IndexedLongPredicate.
    This is an intermediate operation.
    Example:
```
 from: 4
 step: 3
 predicate: (index, value) -> (index + value) > 15
 stream: [1, 2,  3,  4,  0, 11]
 index:  [4, 7, 10, 13, 16, 19]
 sum:    [5, 9, 13, 17, 16, 30]
 filter: [          17, 16, 30]
 result: [4, 0, 11]
 
```
    Parameters:
    
    from - the initial value of the index (inclusive)
    
    step - the step of the index
    
    predicate - the IndexedLongPredicate used to filter elements
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.1
  - filterNot
```
@NotNull
public LongStream filterNot(@NotNull
                                     LongPredicate predicate)
```
    Returns LongStream 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
  - map
```
@NotNull
public LongStream map(@NotNull
                               LongUnaryOperator mapper)
```
    Returns an LongStream consisting of the results of applying the given function to the elements of this stream.
    This is an intermediate operation.
    Example:
```
 mapper: (a) -> a + 5
 stream: [1, 2, 3, 4]
 result: [6, 7, 8, 9]
 
```
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new stream
    
    See Also:
    
    Stream.map(com.annimon.stream.function.Function)
  - mapIndexed
```
@NotNull
public LongStream mapIndexed(@NotNull
                                      IndexedLongUnaryOperator mapper)
```
    Returns a LongStream with elements that obtained by applying the given IndexedLongUnaryOperator.
    This is an intermediate operation.
    Example:
```
 mapper: (index, value) -> (index * value)
 stream: [1, 2, 3,  4]
 index:  [0, 1, 2,  3]
 result: [0, 2, 6, 12]
 
```
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.1
  - mapIndexed
```
@NotNull
public LongStream mapIndexed(int from,
                                      int step,
                                      @NotNull
                                      IndexedLongUnaryOperator mapper)
```
    Returns a LongStream with elements that obtained by applying the given IndexedLongUnaryOperator.
    This is an intermediate operation.
    Example:
```
 from: -2
 step: 2
 mapper: (index, value) -> (index * value)
 stream: [ 1, 2, 3,  4]
 index:  [-2, 0, 2,  4]
 result: [-2, 0, 6, 16]
 
```
    Parameters:
    
    from - the initial value of the index (inclusive)
    
    step - the step of the index
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.1
  - mapToObj
```
@NotNull
public <R> Stream<R> mapToObj(@NotNull
                                       LongFunction<? extends R> mapper)
```
    Returns a Stream consisting of the results of applying the given function to the elements of this stream.
    This is an intermediate operation.
    
    Type Parameters:
    
    R - the type result
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new Stream
  - mapToInt
```
@NotNull
public IntStream mapToInt(@NotNull
                                   LongToIntFunction mapper)
```
    Returns an IntStream consisting of the results of applying the given function to the elements of this stream.
    This is an intermediate operation.
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new IntStream
  - mapToDouble
```
@NotNull
public DoubleStream mapToDouble(@NotNull
                                         LongToDoubleFunction mapper)
```
    Returns an DoubleStream consisting of the results of applying the given function to the elements of this stream.
    This is an intermediate operation.
    
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new DoubleStream
  - flatMap
```
@NotNull
public LongStream flatMap(@NotNull
                                   LongFunction<? extends LongStream> 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.
    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]
 
```
    Parameters:
    
    mapper - the mapper function used to apply to each element
    
    Returns:
    
    the new stream
    
    See Also:
    
    Stream.flatMap(com.annimon.stream.function.Function)
  - mapMulti
```
@NotNull
public LongStream mapMulti(@NotNull
                                    LongStream.LongMapMultiConsumer 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.
    This is an intermediate operation.
    
    Parameters:
    
    mapper - the mapper function used to apply to each element for producing replacing elements
    
    Returns:
    
    the new stream
    
    Since:
    
    1.2.2
    
    See Also:
    
    Stream.mapMulti(com.annimon.stream.function.BiConsumer), flatMap(com.annimon.stream.function.LongFunction)
  - distinct
```
@NotNull
public LongStream distinct()
```
    Returns a stream consisting of the distinct elements of this stream.
    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
```
@NotNull
public LongStream sorted()
```
    Returns a stream consisting of the elements of this stream in sorted order.
    This is a stateful intermediate operation.
    Example:
```
 stream: [3, 4, 1, 2]
 result: [1, 2, 3, 4]
 
```
    Returns:
    
    the new stream
  - sorted
```
@NotNull
public LongStream sorted(@Nullable
                                  java.util.Comparator<java.lang.Long> comparator)
```
    Returns a stream consisting of the elements of this stream in sorted order 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 LongStream
  - sample
```
@NotNull
public LongStream sample(int stepWidth)
```
    Samples the LongStream 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 LongStream
    
    Throws:
    
    java.lang.IllegalArgumentException - if stepWidth is zero or negative
    
    See Also:
    
    Stream.sample(int)
  - peek
```
@NotNull
public LongStream peek(@NotNull
                                LongConsumer action)
```
    Performs provided action on each element.
    This is an intermediate operation.
    
    Parameters:
    
    action - the action to be performed on each element
    
    Returns:
    
    the new stream
  - scan
```
@NotNull
public LongStream scan(@NotNull
                                LongBinaryOperator accumulator)
```
    Returns a LongStream produced by iterative application of a accumulation function to reduction value and next element of the current stream. Produces a LongStream consisting of value1, acc(value1, value2), acc(acc(value1, value2), value3), etc.
    This is an intermediate operation.
    Example:
```
 accumulator: (a, b) -> a + b
 stream: [1, 2, 3, 4, 5]
 result: [1, 3, 6, 10, 15]
 
```
    Parameters:
    
    accumulator - the accumulation function
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if accumulator is null
    
    Since:
    
    1.1.6
  - scan
```
@NotNull
public LongStream scan(long identity,
                                @NotNull
                                LongBinaryOperator accumulator)
```
    Returns a LongStream produced by iterative application of a accumulation function to an initial element identity and next element of the current stream. Produces a LongStream consisting of identity, acc(identity, value1), acc(acc(identity, value1), value2), etc.
    This is an intermediate operation.
    Example:
```
 identity: 0
 accumulator: (a, b) -> a + b
 stream: [1, 2, 3, 4, 5]
 result: [0, 1, 3, 6, 10, 15]
 
```
    Parameters:
    
    identity - the initial value
    
    accumulator - the accumulation function
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.NullPointerException - if accumulator is null
    
    Since:
    
    1.1.6
  - takeWhile
```
@NotNull
public LongStream takeWhile(@NotNull
                                     LongPredicate predicate)
```
    Takes elements while the predicate returns 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 LongStream
  - takeUntil
```
@NotNull
public LongStream takeUntil(@NotNull
                                     LongPredicate stopPredicate)
```
    Takes elements while the predicate returns false. Once predicate condition is satisfied by an element, the stream finishes with this element.
    This is an intermediate operation.
    Example:
```
 stopPredicate: (a) -> a > 2
 stream: [1, 2, 3, 4, 1, 2, 3, 4]
 result: [1, 2, 3]
 
```
    Parameters:
    
    stopPredicate - the predicate used to take elements
    
    Returns:
    
    the new LongStream
    
    Since:
    
    1.1.6
  - dropWhile
```
@NotNull
public LongStream dropWhile(@NotNull
                                     LongPredicate 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 LongStream
  - limit
```
@NotNull
public LongStream limit(long maxSize)
```
    Returns a stream consisting of the elements of this stream, truncated to be no longer than maxSize in length.
    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 the stream should be limited to
    
    Returns:
    
    the new stream
    
    Throws:
    
    java.lang.IllegalArgumentException - if maxSize is negative
  - skip
```
@NotNull
public LongStream skip(long n)
```
    Skips first n elements and returns LongStream with remaining elements. If this stream contains fewer than n elements, then an empty stream will be returned.
    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(@NotNull
                    LongConsumer action)
```
    Performs an action for each element of this stream.
    This is a terminal operation.
    
    Parameters:
    
    action - the action to be performed on each element
  - forEachIndexed
```
public void forEachIndexed(@NotNull
                           IndexedLongConsumer action)
```
    Performs the given indexed action on each element.
    This is a terminal operation.
    
    Parameters:
    
    action - the action to be performed on each element
    
    Since:
    
    1.2.1
  - forEachIndexed
```
public void forEachIndexed(int from,
                           int step,
                           @NotNull
                           IndexedLongConsumer action)
```
    Performs the given indexed action on each element.
    This is a terminal operation.
    
    Parameters:
    
    from - the initial value of the index (inclusive)
    
    step - the step of the index
    
    action - the action to be performed on each element
    
    Since:
    
    1.2.1
  - reduce
```
public long reduce(long identity,
                   @NotNull
                   LongBinaryOperator accumulator)
```
    Performs a reduction on the elements of this stream, using the provided identity value and an associative accumulation function, and returns the reduced value.
    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.
    Example:
```
 identity: 0
 accumulator: (a, b) -> a + b
 stream: [1, 2, 3, 4, 5]
 result: 15
 
```
    Parameters:
    
    identity - the identity value for the accumulating function
    
    accumulator - the accumulation function
    
    Returns:
    
    the result of the reduction
    
    See Also:
    
    sum(), min(), max()
  - reduce
```
@NotNull
public OptionalLong reduce(@NotNull
                                    LongBinaryOperator accumulator)
```
    Performs a reduction on the elements of this stream, using an associative accumulation function, and returns an OptionalLong describing the reduced value, if any.
    The accumulator function must be an associative function.
    This is a terminal operation.
    
    Parameters:
    
    accumulator - the accumulation function
    
    Returns:
    
    the result of the reduction
    
    See Also:
    
    reduce(com.annimon.stream.function.LongBinaryOperator)
  - toArray
```
@NotNull
public long[] toArray()
```
    Returns an array containing the elements of this stream.
    This is a terminal operation.
    
    Returns:
    
    an array containing the elements of this stream
  - collect
```
@Nullable
public <R> R collect(@NotNull
                               Supplier<R> supplier,
                               @NotNull
                               ObjLongConsumer<R> 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:
    
    Stream.collect(com.annimon.stream.function.Supplier, com.annimon.stream.function.BiConsumer)
  - sum
```
public long sum()
```
    Returns the sum of elements in this stream.
    
    Returns:
    
    the sum of elements in this stream
  - min
```
@NotNull
public OptionalLong min()
```
    Returns an OptionalLong describing the minimum element of this stream, or an empty optional if this stream is empty.
    This is a terminal operation.
    
    Returns:
    
    the minimum element
  - max
```
@NotNull
public OptionalLong max()
```
    Returns an OptionalLong describing the maximum element of this stream, or an empty optional if this stream is empty.
    This is a terminal operation.
    
    Returns:
    
    the maximum element
  - count
```
public long count()
```
    Returns the count of elements in this stream.
    This is a terminal operation.
    
    Returns:
    
    the count of elements in this stream
  - anyMatch
```
public boolean anyMatch(@NotNull
                        LongPredicate predicate)
```
    Tests whether all elements match the given 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.
    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 of the stream match the provided predicate, otherwise false
  - allMatch
```
public boolean allMatch(@NotNull
                        LongPredicate predicate)
```
    Tests whether all elements match the given 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.
    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 either all elements of the stream match the provided predicate or the stream is empty, otherwise false
  - noneMatch
```
public boolean noneMatch(@NotNull
                         LongPredicate predicate)
```
    Tests whether no elements match the given 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.
    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 either no elements of the stream match the provided predicate or the stream is empty, otherwise false
  - findFirst
```
@NotNull
public OptionalLong findFirst()
```
    Returns the first element wrapped by OptionalLong class. If stream is empty, returns OptionalLong.empty().
    This is a short-circuiting terminal operation.
    
    Returns:
    
    an OptionalLong with first element or OptionalLong.empty() if stream is empty
  - findFirstOrElse
```
public long findFirstOrElse(long other)
```
    Returns the first element if stream is not empty, otherwise returns other.
    This is a short-circuiting terminal operation.
    
    Parameters:
    
    other - the value to be returned if stream is empty
    
    Returns:
    
    first element or other if stream is empty
    
    Since:
    
    1.2.2
  - findLast
```
@NotNull
public OptionalLong findLast()
```
    Returns the last element wrapped by OptionalLong class. If stream is empty, returns OptionalLong.empty().
    This is a short-circuiting terminal operation.
    
    Returns:
    
    an OptionalLong with the last element or OptionalLong.empty() if the stream is empty
    
    Since:
    
    1.1.8
  - single
```
public long 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
  - findSingle
```
@NotNull
public OptionalLong findSingle()
```
    Returns the single element wrapped by OptionalLong class. If stream is empty, returns OptionalLong.empty(). If stream contains more than one element, throws IllegalStateException.
    This is a short-circuiting terminal operation.
    Example:
```
 stream: []
 result: OptionalLong.empty()

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

 stream: [1, 2, 3]
 result: IllegalStateException
 
```
    Returns:
    
    an OptionalLong with single element or OptionalLong.empty() if stream is empty
    
    Throws:
    
    java.lang.IllegalStateException - if stream contains more than one element
  - onClose
```
@NotNull
public LongStream onClose(@NotNull
                                   java.lang.Runnable closeHandler)
```
    Adds close handler to the current stream.
    This is an intermediate operation.
    
    Parameters:
    
    closeHandler - an action to execute when the stream is closed
    
    Returns:
    
    the new stream with the close handler
    
    Since:
    
    1.1.8
  - close
```
public void close()
```
    Causes close handler to be invoked if it exists. Since most of the stream providers are lists or arrays, it is not necessary to close the stream.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Since:
    
    1.1.8

Class LongStream

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

of

of

range

rangeClosed

generate

iterate

iterate

concat

concat

iterator

custom

boxed

prepend

append

filter

filterIndexed

filterIndexed

filterNot

map

mapIndexed

mapIndexed

mapToObj

mapToInt

mapToDouble

flatMap

mapMulti

distinct

sorted

sorted

sample

peek

scan

scan

takeWhile

takeUntil

dropWhile

limit

skip

forEach

forEachIndexed

forEachIndexed

reduce

reduce

toArray

collect

sum

min

max

count

anyMatch

allMatch

noneMatch

findFirst

findFirstOrElse

findLast

single

findSingle

onClose

close