DebugStream (CodelanxCommons 0.3.2-SNAPSHOT API)

java.lang.Object
- com.codelanx.commons.util.stream.DebugStream<T>

Type Parameters:

T - The type of the Stream being wrapped

All Implemented Interfaces:

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected DebugStream(Stream<T> stream, boolean outputResults)

Constructors
Modifier	Constructor and Description
`protected`	`DebugStream(Stream<T> stream, boolean outputResults)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allMatch(Predicate<? super T> predicate)`
`boolean`	`anyMatch(Predicate<? super T> predicate)`
`void`	`close()`
`<R,A> R`	`collect(Collector<? super T,A,R> collector)`
`<R> R`	`collect(Supplier<R> supplier, BiConsumer<R,? super T> accumulator, BiConsumer<R,R> combiner)`
`long`	`count()`
`Stream<T>`	`distinct()`
`Stream<T>`	`filter(Predicate<? super T> predicate)`
`Optional<T>`	`findAny()`
`Optional<T>`	`findFirst()`
`<R> Stream<R>`	`flatMap(Function<? super T,? extends Stream<? extends R>> mapper)`
`DoubleStream`	`flatMapToDouble(Function<? super T,? extends DoubleStream> mapper)`
`IntStream`	`flatMapToInt(Function<? super T,? extends IntStream> mapper)`
`LongStream`	`flatMapToLong(Function<? super T,? extends LongStream> mapper)`
`void`	`forEach(Consumer<? super T> action)`
`void`	`forEachOrdered(Consumer<? super T> action)`
`Stream<T>`	`getRawStream()`
`boolean`	`isOutputtingResults()`
`boolean`	`isParallel()`
`Iterator<T>`	`iterator()`
`Stream<T>`	`limit(long maxSize)`
`<R> Stream<R>`	`map(Function<? super T,? extends R> mapper)`
`DoubleStream`	`mapToDouble(ToDoubleFunction<? super T> mapper)`
`IntStream`	`mapToInt(ToIntFunction<? super T> mapper)`
`LongStream`	`mapToLong(ToLongFunction<? super T> mapper)`
`Optional<T>`	`max(Comparator<? super T> comparator)`
`Optional<T>`	`min(Comparator<? super T> comparator)`
`boolean`	`noneMatch(Predicate<? super T> predicate)`
`static <D> DebugStream<D>`	`of(Stream<D> stream)` Creates a new `DebugStream` using the default type
`static <D> DebugStream<D>`	`of(Stream<D> stream, boolean outputResults)` Creates a new `DebugStream` using the default type
`static <D> DebugStream<D>`	`of(Stream<D> stream, boolean outputResults, Class<? extends DebugStream> type)` Instantiates a new `DebugStream` of the type parameter passed to the method.
`static <D> DebugStream<D>`	`of(Stream<D> stream, Class<? extends DebugStream<D>> type)` Instantiates a new `DebugStream` of the type parameter passed to the method.
`Stream<T>`	`onClose(Runnable closeHandler)`
`protected <R> R`	`operate(Function<? super Stream<T>,? 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 Stream<T>> action)` Overridable method which runs the appropriate `Stream` action, and outputs the result as well as which numerical call it is.
`Stream<T>`	`parallel()`
`Stream<T>`	`peek(Consumer<? super T> action)`
`Optional<T>`	`reduce(BinaryOperator<T> accumulator)`
`T`	`reduce(T identity, BinaryOperator<T> accumulator)`
`<U> U`	`reduce(U identity, BiFunction<U,? super T,U> accumulator, BinaryOperator<U> combiner)`
`Stream<T>`	`sequential()`
`Stream<T>`	`skip(long n)`
`Stream<T>`	`sorted()`
`Stream<T>`	`sorted(Comparator<? super T> comparator)`
`Spliterator<T>`	`spliterator()`
`Object[]`	`toArray()`
`<A> A[]`	`toArray(IntFunction<A[]> generator)`
`Stream<T>`	`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.Stream
builder, concat, empty, generate, iterate

- Constructor Detail
  - DebugStream
```
protected DebugStream(Stream<T> stream,
                      boolean outputResults)
