DebugDoubleStream (CodelanxCommons 0.3.2-SNAPSHOT API)

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

All Implemented Interfaces:

DebuggableStreaming<Double>, AutoCloseable, BaseStream<Double,DoubleStream>, DoubleStream
```
public class DebugDoubleStream
extends Object
implements DoubleStream, DebuggableStreaming<Double>
```
A debuggable and extendable DoubleStream 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.DoubleStream
  DoubleStream.Builder

Constructor Summary

Constructors
Modifier Constructor and Description

protected DebugDoubleStream(DoubleStream stream, boolean outputResults)

Constructors
Modifier	Constructor and Description
`protected`	`DebugDoubleStream(DoubleStream stream, boolean outputResults)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allMatch(DoublePredicate predicate)`
`boolean`	`anyMatch(DoublePredicate predicate)`
`OptionalDouble`	`average()`
`Stream<Double>`	`boxed()`
`void`	`close()`
`<R> R`	`collect(Supplier<R> supplier, ObjDoubleConsumer<R> accumulator, BiConsumer<R,R> combiner)`
`long`	`count()`
`DoubleStream`	`distinct()`
`DoubleStream`	`filter(DoublePredicate predicate)`
`OptionalDouble`	`findAny()`
`OptionalDouble`	`findFirst()`
`DoubleStream`	`flatMap(DoubleFunction<? extends DoubleStream> mapper)`
`static <D> DebugDoubleStream`	`flatMapFromObject(DebuggableStreaming<D> debugStream, Function<? super D,? extends DoubleStream> mapper)`
`void`	`forEach(DoubleConsumer action)`
`void`	`forEachOrdered(DoubleConsumer action)`
`Stream<Double>`	`getRawStream()`
`boolean`	`isOutputtingResults()`
`boolean`	`isParallel()`
`PrimitiveIterator.OfDouble`	`iterator()`
`DoubleStream`	`limit(long maxSize)`
`DoubleStream`	`map(DoubleUnaryOperator mapper)`
`static <D> DebugDoubleStream`	`mapFromObject(DebuggableStreaming<D> debugStream, ToDoubleFunction<? super D> mapper)`
`IntStream`	`mapToInt(DoubleToIntFunction mapper)`
`LongStream`	`mapToLong(DoubleToLongFunction mapper)`
`<U> Stream<U>`	`mapToObj(DoubleFunction<? extends U> mapper)`
`OptionalDouble`	`max()`
`OptionalDouble`	`min()`
`boolean`	`noneMatch(DoublePredicate predicate)`
`static DebugDoubleStream`	`of(DoubleStream stream)` Creates a new `DebugDoubleStream` using the default type
`static DebugDoubleStream`	`of(DoubleStream stream, boolean outputResults)` Creates a new `DebugDoubleStream` using the default type
`static DebugDoubleStream`	`of(DoubleStream stream, boolean outputResults, Class<? extends DebugDoubleStream> type)` Instantiates a new `DebugDoubleStream` of the type parameter passed to the method.
`static DebugDoubleStream`	`of(DoubleStream stream, Class<? extends DebugDoubleStream> type)` Instantiates a new `DebugDoubleStream` of the type parameter passed to the method.
`DoubleStream`	`onClose(Runnable closeHandler)`
`protected <R> R`	`operate(Function<? super DoubleStream,? extends R> action)` Overridable method which runs the appropriate `DoubleStream` action, and outputs the result as well as which numerical call it is.
`protected void`	`operateVoid(Consumer<? super DoubleStream> action)` Overridable method which runs the appropriate `DoubleStream` action, and outputs the result as well as which numerical call it is.
`DoubleStream`	`parallel()`
`DoubleStream`	`peek(DoubleConsumer action)`
`OptionalDouble`	`reduce(DoubleBinaryOperator op)`
`double`	`reduce(double identity, DoubleBinaryOperator op)`
`DoubleStream`	`sequential()`
`DoubleStream`	`skip(long n)`
`DoubleStream`	`sorted()`
`Spliterator.OfDouble`	`spliterator()`
`double`	`sum()`
`DoubleSummaryStatistics`	`summaryStatistics()`
`double[]`	`toArray()`
`DoubleStream`	`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.DoubleStream
builder, concat, empty, generate, iterate, of, of

- Constructor Detail
  - DebugDoubleStream
```
protected DebugDoubleStream(DoubleStream stream,
                            boolean outputResults)
