Streamable (jnoaber 0.0.3 API)

Type Parameters:

T - type of the Streamable's Stream elements.

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface Streamable<T>
```
The "stateless" companion to Stream. While for Iterator there is a Iterable no such thing exists for Stream in the JDK. This provides such a type. Currently it lifts filter(...), map(...) and flatMap(...) of Stream into itself. REMARK: in future iterations more functions of Stream may be lifted into this type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Streamable<T>`	`concat(Streamable<T>... streamables)` Concatenenats streameables.
`static <T1> Streamable<T1>`	`concat(Streamable<T1> head, Streamable<T1>... tail)` Concatenate Streamables.
`default Streamable<T>`	`distinct()` Filters a `Streamable` in to a `Streamable` of distinct values.
`default Streamable<T>`	`filter(Predicate<? super T> predicate)`
`default <R> Streamable<R>`	`flatMap(Function<? super T,? extends Streamable<? extends R>> mapper)` Lazily maps over the elements given the provided flat mapping function.
`default Streamable<T>`	`limit(long maxSize)` Limits the `Streamable` to `maxSize` elements.
`default <R> Streamable<R>`	`map(Function<? super T,? extends R> mapper)` Lazily maps over the elements given the provided mapping function.
`default Streamable<T>`	`parallel()` Parallelizes the `Stream` provided by this `Streamable`.
`default Streamable<T>`	`peek(Consumer<? super T> action)` Inserts an action into the stream execution.
`default Streamable<T>`	`sequential()` Unparallelizes the `Stream` provided by this `Streamable`.
`default Streamable<T>`	`skip(Long n)` Skip {code n} elemenents in the {link java.util.stream.Stream}
`default Streamable<T>`	`sorted()` Sorts the `Stream` provided by this `Streamable`.
`default Streamable<T>`	`sorted(Comparator<? super T> comparator)` Sorts the `Stream` provided by this `Streamable`.
`Stream<T>`	`stream()` Gets a "fresh" `Stream` of `T`.
`default Streamable<T>`	`unordered()` Allows the `Stream` provided by this `Streamable` to be unordered

- Method Detail
  - stream
```
Stream<T> stream()
```
    Gets a "fresh" Stream of T.
    
    Returns:
    
    the Stream of T
  - filter
```
default Streamable<T> filter(Predicate<? super T> predicate)
```
  - map
```
default <R> Streamable<R> map(Function<? super T,? extends R> mapper)
```
    Lazily maps over the elements given the provided mapping function.
    
    Type Parameters:
    
    R - return type of the elements to be provided by the Stream of the returned Streamable
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    a Streamable that returns a Stream of R
  - flatMap
```
default <R> Streamable<R> flatMap(Function<? super T,? extends Streamable<? extends R>> mapper)
```
    Lazily maps over the elements given the provided flat mapping function.
    
    Type Parameters:
    
    R - return type of the elements to be provided by the Stream of the returned Streamable
    
    Parameters:
    
    mapper - mapping function.
    
    Returns:
    
    Streamable that returns a Stream of R
  - concat
```
default Streamable<T> concat(Streamable<T>... streamables)
```
    Concatenenats streameables.
    
    Parameters:
    
    streamables - streamables to be concatenated
    
    Returns:
    
    streamable consisting of the concatenation of streamables
  - concat
```
static <T1> Streamable<T1> concat(Streamable<T1> head,
                                  Streamable<T1>... tail)
```
    Concatenate Streamables.
    
    Type Parameters:
    
    T1 - type of Streamables in tail
    
    Parameters:
    
    head - first streamable
    
    tail - other streameables to be concatenated to the head.
    
    Returns:
    
    streamable consisting of the concatenation of streamables
  - distinct
```
default Streamable<T> distinct()
```
    Filters a Streamable in to a Streamable of distinct values.
    
    Returns:
    
    Streamable of distinct values.
  - limit
```
default Streamable<T> limit(long maxSize)
```
    Limits the Streamable to maxSize elements.
    
    Parameters:
    
    maxSize - the maximum number of elements to return
    
    Returns:
    
    a Streamable of maxSize elements
  - parallel
```
default Streamable<T> parallel()
```
    Parallelizes the Stream provided by this Streamable.
    
    Returns:
    
    a Streamable that provides a parallel Stream
  - peek
```
default Streamable<T> peek(Consumer<? super T> action)
```
    Inserts an action into the stream execution. The action does have no effect on the processing of the stream except for being able to abort it with an exception, running for ever, consuming processing and memory.
    
    Parameters:
    
    action - the action to insert
    
    Returns:
    
    a Streamable with the action inserted into the processing of the Stream.
  - sequential
```
default Streamable<T> sequential()
```
    Unparallelizes the Stream provided by this Streamable.
    
    Returns:
    
    a Streamable that provides a sequential Stream
  - skip
```
default Streamable<T> skip(Long n)
```
    Skip {code n} elemenents in the {link java.util.stream.Stream}
    
    Parameters:
    
    n - number of elements to skip
    
    Returns:
    
    Streamable with n elements in the Stream skipped
  - sorted
```
default Streamable<T> sorted()
```
    Sorts the Stream provided by this Streamable.
    
    Returns:
    
    a Streamable that provides a sorted Stream
  - sorted
```
default Streamable<T> sorted(Comparator<? super T> comparator)
```
    Sorts the Stream provided by this Streamable.
    
    Parameters:
    
    comparator - the java.util.Comparator to use to sort the Stream.
    
    Returns:
    
    a Streamable that provides a sorted Stream
  - unordered
```
default Streamable<T> unordered()
```
    Allows the Stream provided by this Streamable to be unordered
    
    Returns:
    
    a Streamable that provides an unordered Stream

Interface Streamable<T>

Method Summary

Method Detail

stream

filter

map

flatMap

concat

concat

distinct

limit

parallel

peek

sequential

skip

sorted

sorted

unordered