```
- Method Detail
  - of
```
public static <D> DebugStream<D> of(Stream<D> stream)
```
    Creates a new DebugStream using the default type
    
    Specified by:
    
    of in interface Stream<T>
    
    Type Parameters:
    
    D - The type of the Stream elements
    
    Parameters:
    
    stream - The Stream to wrap
    
    Returns:
    
    A new DebugStream wrapper of the provided Stream
    
    Since:
    
    0.3.1
  - of
```
public static <D> DebugStream<D> of(Stream<D> stream,
                                    boolean outputResults)
```
    Creates a new DebugStream using the default type
    
    Type Parameters:
    
    D - The type of the Stream elements
    
    Parameters:
    
    stream - The Stream to wrap
    
    outputResults - true to output the results of the Stream as it is operated upon
    
    Returns:
    
    A new DebugStream wrapper of the provided Stream
    
    Since:
    
    0.3.1
  - of
```
public static <D> DebugStream<D> of(Stream<D> stream,
                                    Class<? extends DebugStream<D>> type)
```
    Instantiates a new DebugStream of the type parameter passed to the method. This is the appropriate way to instantiate the DebugStream, as future caching mechanisms will be in place to optimize this. You may however expose the constructor if you so choose.
    
    Type Parameters:
    
    D - The type of the Stream elements
    
    Parameters:
    
    stream - The Stream to create a DebugStream of.
    
    type - The class representing the type of the DebugStream to instantiate
    
    Returns:
    
    A new DebugStream of the provided Stream
    
    Since:
    
    0.3.1
  - of
```
public static <D> DebugStream<D> of(Stream<D> stream,
                                    boolean outputResults,
                                    Class<? extends DebugStream> type)
