UberStream (whakamatautau-util 0.0.9.1 API)

java.lang.Object
- org.whaka.util.function.UberStream<T>

All Implemented Interfaces:

java.lang.AutoCloseable, java.util.stream.BaseStream<T,java.util.stream.Stream<T>>, java.util.stream.Stream<T>
```
public class UberStream<T>
extends java.lang.Object
implements java.util.stream.Stream<T>
```
Proxy class for any Stream. Class implements Stream interface, so it can be used as one. Provides various additional useful methods.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.stream.Stream
  java.util.stream.Stream.Builder<T>

Constructor Summary

Constructors
Constructor and Description

UberStream(java.util.stream.Stream<T> actual)

Constructors
Constructor and Description
`UberStream(java.util.stream.Stream<T> actual)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allMatch(java.util.function.Predicate<? super T> predicate)`
`boolean`	`anyMatch(java.util.function.Predicate<? super T> predicate)`
`void`	`close()`
`<R,A> R`	`collect(java.util.stream.Collector<? super T,A,R> collector)`
`<R> R`	`collect(java.util.function.Supplier<R> supplier, java.util.function.BiConsumer<R,? super T> accumulator, java.util.function.BiConsumer<R,R> combiner)`
`long`	`count()`
`UberStream<T>`	`distinct()`
`UberStream<T>`	`drop(java.util.function.Predicate<? super T> predicate)` Filter out all elements that match specified predicate.
`UberStream<T>`	`dropNulls()` Filter out all null elements.
`UberStream<T>`	`filter(java.util.function.Predicate<? super T> predicate)`
`<R extends T> UberStream<R>`	`filterByClass(java.lang.Class<R> filteredClass)` Filter only instances of the specified class (or nulls) and cast them to the specified type.
`java.util.Optional<T>`	`find(java.util.function.Predicate<? super T> predicate)` Find first element matching specified predicate.
`java.util.Optional<T>`	`findAny()`
`java.util.Optional<T>`	`findFirst()`
`<R> UberStream<R>`	`flatMap(java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends R>> mapper)`
`<R> UberStream<R>`	`flatMapArr(java.util.function.Function<? super T,R[]> mapper)` Maps each element of the stream into array and them flattens result stream.
`<R> UberStream<R>`	`flatMapCol(java.util.function.Function<? super T,? extends java.util.Collection<? extends R>> mapper)` Maps each element of the stream into collection and them flattens result stream.
`java.util.stream.DoubleStream`	`flatMapToDouble(java.util.function.Function<? super T,? extends java.util.stream.DoubleStream> mapper)`
`java.util.stream.IntStream`	`flatMapToInt(java.util.function.Function<? super T,? extends java.util.stream.IntStream> mapper)`
`java.util.stream.LongStream`	`flatMapToLong(java.util.function.Function<? super T,? extends java.util.stream.LongStream> mapper)`
`void`	`forEach(java.util.function.Consumer<? super T> action)`
`void`	`forEachOrdered(java.util.function.Consumer<? super T> action)`
`boolean`	`isParallel()`
`java.util.Iterator<T>`	`iterator()`
`java.lang.String`	`join(java.lang.CharSequence delimiter)` All elements of the stream are mapped to string using `String.valueOf(Object)`.
`java.lang.String`	`join(java.lang.CharSequence delimiter, java.lang.CharSequence prefix, java.lang.CharSequence suffix)` All elements of the stream are mapped to string using `String.valueOf(Object)`.
`UberStream<T>`	`limit(long maxSize)`
`<R> UberStream<R>`	`map(java.util.function.Function<? super T,? extends R> mapper)`
`java.util.stream.DoubleStream`	`mapToDouble(java.util.function.ToDoubleFunction<? super T> mapper)`
`java.util.stream.IntStream`	`mapToInt(java.util.function.ToIntFunction<? super T> mapper)`
`java.util.stream.LongStream`	`mapToLong(java.util.function.ToLongFunction<? super T> mapper)`
`java.util.Optional<T>`	`max(java.util.Comparator<? super T> comparator)`
`java.util.Optional<T>`	`min(java.util.Comparator<? super T> comparator)`
`boolean`	`noneMatch(java.util.function.Predicate<? super T> predicate)`
`UberStream<T>`	`onClose(java.lang.Runnable closeHandler)`
`UberStream<T>`	`parallel()`
`UberStream<T>`	`peek(java.util.function.Consumer<? super T> action)`
`java.util.Optional<T>`	`reduce(java.util.function.BinaryOperator<T> accumulator)`
`T`	`reduce(T identity, java.util.function.BinaryOperator<T> accumulator)`
`<U> U`	`reduce(U identity, java.util.function.BiFunction<U,? super T,U> accumulator, java.util.function.BinaryOperator<U> combiner)`
`UberStream<T>`	`sequential()`
`UberStream<T>`	`skip(long n)`
`UberStream<T>`	`sorted()`
`UberStream<T>`	`sorted(java.util.Comparator<? super T> comparator)`
`java.util.Spliterator<T>`	`spliterator()`
`<C extends java.util.Collection<T>> C`	`to(java.util.function.Supplier<C> factory)` Collect all elements of the stream into a collection provided by the specified factory.
`java.lang.Object[]`	`toArray()`
`<A> A[]`	`toArray(java.lang.Class<A> type)`
`<A> A[]`	`toArray(java.util.function.IntFunction<A[]> generator)`
`java.util.List<T>`	`toList()` Collect all elements of the stream into a list.
`<K> java.util.Map<K,T>`	`toMap(java.util.function.Function<T,K> keyFunction)` Specified function is applied to each element of the stream.
`<K,V> java.util.Map<K,V>`	`toMap(java.util.function.Function<T,K> keyFunction, java.util.function.Function<T,V> valFunction)` Specified functions are applied to each element of the stream.
`<K,V,M extends java.util.Map<K,V>> M`	`toMap(java.util.function.Function<T,K> keyFunction, java.util.function.Function<T,V> valFunction, java.util.function.Supplier<M> mapSupplier)` Specified functions are applied to each element of the stream.
`<K,M extends java.util.Map<K,T>> M`	`toMap(java.util.function.Function<T,K> keyFunction, java.util.function.Supplier<M> mapSupplier)` Specified function is applied to each element of the stream.
`<K> MapStream<K,T>`	`toMapStream(java.util.function.Function<T,K> keyFunction)` Equal to calling `toMap(Function)` and then constructing new `MapStream`.
`<K,V> MapStream<K,V>`	`toMapStream(java.util.function.Function<T,K> keyFunction, java.util.function.Function<T,V> valFunction)` Equal to calling `toMap(Function, Function)` and then constructing new `MapStream`.
`java.util.Set<T>`	`toSet()` Collect all elements of the stream into a set.
`UberStream<T>`	`unordered()`
`<V> UberStream<UberMaps.Entry<T,V>>`	`zip(java.util.function.Function<T,V> mapper)`

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, of, of

