DebugLongStream (CodelanxCommons 0.3.2-SNAPSHOT API)

java.lang.Object
- com.codelanx.commons.util.stream.DebugLongStream

All Implemented Interfaces:

DebuggableStreaming<Long>, AutoCloseable, BaseStream<Long,LongStream>, LongStream
```
public class DebugLongStream
extends Object
implements LongStream, DebuggableStreaming<Long>
```
A debuggable and extendable LongStream wrapper, which allows overriding of only two methods to allow seeing stream operation in realtime.

Since:

0.3.1

Version:

0.3.1

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.stream.LongStream
  LongStream.Builder

Constructor Summary

Constructors
Modifier Constructor and Description

protected DebugLongStream(LongStream stream, boolean outputResults)

Constructors
Modifier	Constructor and Description
`protected`	`DebugLongStream(LongStream stream, boolean outputResults)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allMatch(LongPredicate predicate)`
`boolean`	`anyMatch(LongPredicate predicate)`
`DoubleStream`	`asDoubleStream()`
`OptionalDouble`	`average()`
`Stream<Long>`	`boxed()`
`void`	`close()`
`<R> R`	`collect(Supplier<R> supplier, ObjLongConsumer<R> accumulator, BiConsumer<R,R> combiner)`
`long`	`count()`
`LongStream`	`distinct()`
`LongStream`	`filter(LongPredicate predicate)`
`OptionalLong`	`findAny()`
`OptionalLong`	`findFirst()`
`LongStream`	`flatMap(LongFunction<? extends LongStream> mapper)`
`static <D> DebugLongStream`	`flatMapFromObject(DebuggableStreaming<D> debugStream, Function<? super D,? extends LongStream> mapper)`
`void`	`forEach(LongConsumer action)`
`void`	`forEachOrdered(LongConsumer action)`
`Stream<Long>`	`getRawStream()`
`boolean`	`isOutputtingResults()`
`boolean`	`isParallel()`
`PrimitiveIterator.OfLong`	`iterator()`
`LongStream`	`limit(long maxSize)`
`LongStream`	`map(LongUnaryOperator mapper)`
`static <D> DebugLongStream`	`mapFromObject(DebuggableStreaming<D> debugStream, ToLongFunction<? super D> mapper)`
`DoubleStream`	`mapToDouble(LongToDoubleFunction mapper)`
`IntStream`	`mapToInt(LongToIntFunction mapper)`
`<U> Stream<U>`	`mapToObj(LongFunction<? extends U> mapper)`
`OptionalLong`	`max()`
`OptionalLong`	`min()`
`boolean`	`noneMatch(LongPredicate predicate)`
`static DebugLongStream`	`of(LongStream stream)` Creates a new `DebugLongStream` using the default type
`static DebugLongStream`	`of(LongStream stream, boolean outputResults)` Creates a new `DebugLongStream` using the default type
`static DebugLongStream`	`of(LongStream stream, boolean outputResults, Class<? extends DebugLongStream> type)` Instantiates a new `DebugLongStream` of the type parameter passed to the method.
`static DebugLongStream`	`of(LongStream stream, Class<? extends DebugLongStream> type)` Instantiates a new `DebugLongStream` of the type parameter passed to the method.
`LongStream`	`onClose(Runnable closeHandler)`
`protected <R> R`	`operate(Function<? super LongStream,? extends R> action)` Overridable method which runs the appropriate `Stream` action, and outputs the result as well as which numerical call it is.
`protected void`	`operateVoid(Consumer<? super LongStream> action)` Overridable method which runs the appropriate `Stream` action, and outputs the result as well as which numerical call it is.
`LongStream`	`parallel()`
`LongStream`	`peek(LongConsumer action)`
`OptionalLong`	`reduce(LongBinaryOperator op)`
`long`	`reduce(long identity, LongBinaryOperator op)`
`LongStream`	`sequential()`
`LongStream`	`skip(long n)`
`LongStream`	`sorted()`
`Spliterator.OfLong`	`spliterator()`
`long`	`sum()`
`LongSummaryStatistics`	`summaryStatistics()`
`long[]`	`toArray()`
`LongStream`	`unordered()`

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

Methods inherited from interface java.util.stream.LongStream
builder, concat, empty, generate, iterate, of, of, range, rangeClosed

- Constructor Detail
  - DebugLongStream
```
protected DebugLongStream(LongStream stream,
                          boolean outputResults)
```
- Method Detail
  - of
```
public static DebugLongStream of(LongStream stream)
```
    Creates a new DebugLongStream using the default type
    
    Parameters:
    
    stream - The LongStream to wrap
    
    Returns:
    
    A new DebugLongStream wrapper of the provided LongStream
    
    Since:
    
    0.3.1
  - of