```
    Instantiates a new DebugStream of the type parameter passed to the method. This is the appropriate way to instantiate the DebugStream, as future caching mechanisms will be in place to optimize this. You may however expose the constructor if you so choose.
    
    Type Parameters:
    
    D - The type of the Stream elements
    
    Parameters:
    
    stream - The Stream to create a DebugStream of.
    
    outputResults - true to output the results of the Stream<T> as it is operated upon
    
    type - The class representing the type of the DebugStream to instantiate
    
    Returns:
    
    A new DebugStream of the provided Stream, or the base class instance of DebugStream if the type either failed to instantiate or was null.
    
    Since:
    
    0.3.1
  - operate
```
protected <R> R operate(Function<? super Stream<T>,? 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 Stream<T>> 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:
    
    operate(Function)
  - filter
```
public Stream<T> filter(Predicate<? super T> predicate)
```
    Specified by:
    
    filter in interface Stream<T>
  - map
```
public <R> Stream<R> map(Function<? super T,? extends R> mapper)
```
    Specified by:
    
    map in interface Stream<T>
  - mapToInt
```
public IntStream mapToInt(ToIntFunction<? super T> mapper)
```
    Specified by:
    
    mapToInt in interface Stream<T>
  - mapToLong
```
public LongStream mapToLong(ToLongFunction<? super T> mapper)
```
    Specified by:
    
    mapToLong in interface Stream<T>
  - mapToDouble
```
public DoubleStream mapToDouble(ToDoubleFunction<? super T> mapper)
```
    Specified by:
    
    mapToDouble in interface Stream<T>
  - flatMap
```
public <R> Stream<R> flatMap(Function<? super T,? extends Stream<? extends R>> mapper)
```
    Specified by:
    
    flatMap in interface Stream<T>
  - flatMapToInt
```
public IntStream flatMapToInt(Function<? super T,? extends IntStream> mapper)
```
    Specified by:
    
    flatMapToInt in interface Stream<T>
  - flatMapToLong
```
public LongStream flatMapToLong(Function<? super T,? extends LongStream> mapper)
```
    Specified by:
    
    flatMapToLong in interface Stream<T>
  - flatMapToDouble
```
public DoubleStream flatMapToDouble(Function<? super T,? extends DoubleStream> mapper)
```
    Specified by:
    
    flatMapToDouble in interface Stream<T>
  - distinct
```
public Stream<T> distinct()
```
    Specified by:
    
    distinct in interface Stream<T>
  - sorted
```
public Stream<T> sorted()
```
    Specified by:
    
    sorted in interface Stream<T>
  - sorted
```
public Stream<T> sorted(Comparator<? super T> comparator)
```
    Specified by:
    
    sorted in interface Stream<T>
  - peek
```
public Stream<T> peek(Consumer<? super T> action)
```
    Specified by:
    
    peek in interface Stream<T>
  - limit
```
public Stream<T> limit(long maxSize)
```
    Specified by:
    
    limit in interface Stream<T>
  - skip
```
public Stream<T> skip(long n)
```
    Specified by:
    
    skip in interface Stream<T>
  - forEach
```
public void forEach(Consumer<? super T> action)
```
    Specified by:
    
    forEach in interface Stream<T>
  - forEachOrdered
```
public void forEachOrdered(Consumer<? super T> action)
```
    Specified by:
    
    forEachOrdered in interface Stream<T>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Stream<T>
  - toArray
```
public <A> A[] toArray(IntFunction<A[]> generator)
```
    Specified by:
    
    toArray in interface Stream<T>
  - reduce
```
public T reduce(T identity,
                BinaryOperator<T> accumulator)
```
    Specified by:
    
    reduce in interface Stream<T>
  - reduce
```
public Optional<T> reduce(BinaryOperator<T> accumulator)
```
    Specified by:
    
    reduce in interface Stream<T>
  - reduce
```
public <U> U reduce(U identity,
                    BiFunction<U,? super T,U> accumulator,
                    BinaryOperator<U> combiner)
```
    Specified by:
    
    reduce in interface Stream<T>
  - collect
```
public <R> R collect(Supplier<R> supplier,
                     BiConsumer<R,? super T> accumulator,
                     BiConsumer<R,R> combiner)
```
    Specified by:
    
    collect in interface Stream<T>
  - collect
```
public <R,A> R collect(Collector<? super T,A,R> collector)
```
    Specified by:
    
    collect in interface Stream<T>
  - min
```
public Optional<T> min(Comparator<? super T> comparator)
```
    Specified by:
    
    min in interface Stream<T>
  - max
```
public Optional<T> max(Comparator<? super T> comparator)
```
    Specified by:
    
    max in interface Stream<T>
  - count
```
public long count()
```
    Specified by:
    
    count in interface Stream<T>
  - anyMatch
```
public boolean anyMatch(Predicate<? super T> predicate)
```
    Specified by:
    
    anyMatch in interface Stream<T>
  - allMatch
```
public boolean allMatch(Predicate<? super T> predicate)
```
    Specified by:
    
    allMatch in interface Stream<T>
  - noneMatch
```
public boolean noneMatch(Predicate<? super T> predicate)
```
    Specified by:
    
    noneMatch in interface Stream<T>
  - findFirst
```
public Optional<T> findFirst()
```
    Specified by:
    
    findFirst in interface Stream<T>
  - findAny
```
public Optional<T> findAny()
```
    Specified by:
    
    findAny in interface Stream<T>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface BaseStream<T,Stream<T>>
  - spliterator
```
public Spliterator<T> spliterator()
```
    Specified by:
    
    spliterator in interface BaseStream<T,Stream<T>>
  - isParallel
```
public boolean isParallel()
```
    Specified by:
    
    isParallel in interface BaseStream<T,Stream<T>>
  - sequential
```
public Stream<T> sequential()
```
    Specified by:
    
    sequential in interface BaseStream<T,Stream<T>>
  - parallel
```
public Stream<T> parallel()
```
    Specified by:
    
    parallel in interface BaseStream<T,Stream<T>>
  - unordered
```
public Stream<T> unordered()
```
    Specified by:
    
    unordered in interface BaseStream<T,Stream<T>>
  - onClose
```
public Stream<T> onClose(Runnable closeHandler)
```
    Specified by:
    
    onClose in interface BaseStream<T,Stream<T>>
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface BaseStream<T,Stream<T>>
  - getRawStream
```
public Stream<T> getRawStream()
```
    Specified by:
    
    getRawStream in interface DebuggableStreaming<T>
  - isOutputtingResults
```
public boolean isOutputtingResults()
```
    Specified by:
    
    isOutputtingResults in interface DebuggableStreaming<T>

Class DebugStream<T>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.stream.Stream

Constructor Detail

DebugStream

Method Detail

of

of

of

of

operate

operateVoid

filter

map

mapToInt

mapToLong

mapToDouble

flatMap

flatMapToInt

flatMapToLong

flatMapToDouble

distinct

sorted

sorted

peek

limit

skip

forEach

forEachOrdered

toArray

toArray

reduce

reduce

reduce

collect

collect

min

max

count

anyMatch

allMatch

noneMatch

findFirst

findAny

iterator

spliterator

isParallel

sequential

parallel

unordered

onClose

close

getRawStream

isOutputtingResults