```
- Method Detail
  - of
```
public static DebugDoubleStream of(DoubleStream stream)
```
    Creates a new DebugDoubleStream using the default type
    
    Parameters:
    
    stream - The DoubleStream to wrap
    
    Returns:
    
    A new DebugDoubleStream wrapper of the provided DoubleStream
    
    Since:
    
    0.3.1
  - of
```
public static DebugDoubleStream of(DoubleStream stream,
                                   boolean outputResults)
```
    Creates a new DebugDoubleStream using the default type
    
    Parameters:
    
    stream - The DoubleStream to wrap
    
    outputResults - true to output the results of the DoubleStream as it is operated upon
    
    Returns:
    
    A new DebugDoubleStream wrapper of the provided DoubleStream
    
    Since:
    
    0.3.1
  - of
```
public static DebugDoubleStream of(DoubleStream stream,
                                   Class<? extends DebugDoubleStream> type)
```
    Instantiates a new DebugDoubleStream of the type parameter passed to the method. This is the appropriate way to instantiate the DebugDoubleStream, as future caching mechanisms will be in place to optimize this. You may however expose the constructor if you so choose.
    
    Parameters:
    
    stream - The DoubleStream to create a DebugDoubleStream of.
    
    type - The class representing the type of the DebugDoubleStream to instantiate
    
    Returns:
    
    A new DebugDoubleStream of the provided DoubleStream
    
    Since:
    
    0.3.1
  - of
```
public static DebugDoubleStream of(DoubleStream stream,
                                   boolean outputResults,
                                   Class<? extends DebugDoubleStream> type)
```
    Instantiates a new DebugDoubleStream of the type parameter passed to the method. This is the appropriate way to instantiate the DebugDoubleStream, as future caching mechanisms will be in place to optimize this. You may however expose the constructor if you so choose.
    
    Parameters:
    
    stream - The DoubleStream to create a DebugDoubleStream of.
    
    outputResults - true to output the results of the DoubleStream as it is operated upon
    
    type - The class representing the type of the DebugDoubleStream to instantiate
    
    Returns:
    
    A new DebugDoubleStream of the provided DoubleStream, or the base class instance of DebugDoubleStream if the type either failed to instantiate or was null.
    
    Since:
    
    0.3.1
  - operate
```
protected <R> R operate(Function<? super DoubleStream,? extends R> action)
```
    Overridable method which runs the appropriate DoubleStream 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 DoubleStream 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 DoubleStream
    
    Returns:
    
    The result of the call on the DoubleStream
    
    Since:
    
    0.3.1
  - operateVoid
```
protected void operateVoid(Consumer<? super DoubleStream> action)
```
    Overridable method which runs the appropriate DoubleStream 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 DoubleStream
    
    Since:
    
    0.3.1
    
    See Also:
    
    DebugStream.operate(Function)
  - mapFromObject
```
public static <D> DebugDoubleStream mapFromObject(DebuggableStreaming<D> debugStream,
                                                  ToDoubleFunction<? super D> mapper)
```
  - flatMapFromObject
```
public static <D> DebugDoubleStream flatMapFromObject(DebuggableStreaming<D> debugStream,
                                                      Function<? super D,? extends DoubleStream> mapper)
```
  - filter
```
public DoubleStream filter(DoublePredicate predicate)
```
    Specified by:
    
    filter in interface DoubleStream
  - map
```
public DoubleStream map(DoubleUnaryOperator mapper)
```
    Specified by:
    
    map in interface DoubleStream
  - mapToObj
```
public <U> Stream<U> mapToObj(DoubleFunction<? extends U> mapper)
```
    Specified by:
    
    mapToObj in interface DoubleStream
  - mapToLong
```
public LongStream mapToLong(DoubleToLongFunction mapper)
```
    Specified by:
    
    mapToLong in interface DoubleStream
  - mapToInt
```
public IntStream mapToInt(DoubleToIntFunction mapper)
```
    Specified by:
    
    mapToInt in interface DoubleStream
  - flatMap
```
public DoubleStream flatMap(DoubleFunction<? extends DoubleStream> mapper)
```
    Specified by:
    
    flatMap in interface DoubleStream
  - distinct
```
public DoubleStream distinct()
```
    Specified by:
    
    distinct in interface DoubleStream
  - sorted
```
public DoubleStream sorted()
```
    Specified by:
    
    sorted in interface DoubleStream
  - peek
```
public DoubleStream peek(DoubleConsumer action)
```
    Specified by:
    
    peek in interface DoubleStream
  - limit
```
public DoubleStream limit(long maxSize)
```
    Specified by:
    
    limit in interface DoubleStream
  - skip
```
public DoubleStream skip(long n)
```
    Specified by:
    
    skip in interface DoubleStream
  - forEach
```
public void forEach(DoubleConsumer action)
```
    Specified by:
    
    forEach in interface DoubleStream
  - forEachOrdered
```
public void forEachOrdered(DoubleConsumer action)
```
    Specified by:
    
    forEachOrdered in interface DoubleStream
  - toArray
```
public double[] toArray()
```
    Specified by:
    
    toArray in interface DoubleStream
  - reduce
```
public double reduce(double identity,
                     DoubleBinaryOperator op)