```
public static DebugLongStream of(LongStream stream,
                                 boolean outputResults)
```
    Creates a new DebugLongStream using the default type
    
    Parameters:
    
    stream - The LongStream to wrap
    
    outputResults - true to output the results of the LongStream as it is operated upon
    
    Returns:
    
    A new DebugLongStream wrapper of the provided LongStream
    
    Since:
    
    0.3.1
  - of
```
public static DebugLongStream of(LongStream stream,
                                 Class<? extends DebugLongStream> type)
```
    Instantiates a new DebugLongStream of the type parameter passed to the method. This is the appropriate way to instantiate the DebugLongStream, as future caching mechanisms will be in place to optimize this. You may however expose the constructor if you so choose.
    
    Parameters:
    
    stream - The LongStream to create a DebugLongStream of.
    
    type - The class representing the type of the DebugLongStream to instantiate
    
    Returns:
    
    A new DebugLongStream of the provided LongStream
    
    Since:
    
    0.3.1
  - of
```
public static DebugLongStream of(LongStream stream,
                                 boolean outputResults,
                                 Class<? extends DebugLongStream> type)
```
    Instantiates a new DebugLongStream of the type parameter passed to the method. This is the appropriate way to instantiate the DebugLongStream, as future caching mechanisms will be in place to optimize this. You may however expose the constructor if you so choose.
    
    Parameters:
    
    stream - The LongStream to create a DebugLongStream of.
    
    outputResults - true to output the results of the LongStream as it is operated upon
    
    type - The class representing the type of the DebugLongStream to instantiate
    
    Returns:
    
    A new DebugLongStream of the provided LongStream, or the base class instance of DebugLongStream if the type either failed to instantiate or was null.
    
    Since:
    
    0.3.1
  - operate
```
protected <R> R operate(Function<? super LongStream,? extends R> action)
```
    Overridable method which runs the appropriate Stream action, and outputs the result as well as which numerical call it is. For example, the third #filter calll will be printed as DebugStream#filter[2]: <result>. The output of result will be substringed to a maximum of 50 characters, to keep the console from being spammed with large datasets. Additionally, method names with differing method parameters will be grouped under the same aliases and therefore, the same method "counter".
    
    Please note the performance impacts of this method, if this is a standard stream operation and result output is enabled, the Stream will need to be recreated each time.
    
    Type Parameters:
    
    R - The return type of the action
    
    Parameters:
    
    action - The Function representing the action taken on the Stream
    
    Returns:
    
    The result of the call on the Stream
    
    Since:
    
    0.3.1
  - operateVoid
```
protected void operateVoid(Consumer<? super LongStream> action)
```
    Overridable method which runs the appropriate Stream action, and outputs the result as well as which numerical call it is. Due to this being a void operation on a Consumer, the result output will always be null.
    
    Parameters:
    
    action - The Consumer representing the action taken on the Stream
    
    Since:
    
    0.3.1
    
    See Also:
    
    DebugStream.operate(Function)
  - mapFromObject
```
public static <D> DebugLongStream mapFromObject(DebuggableStreaming<D> debugStream,
                                                ToLongFunction<? super D> mapper)
```
  - flatMapFromObject
```
public static <D> DebugLongStream flatMapFromObject(DebuggableStreaming<D> debugStream,
                                                    Function<? super D,? extends LongStream> mapper)
```
  - filter
```
public LongStream filter(LongPredicate predicate)
```
    Specified by:
    
    filter in interface LongStream
  - map
```
public LongStream map(LongUnaryOperator mapper)
```
    Specified by:
    
    map in interface LongStream
  - mapToObj
```
public <U> Stream<U> mapToObj(LongFunction<? extends U> mapper)
```
    Specified by:
    
    mapToObj in interface LongStream
  - mapToInt
```
public IntStream mapToInt(LongToIntFunction mapper)
```
    Specified by:
    
    mapToInt in interface LongStream
  - mapToDouble
```
public DoubleStream mapToDouble(LongToDoubleFunction mapper)
```
    Specified by:
    
    mapToDouble in interface LongStream
  - flatMap
```
public LongStream flatMap(LongFunction<? extends LongStream> mapper)
```
    Specified by:
    
    flatMap in interface LongStream
  - distinct
```
public LongStream distinct()
```
    Specified by:
    
    distinct in interface LongStream
  - sorted
```
public LongStream sorted()
```
    Specified by:
    
    sorted in interface LongStream
  - peek
```
public LongStream peek(LongConsumer action)
```
    Specified by:
    
    peek in interface LongStream
  - limit
```
public LongStream limit(long maxSize)
```
    Specified by:
    
    limit in interface LongStream
  - skip
