RichStream (Buck)

Type Parameters:

T - the type of the stream elements.

All Superinterfaces:

AutoCloseable, java.util.stream.BaseStream<T,java.util.stream.Stream<T>>, java.util.stream.Stream<T>
```
public interface RichStream<T>
extends java.util.stream.Stream<T>
```
Java 8 streams with "rich" API (convenience methods).
The default Java 8 Stream implementation is deliberately spartan in API methods in order to avoid dependencies on Collections, and to focus on parallelism. This wrapper adds common operations to the Stream API, mostly inspired by Guava's FluentIterable.

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default RichStream<T>`	`concat(java.util.stream.Stream<? extends T> other)`
`RichStream<T>`	`distinct()`
`static <T> RichStream<T>`	`empty()`
`default <U> RichStream<U>`	`filter(Class<U> cls)` Filter stream elements, returning only those that is an instance of the given class.
`RichStream<T>`	`filter(java.util.function.Predicate<? super T> predicate)`
`<R> RichStream<R>`	`flatMap(java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends R>> mapper)`
`<E extends Exception> void`	`forEachOrderedThrowing(ThrowingConsumer<? super T,E> action)` A variant of `Stream.forEachOrdered(java.util.function.Consumer<? super T>)` that can safely throw a checked exception.
`<E extends Exception> void`	`forEachThrowing(ThrowingConsumer<? super T,E> action)` A variant of `Stream.forEach(java.util.function.Consumer<? super T>)` that can safely throw a checked exception.
`static <T> RichStream<T>`	`from(Iterable<T> iterable)`
`static <T> RichStream<T>`	`from(Iterator<T> iterator)`
`static <T> RichStream<T>`	`from(Optional<T> optional)`
`static <T> RichStream<T>`	`from(java.util.stream.Stream<T> stream)`
`static <T> RichStream<T>`	`from(T[] array)`
`static <T> RichStream<T>`	`fromSupplierOfIterable(java.util.function.Supplier<? extends Iterable<T>> supplier)`
`RichStream<T>`	`limit(long maxSize)`
`<R> RichStream<R>`	`map(java.util.function.Function<? super T,? extends R> mapper)`
`static <T> RichStream<T>`	`of(T... values)`
`static <T> RichStream<T>`	`of(T value)`
`RichStream<T>`	`onClose(Runnable closeHandler)`
`RichStream<T>`	`parallel()`
`RichStream<T>`	`peek(java.util.function.Consumer<? super T> action)`
`RichStream<T>`	`sequential()`
`RichStream<T>`	`skip(long n)`
`RichStream<T>`	`sorted()`
`RichStream<T>`	`sorted(Comparator<? super T> comparator)`
`default com.google.common.collect.ImmutableList<T>`	`toImmutableList()`
`default com.google.common.collect.ImmutableSet<T>`	`toImmutableSet()`
`default com.google.common.collect.ImmutableSortedSet<T>`	`toImmutableSortedSet(Comparator<? super T> ordering)`
`default Iterable<T>`	`toOnceIterable()`
`RichStream<T>`	`unordered()`

Methods inherited from interface java.util.stream.Stream
allMatch, anyMatch, builder, collect, collect, concat, count, findAny, findFirst, flatMapToDouble, flatMapToInt, flatMapToLong, forEach, forEachOrdered, generate, iterate, mapToDouble, mapToInt, mapToLong, max, min, noneMatch, reduce, reduce, reduce, toArray, toArray

Methods inherited from interface java.util.stream.BaseStream
close, isParallel, iterator, spliterator

- Method Detail
  - empty
```
static <T> RichStream<T> empty()
```
    Specified by:
    
    empty in interface java.util.stream.Stream<T>
  - of
```
static <T> RichStream<T> of(T value)
```
    Specified by:
    
    of in interface java.util.stream.Stream<T>
  - of
```
@SafeVarargs
static <T> RichStream<T> of(T... values)
```
    Specified by:
    
    of in interface java.util.stream.Stream<T>
  - from
```
static <T> RichStream<T> from(T[] array)
```
  - from
```
static <T> RichStream<T> from(Iterable<T> iterable)
```
  - from
```
static <T> RichStream<T> from(Iterator<T> iterator)
```
  - from
```
static <T> RichStream<T> from(Optional<T> optional)
```
  - fromSupplierOfIterable
```
static <T> RichStream<T> fromSupplierOfIterable(java.util.function.Supplier<? extends Iterable<T>> supplier)
```
  - from
```
static <T> RichStream<T> from(java.util.stream.Stream<T> stream)
```
  - concat
```
default RichStream<T> concat(java.util.stream.Stream<? extends T> other)
```
    Parameters:
    
    other - Stream to concatenate into the current one.
    
    Returns:
    
    Stream containing the elements of the current stream followed by that of the given stream.
  - filter
```
default <U> RichStream<U> filter(Class<U> cls)
```
    Filter stream elements, returning only those that is an instance of the given class.
    
    Type Parameters:
    
    U - Class to cast to.
    
    Parameters:
    
    cls - Class instance of the class to cast to.
    
    Returns:
    
    Filtered stream of instances of cls.
  - toImmutableList
```
default com.google.common.collect.ImmutableList<T> toImmutableList()
```
  - toImmutableSet
```
default com.google.common.collect.ImmutableSet<T> toImmutableSet()
```
  - toImmutableSortedSet
```
default com.google.common.collect.ImmutableSortedSet<T> toImmutableSortedSet(Comparator<? super T> ordering)
```
  - toOnceIterable
```
default Iterable<T> toOnceIterable()
```
  - forEachThrowing
```
<E extends Exception> void forEachThrowing(ThrowingConsumer<? super T,E> action)
                                    throws E extends Exception