```
    Specified by:
    
    reduce in interface DoubleStream
  - reduce
```
public OptionalDouble reduce(DoubleBinaryOperator op)
```
    Specified by:
    
    reduce in interface DoubleStream
  - collect
```
public <R> R collect(Supplier<R> supplier,
                     ObjDoubleConsumer<R> accumulator,
                     BiConsumer<R,R> combiner)
```
    Specified by:
    
    collect in interface DoubleStream
  - sum
```
public double sum()
```
    Specified by:
    
    sum in interface DoubleStream
  - min
```
public OptionalDouble min()
```
    Specified by:
    
    min in interface DoubleStream
  - max
```
public OptionalDouble max()
```
    Specified by:
    
    max in interface DoubleStream
  - count
```
public long count()
```
    Specified by:
    
    count in interface DoubleStream
  - average
```
public OptionalDouble average()
```
    Specified by:
    
    average in interface DoubleStream
  - summaryStatistics
```
public DoubleSummaryStatistics summaryStatistics()
```
    Specified by:
    
    summaryStatistics in interface DoubleStream
  - anyMatch
```
public boolean anyMatch(DoublePredicate predicate)
```
    Specified by:
    
    anyMatch in interface DoubleStream
  - allMatch
```
public boolean allMatch(DoublePredicate predicate)
```
    Specified by:
    
    allMatch in interface DoubleStream
  - noneMatch
```
public boolean noneMatch(DoublePredicate predicate)
```
    Specified by:
    
    noneMatch in interface DoubleStream
  - findFirst
```
public OptionalDouble findFirst()
```
    Specified by:
    
    findFirst in interface DoubleStream
  - findAny
```
public OptionalDouble findAny()
```
    Specified by:
    
    findAny in interface DoubleStream
  - boxed
```
public Stream<Double> boxed()
```
    Specified by:
    
    boxed in interface DoubleStream
  - sequential
```
public DoubleStream sequential()
```
    Specified by:
    
    sequential in interface BaseStream<Double,DoubleStream>
    
    Specified by:
    
    sequential in interface DoubleStream
  - parallel
```
public DoubleStream parallel()
```
    Specified by:
    
    parallel in interface BaseStream<Double,DoubleStream>
    
    Specified by:
    
    parallel in interface DoubleStream
  - unordered
```
public DoubleStream unordered()
```
    Specified by:
    
    unordered in interface BaseStream<Double,DoubleStream>
  - onClose
```
public DoubleStream onClose(Runnable closeHandler)
```
    Specified by:
    
    onClose in interface BaseStream<Double,DoubleStream>
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface BaseStream<Double,DoubleStream>
  - iterator
```
public PrimitiveIterator.OfDouble iterator()
```
    Specified by:
    
    iterator in interface BaseStream<Double,DoubleStream>
    
    Specified by:
    
    iterator in interface DoubleStream
  - spliterator
```
public Spliterator.OfDouble spliterator()
```
    Specified by:
    
    spliterator in interface BaseStream<Double,DoubleStream>
    
    Specified by:
    
    spliterator in interface DoubleStream
  - isParallel
```
public boolean isParallel()
```
    Specified by:
    
    isParallel in interface BaseStream<Double,DoubleStream>
  - getRawStream
```
public Stream<Double> getRawStream()
```
    Specified by:
    
    getRawStream in interface DebuggableStreaming<Double>
  - isOutputtingResults
```
public boolean isOutputtingResults()
```
    Specified by:
    
    isOutputtingResults in interface DebuggableStreaming<Double>

Class DebugDoubleStream

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.stream.DoubleStream

Constructor Detail

DebugDoubleStream

Method Detail

of

of

of

of

operate

operateVoid

mapFromObject

flatMapFromObject

filter

map

mapToObj

mapToLong

mapToInt

flatMap

distinct

sorted

peek

limit

skip

forEach

forEachOrdered

toArray

reduce

reduce

collect

sum

min

max

count

average

summaryStatistics

anyMatch

allMatch

noneMatch

findFirst

findAny

boxed

sequential

parallel

unordered

onClose

close

iterator

spliterator

isParallel

getRawStream

isOutputtingResults