```
public LongStream skip(long n)
```
    Specified by:
    
    skip in interface LongStream
  - forEach
```
public void forEach(LongConsumer action)
```
    Specified by:
    
    forEach in interface LongStream
  - forEachOrdered
```
public void forEachOrdered(LongConsumer action)
```
    Specified by:
    
    forEachOrdered in interface LongStream
  - toArray
```
public long[] toArray()
```
    Specified by:
    
    toArray in interface LongStream
  - reduce
```
public long reduce(long identity,
                   LongBinaryOperator op)
```
    Specified by:
    
    reduce in interface LongStream
  - reduce
```
public OptionalLong reduce(LongBinaryOperator op)
```
    Specified by:
    
    reduce in interface LongStream
  - collect
```
public <R> R collect(Supplier<R> supplier,
                     ObjLongConsumer<R> accumulator,
                     BiConsumer<R,R> combiner)
```
    Specified by:
    
    collect in interface LongStream
  - sum
```
public long sum()
```
    Specified by:
    
    sum in interface LongStream
  - min
```
public OptionalLong min()
```
    Specified by:
    
    min in interface LongStream
  - max
```
public OptionalLong max()
```
    Specified by:
    
    max in interface LongStream
  - count
```
public long count()
```
    Specified by:
    
    count in interface LongStream
  - average
```
public OptionalDouble average()
```
    Specified by:
    
    average in interface LongStream
  - summaryStatistics
```
public LongSummaryStatistics summaryStatistics()
```
    Specified by:
    
    summaryStatistics in interface LongStream
  - anyMatch
```
public boolean anyMatch(LongPredicate predicate)
```
    Specified by:
    
    anyMatch in interface LongStream
  - allMatch
```
public boolean allMatch(LongPredicate predicate)
```
    Specified by:
    
    allMatch in interface LongStream
  - noneMatch
```
public boolean noneMatch(LongPredicate predicate)
```
    Specified by:
    
    noneMatch in interface LongStream
  - findFirst
```
public OptionalLong findFirst()
```
    Specified by:
    
    findFirst in interface LongStream
  - findAny
```
public OptionalLong findAny()
```
    Specified by:
    
    findAny in interface LongStream
  - asDoubleStream
```
public DoubleStream asDoubleStream()
```
    Specified by:
    
    asDoubleStream in interface LongStream
  - boxed
```
public Stream<Long> boxed()
```
    Specified by:
    
    boxed in interface LongStream
  - sequential
```
public LongStream sequential()
```
    Specified by:
    
    sequential in interface BaseStream<Long,LongStream>
    
    Specified by:
    
    sequential in interface LongStream
  - parallel
```
public LongStream parallel()
```
    Specified by:
    
    parallel in interface BaseStream<Long,LongStream>
    
    Specified by:
    
    parallel in interface LongStream
  - unordered
```
public LongStream unordered()
```
    Specified by:
    
    unordered in interface BaseStream<Long,LongStream>
  - onClose
```
public LongStream onClose(Runnable closeHandler)
```
    Specified by:
    
    onClose in interface BaseStream<Long,LongStream>
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface BaseStream<Long,LongStream>
  - iterator
```
public PrimitiveIterator.OfLong iterator()
```
    Specified by:
    
    iterator in interface BaseStream<Long,LongStream>
    
    Specified by:
    
    iterator in interface LongStream
  - spliterator
```
public Spliterator.OfLong spliterator()
```
    Specified by:
    
    spliterator in interface BaseStream<Long,LongStream>
    
    Specified by:
    
    spliterator in interface LongStream
  - isParallel
```
public boolean isParallel()
```
    Specified by:
    
    isParallel in interface BaseStream<Long,LongStream>
  - getRawStream
```
public Stream<Long> getRawStream()
```
    Specified by:
    
    getRawStream in interface DebuggableStreaming<Long>
  - isOutputtingResults
```
public boolean isOutputtingResults()
```
    Specified by:
    
    isOutputtingResults in interface DebuggableStreaming<Long>

Class DebugLongStream

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.stream.LongStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.stream.LongStream

Constructor Detail

DebugLongStream

Method Detail

of

of

of

of

operate

operateVoid

mapFromObject

flatMapFromObject

filter

map

mapToObj

mapToInt

mapToDouble

flatMap

distinct

sorted

peek

limit

skip

forEach

forEachOrdered

toArray

reduce

reduce

collect

sum

min

max

count

average

summaryStatistics

anyMatch

allMatch

noneMatch

findFirst

findAny

asDoubleStream

boxed

sequential

parallel

unordered

onClose

close

iterator

spliterator

isParallel

getRawStream

isOutputtingResults