Constructor Detail

UberStream

public UberStream(java.util.stream.Stream<T> actual)

Method Detail

iterator
```
public java.util.Iterator<T> iterator()
```
Specified by:

iterator in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

spliterator
```
public java.util.Spliterator<T> spliterator()
```
Specified by:

spliterator in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

isParallel
```
public boolean isParallel()
```
Specified by:

isParallel in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

sequential
```
public UberStream<T> sequential()
```
Specified by:

sequential in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

parallel
```
public UberStream<T> parallel()
```
Specified by:

parallel in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

unordered
```
public UberStream<T> unordered()
```
Specified by:

unordered in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

onClose
```
public UberStream<T> onClose(java.lang.Runnable closeHandler)
```
Specified by:

onClose in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

close
```
public void close()
```
Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

filter

public UberStream<T> filter(java.util.function.Predicate<? super T> predicate)

Specified by:: filter in interface java.util.stream.Stream<T>

filterByClass

public <R extends T> UberStream<R> filterByClass(java.lang.Class<R> filteredClass)

Filter only instances of the specified class (or nulls) and cast them to the specified type.

        #filter(x -> x == null || filteredClass.isInstance(x))
                .map(x -> filteredClass.cast(x));

Note: nulls survive the filtering! Use separate filter or dropNulls() to filter them out!

drop

public UberStream<T> drop(java.util.function.Predicate<? super T> predicate)

Filter out all elements that match specified predicate. Equal to:

        #filter(not(predicate));

dropNulls

public UberStream<T> dropNulls()

Filter out all null elements. Equal to:

        #filter(Objects::nonNull);

find

public java.util.Optional<T> find(java.util.function.Predicate<? super T> predicate)

Find first element matching specified predicate. Equal to:

        #filter(predicate).findFirst();

map

public <R> UberStream<R> map(java.util.function.Function<? super T,? extends R> mapper)

Specified by:: map in interface java.util.stream.Stream<T>

mapToInt

public java.util.stream.IntStream mapToInt(java.util.function.ToIntFunction<? super T> mapper)

Specified by:: mapToInt in interface java.util.stream.Stream<T>

mapToLong

public java.util.stream.LongStream mapToLong(java.util.function.ToLongFunction<? super T> mapper)

Specified by:: mapToLong in interface java.util.stream.Stream<T>

mapToDouble

public java.util.stream.DoubleStream mapToDouble(java.util.function.ToDoubleFunction<? super T> mapper)