```
    A variant of Stream.forEach(java.util.function.Consumer<? super T>) that can safely throw a checked exception.
    
    Type Parameters:
    
    E - Exception that may be thrown by the action.
    
    Throws:
    
    E - Exception thrown by the action.
    
    E extends Exception
  - forEachOrderedThrowing
```
<E extends Exception> void forEachOrderedThrowing(ThrowingConsumer<? super T,E> action)
                                           throws E extends Exception
```
    A variant of Stream.forEachOrdered(java.util.function.Consumer<? super T>) that can safely throw a checked exception.
    
    Type Parameters:
    
    E - Exception that may be thrown by the action.
    
    Throws:
    
    E - Exception thrown by the action.
    
    E extends Exception
  - filter
```
RichStream<T> filter(java.util.function.Predicate<? super T> predicate)
```
    Specified by:
    
    filter in interface java.util.stream.Stream<T>
  - map
```
<R> RichStream<R> map(java.util.function.Function<? super T,? extends R> mapper)
```
    Specified by:
    
    map in interface java.util.stream.Stream<T>
  - flatMap
```
<R> RichStream<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>
  - distinct
```
RichStream<T> distinct()
```
    Specified by:
    
    distinct in interface java.util.stream.Stream<T>
  - sorted
```
RichStream<T> sorted()
```
    Specified by:
    
    sorted in interface java.util.stream.Stream<T>
  - sorted
```
RichStream<T> sorted(Comparator<? super T> comparator)
```
    Specified by:
    
    sorted in interface java.util.stream.Stream<T>
  - peek
```
RichStream<T> peek(java.util.function.Consumer<? super T> action)
```
    Specified by:
    
    peek in interface java.util.stream.Stream<T>
  - limit
```
RichStream<T> limit(long maxSize)
```
    Specified by:
    
    limit in interface java.util.stream.Stream<T>
  - skip
```
RichStream<T> skip(long n)
```
    Specified by:
    
    skip in interface java.util.stream.Stream<T>
  - sequential
```
RichStream<T> sequential()
```
    Specified by:
    
    sequential in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>
  - parallel
```
RichStream<T> parallel()
```
    Specified by:
    
    parallel in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>
  - unordered
```
RichStream<T> unordered()
```
    Specified by:
    
    unordered in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>
  - onClose
```
RichStream<T> onClose(Runnable closeHandler)
```
    Specified by:
    
    onClose in interface java.util.stream.BaseStream<T,java.util.stream.Stream<T>>

Interface RichStream<T>

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.stream.Stream

Methods inherited from interface java.util.stream.BaseStream

Method Detail

empty

of

of

from

from

from

from

fromSupplierOfIterable

from

concat

filter

toImmutableList

toImmutableSet

toImmutableSortedSet

toOnceIterable

forEachThrowing

forEachOrderedThrowing

filter

map

flatMap

distinct

sorted

sorted

peek

limit

skip

sequential

parallel

unordered

onClose