Specified by:: mapToDouble in interface java.util.stream.Stream<T>

flatMap

public <R> UberStream<R> flatMap(java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends R>> mapper)

Specified by:: flatMap in interface java.util.stream.Stream<T>

flatMapCol

public <R> UberStream<R> flatMapCol(java.util.function.Function<? super T,? extends java.util.Collection<? extends R>> mapper)

Maps each element of the stream into collection and them flattens result stream. Equal to:

        #flatMap(e -> mapper.apply(e).stream())

flatMapArr

public <R> UberStream<R> flatMapArr(java.util.function.Function<? super T,R[]> mapper)

Maps each element of the stream into array and them flattens result stream. Equal to:

        #flatMap(e -> Stream.of(mapper.apply(e)))

flatMapToInt

public java.util.stream.IntStream flatMapToInt(java.util.function.Function<? super T,? extends java.util.stream.IntStream> mapper)

Specified by:: flatMapToInt in interface java.util.stream.Stream<T>

flatMapToLong

public java.util.stream.LongStream flatMapToLong(java.util.function.Function<? super T,? extends java.util.stream.LongStream> mapper)

Specified by:: flatMapToLong in interface java.util.stream.Stream<T>

flatMapToDouble

public java.util.stream.DoubleStream flatMapToDouble(java.util.function.Function<? super T,? extends java.util.stream.DoubleStream> mapper)

Specified by:: flatMapToDouble in interface java.util.stream.Stream<T>

zip

public <V> UberStream<UberMaps.Entry<T,V>> zip(java.util.function.Function<T,V> mapper)

distinct
```
public UberStream<T> distinct()
```
Specified by:

distinct in interface java.util.stream.Stream<T>

sorted
```
public UberStream<T> sorted()
```
Specified by:

sorted in interface java.util.stream.Stream<T>

sorted

public UberStream<T> sorted(java.util.Comparator<? super T> comparator)

Specified by:: sorted in interface java.util.stream.Stream<T>

peek

public UberStream<T> peek(java.util.function.Consumer<? super T> action)

Specified by:: peek in interface java.util.stream.Stream<T>

limit
```
public UberStream<T> limit(long maxSize)
```
Specified by:

limit in interface java.util.stream.Stream<T>

skip
```
public UberStream<T> skip(long n)
```
Specified by:

skip in interface java.util.stream.Stream<T>

forEach

public void forEach(java.util.function.Consumer<? super T> action)

Specified by:: forEach in interface java.util.stream.Stream<T>

forEachOrdered
```
public void forEachOrdered(java.util.function.Consumer<? super T> action)
```
Specified by:

forEachOrdered in interface java.util.stream.Stream<T>

toArray
```
public java.lang.Object[] toArray()
```
Specified by:

toArray in interface java.util.stream.Stream<T>

toArray

public <A> A[] toArray(java.util.function.IntFunction<A[]> generator)

Specified by:: toArray in interface java.util.stream.Stream<T>

toArray

public <A> A[] toArray(java.lang.Class<A> type)

reduce

public T reduce(T identity,
                java.util.function.BinaryOperator<T> accumulator)

Specified by:: reduce in interface java.util.stream.Stream<T>

reduce

public java.util.Optional<T> reduce(java.util.function.BinaryOperator<T> accumulator)

Specified by:: reduce in interface java.util.stream.Stream<T>

reduce

public <U> U reduce(U identity,
                    java.util.function.BiFunction<U,? super T,U> accumulator,
                    java.util.function.BinaryOperator<U> combiner)

Specified by:: reduce in interface java.util.stream.Stream<T>

collect

public <R> R collect(java.util.function.Supplier<R> supplier,
                     java.util.function.BiConsumer<R,? super T> accumulator,
                     java.util.function.BiConsumer<R,R> combiner)

Specified by:: collect in interface java.util.stream.Stream<T>

collect

public <R,A> R collect(java.util.stream.Collector<? super T,A,R> collector)

Specified by:: collect in interface java.util.stream.Stream<T>

to

public <C extends java.util.Collection<T>> C to(java.util.function.Supplier<C> factory)

Collect all elements of the stream into a collection provided by the specified factory.

toList
```
public java.util.List<T> toList()
```
Collect all elements of the stream into a list.

toSet
```
public java.util.Set<T> toSet()
```
Collect all elements of the stream into a set.

toMap
```
public <K> java.util.Map<K,T> toMap(java.util.function.Function<T,K> keyFunction)
```
Specified function is applied to each element of the stream. Results are used as keys in the result map. Values are the elements themselves. Equal to:
```
        #collect(MapCollectors.toMap(keyFunction, e -> e));
 
```
Note: merges are resolved as "last one is to stay", so keys duplication is allowed.
See Also:

MapCollectors.toMap(Function, Function)

toMap
```
public <K,V> java.util.Map<K,V> toMap(java.util.function.Function<T,K> keyFunction,
                                      java.util.function.Function<T,V> valFunction)
```
Specified functions are applied to each element of the stream. Results are used as key/value pairs in the result map. Equal to:
```
        #collect(MapCollectors.toMap(keyFunction, valFunction));
 
```
Note: merges are resolved as "last one is to stay", so keys duplication is allowed.
See Also:

MapCollectors.toMap(Function, Function)

toMap
```
public <K,M extends java.util.Map<K,T>> M toMap(java.util.function.Function<T,K> keyFunction,
                                                java.util.function.Supplier<M> mapSupplier)
```
Specified function is applied to each element of the stream. Results are used as keys in the result map. Values are the elements themselves. Map is created from the specified supplier. Equal to:
```
        #collect(MapCollectors.toMap(keyFunction, e -> e, mapSupplier));
 
```
Note: merges are resolved as "last one is to stay", so keys duplication is allowed.
See Also:

MapCollectors.toMap(Function, Function, Supplier)

toMap

public <K,V,M extends java.util.Map<K,V>> M toMap(java.util.function.Function<T,K> keyFunction,
                                                  java.util.function.Function<T,V> valFunction,
                                                  java.util.function.Supplier<M> mapSupplier)

Specified functions are applied to each element of the stream. Results are used as key/value pairs in the result map. Map is created from the specified supplier. Equal to:

        #collect(MapCollectors.toMap(keyFunction, valFunction, mapSupplier));

Note: merges are resolved as "last one is to stay", so keys duplication is allowed.

See Also:: MapCollectors.toMap(Function, Function, Supplier)

toMapStream

public <K> MapStream<K,T> toMapStream(java.util.function.Function<T,K> keyFunction)

Equal to calling toMap(Function) and then constructing new MapStream.

toMapStream

public <K,V> MapStream<K,V> toMapStream(java.util.function.Function<T,K> keyFunction,
                                        java.util.function.Function<T,V> valFunction)

Equal to calling toMap(Function, Function) and then constructing new MapStream.

join
```
public java.lang.String join(java.lang.CharSequence delimiter)
```
All elements of the stream are mapped to string using String.valueOf(Object). Then all elements are concatenated to string using specified delimiter. Equal to:
```
        #map(String::valueOf).collect(Collectors.joining(delimiter));
 
```

join

public java.lang.String join(java.lang.CharSequence delimiter,
                             java.lang.CharSequence prefix,
                             java.lang.CharSequence suffix)

All elements of the stream are mapped to string using String.valueOf(Object). Then all elements are concatenated to string using specified delimiter, prefix, and suffix. Equal to:

        #map(String::valueOf).collect(Collectors.joining(delimiter, prefix, suffix));

min

public java.util.Optional<T> min(java.util.Comparator<? super T> comparator)

Specified by:: min in interface java.util.stream.Stream<T>

max

public java.util.Optional<T> max(java.util.Comparator<? super T> comparator)

Specified by:: max in interface java.util.stream.Stream<T>

count
```
public long count()
```
Specified by:

count in interface java.util.stream.Stream<T>

anyMatch

public boolean anyMatch(java.util.function.Predicate<? super T> predicate)

Specified by:: anyMatch in interface java.util.stream.Stream<T>

allMatch

public boolean allMatch(java.util.function.Predicate<? super T> predicate)

Specified by:: allMatch in interface java.util.stream.Stream<T>

noneMatch

public boolean noneMatch(java.util.function.Predicate<? super T> predicate)

Specified by:: noneMatch in interface java.util.stream.Stream<T>

findFirst
```
public java.util.Optional<T> findFirst()
```
Specified by:

findFirst in interface java.util.stream.Stream<T>

findAny
```
public java.util.Optional<T> findAny()
```
Specified by:

findAny in interface java.util.stream.Stream<T>

Class UberStream<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

UberStream

Method Detail

iterator

spliterator

isParallel

sequential

parallel

unordered

onClose

close

filter

filterByClass

drop

dropNulls

find

map

mapToInt

mapToLong

mapToDouble

flatMap

flatMapCol

flatMapArr

flatMapToInt

flatMapToLong

flatMapToDouble

zip

distinct

sorted

sorted

peek

limit

skip

forEach

forEachOrdered

toArray

toArray

toArray

reduce

reduce

reduce

collect

collect

to

toList

toSet

toMap

toMap

toMap

toMap

toMapStream

toMapStream

join

join

min

max

count

anyMatch

allMatch

noneMatch

findFirst

findAny