Streamable (protonpack 1.5-SNAPSHOT API)

Type Parameters:

T - The type over which the streamable's streams stream.

All Superinterfaces:

java.util.function.Supplier<java.util.stream.Stream<T>>
```
public interface Streamable<T>
extends java.util.function.Supplier<java.util.stream.Stream<T>>
```
A source of Streams that can be repeatedly streamed.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default <O> O`	`collect(java.util.stream.Collector<T,?,O> collector)` Stream this streamable, and collect the stream with the supplied collector.
`default Streamable<T>`	`concat(Streamable<T> streamable)` Concatenate this streamable with another streamable.
`static <T> Streamable<T>`	`empty()` Gets an empty streamable.
`default Streamable<T>`	`filter(java.util.function.Predicate<? super T> predicate)` Transform this streamable's streams with the supplied filter predicate.
`default <T2> Streamable<T2>`	`flatMap(java.util.function.Function<? super T,java.util.stream.Stream<? extends T2>> f)` Transform this streamable's streams with the supplied flatmap.
`default void`	`forEach(java.util.function.Consumer<T> action)` Stream this streamable, and call forEach on the resulting stream with the supplied action.
`default void`	`forEachOrdered(java.util.function.Consumer<T> action)` Stream this streamable, and call forEach on the resulting stream in order with the supplied action.
`default Streamable<T>`	`limit(long n)` Transform this streamable's streams by limiting the number of elements they can contain.
`default <T2> Streamable<T2>`	`map(java.util.function.Function<? super T,? extends T2> f)` Transform this streamable's streams with the supplied map.
`static <T> Streamable<T>`	`of(Collection<T> collection)` Create a streamable that produces streams over a collection of items.
`static <T> Streamable<T>`	`of(Iterable<T> iterable)` Create a streamable that produces streams over an iterable of items.
`static <T> Streamable<T>`	`of(Optional<T> optional)` Create a streamable that produces streams of 0 or 1 elements over an optional value.
`static <T> Streamable<T>`	`of(java.util.function.Supplier<java.util.stream.Stream<T>> streamable)` For converting method references to no-arg methods that return streams into streamable.
`static <T> Streamable<T>`	`of(T... items)` Create a streamable that produces streams over an array of items.
`static <T> Streamable<T>`	`ofAll(Streamable<T>... streamables)` Concatenate a series of streamables together.
`default Streamable<T>`	`skip(long n)` Transform this streamable's streams by skipping elements
`default Streamable<T>`	`sorted(Comparator<? super T> comparator)` Transform this streamable's streams by sorting them.
`default java.util.stream.Stream<T>`	`stream()` Synonym for "get"
`default T[]`	`toArray(java.util.function.IntFunction<T[]> arrayConstructor)` Stream this streamable, and collect the stream to an array.
`default List<T>`	`toList()` Stream this streamable, and collect the stream to a list.
`default <K> Map<K,T>`	`toMap(java.util.function.Function<? super T,? extends K> indexFunction)` Stream this streamable, and collect the stream to a map, extracting keys with the supplied index function.
`default <K,V> Map<K,V>`	`toMap(java.util.function.Function<? super T,? extends K> keyFunction, java.util.function.Function<? super T,? extends V> valueFunction)` Stream this streamable, and collect the stream to a map, extracting keys and values with the supplied functions.
`default Set<T>`	`toSet()` Stream this streamable, and collect the stream to a set.
`default <T2> Streamable<T2>`	`transform(java.util.function.Function<java.util.stream.Stream<T>,java.util.stream.Stream<T2>> transformer)` Create a streamable that transforms the streams produced by this streamable with a stream transformer.

Methods inherited from interface java.util.function.Supplier
get

- Method Detail
  - empty
```
static <T> Streamable<T> empty()
```
    Gets an empty streamable.
    
    Type Parameters:
    
    T - The type of the values that aren't in the streamable's streams.
    
    Returns:
    
    An empty streamable.
  - of
```
static <T> Streamable<T> of(java.util.function.Supplier<java.util.stream.Stream<T>> streamable)
```
    For converting method references to no-arg methods that return streams into streamable.
    
    Type Parameters:
    
    T - The type over which the streamable's streams stream.
    
    Parameters:
    
    streamable - Anything that can be cast to a Streamable.
    
    Returns:
    
    The streamable.
  - of
```
static <T> Streamable<T> of(T... items)
```
    Create a streamable that produces streams over an array of items.
    
    Type Parameters:
    
    T - The type of the values in the array.
    
    Parameters:
    
    items - The items that the streamable's streams will stream.
    
    Returns:
    
    The streamable.
  - of
```
static <T> Streamable<T> of(Collection<T> collection)
```
    Create a streamable that produces streams over a collection of items.
    
    Type Parameters:
    
    T - The type of the values in the collection.
    
    Parameters:
    
    collection - The items that the streamable's streams will stream.
    
    Returns:
    
    The streamable.
  - of
```
static <T> Streamable<T> of(Iterable<T> iterable)
```
    Create a streamable that produces streams over an iterable of items.
    
    Type Parameters:
    
    T - The type of the values in the iterable.
    
    Parameters:
    
    iterable - The items that the streamable's streams will stream.
    
    Returns:
    
    The streamable.
  - of
```
static <T> Streamable<T> of(Optional<T> optional)
```
    Create a streamable that produces streams of 0 or 1 elements over an optional value.
    
    Type Parameters:
    
    T - The type of the optional.
    
    Parameters:
    
    optional - The optional item that the streamable's streams will stream.
    
    Returns:
    
    The streamable.
  - ofAll
```
@SafeVarargs
static <T> Streamable<T> ofAll(Streamable<T>... streamables)
```
    Concatenate a series of streamables together.
    
    Type Parameters:
    
    T - The type of the streamables.
    
    Parameters:
    
    streamables - The streamables to concatenate.
    
    Returns:
    
    A streamable which streams over the concatenation of the streams produced by all the source streamables.
  - stream
```
default java.util.stream.Stream<T> stream()
```
    Synonym for "get"
    
    Returns:
    
    A stream over the streamable
  - concat
```
default Streamable<T> concat(Streamable<T> streamable)
```
    Concatenate this streamable with another streamable.
    
    Parameters:
    
    streamable - The streamable to concatenate.
    
    Returns:
    
    A concatenated streamable, which streams over the concatenation of the streams produces by its source streamables.
  - transform
```
default <T2> Streamable<T2> transform(java.util.function.Function<java.util.stream.Stream<T>,java.util.stream.Stream<T2>> transformer)
```
    Create a streamable that transforms the streams produced by this streamable with a stream transformer.
    
    Type Parameters:
    
    T2 - The type of the streams produced by the transformation.
    
    Parameters:
    
    transformer - The transformer to apply to this streamable's streams.
    
    Returns:
    
    A streamable which produces the transformed streams.
  - map
```
default <T2> Streamable<T2> map(java.util.function.Function<? super T,? extends T2> f)
```
    Transform this streamable's streams with the supplied map.
    
    Type Parameters:
    
    T2 - The mapped-to type.
    
    Parameters:
    
    f - The map to apply.
    
    Returns:
    
    A streamable which produces the transformed streams.
  - flatMap
```
default <T2> Streamable<T2> flatMap(java.util.function.Function<? super T,java.util.stream.Stream<? extends T2>> f)
```
    Transform this streamable's streams with the supplied flatmap.
    
    Type Parameters:
    
    T2 - The flatmapped-to type.
    
    Parameters:
    
    f - The flatmap to apply.
    
    Returns:
    
    A streamable which produces the transformed streams.
  - filter
```
default Streamable<T> filter(java.util.function.Predicate<? super T> predicate)
```
    Transform this streamable's streams with the supplied filter predicate.
    
    Parameters:
    
    predicate - The filter predicate to apply.
    
    Returns:
    
    A streamable which produces the transformed streams.
  - sorted
```
default Streamable<T> sorted(Comparator<? super T> comparator)
```
    Transform this streamable's streams by sorting them.
    
    Parameters:
    
    comparator - The comparator to use in sorting.
    
    Returns:
    
    A streamable which produces the transformed streams.
  - skip
```
default Streamable<T> skip(long n)
```
    Transform this streamable's streams by skipping elements
    
    Parameters:
    
    n - The number of elements to skip
    
    Returns:
    
    A streamable which produces the transformed streams.
  - limit
```
default Streamable<T> limit(long n)
```
    Transform this streamable's streams by limiting the number of elements they can contain.
    
    Parameters:
    
    n - The number of elements to limit to.
    
    Returns:
    
    A streamable which produces the transformed streams.
  - forEach
```
default void forEach(java.util.function.Consumer<T> action)
```
    Stream this streamable, and call forEach on the resulting stream with the supplied action.
    
    Parameters:
    
    action - The action to apply to each stream element.
  - forEachOrdered
```
default void forEachOrdered(java.util.function.Consumer<T> action)
```
    Stream this streamable, and call forEach on the resulting stream in order with the supplied action.
    
    Parameters:
    
    action - The action to apply to each stream element.
  - collect
```
default <O> O collect(java.util.stream.Collector<T,?,O> collector)
```
    Stream this streamable, and collect the stream with the supplied collector.
    
    Type Parameters:
    
    O - The output type of the collector.
    
    Parameters:
    
    collector - The collector to use to collect streamed values.
    
    Returns:
    
    The collected result.
  - toList
```
default List<T> toList()
```
    Stream this streamable, and collect the stream to a list.
    
    Returns:
    
    The collected result.
  - toSet
```
default Set<T> toSet()
```
    Stream this streamable, and collect the stream to a set.
    
    Returns:
    
    The collected result.
  - toMap
```
default <K> Map<K,T> toMap(java.util.function.Function<? super T,? extends K> indexFunction)
```
    Stream this streamable, and collect the stream to a map, extracting keys with the supplied index function.
    
    Type Parameters:
    
    K - The type of the keys.
    
    Parameters:
    
    indexFunction - The function to use to extract keys from the streamed values.
    
    Returns:
    
    The collected result.
  - toMap
```
default <K,V> Map<K,V> toMap(java.util.function.Function<? super T,? extends K> keyFunction,
                             java.util.function.Function<? super T,? extends V> valueFunction)
```
    Stream this streamable, and collect the stream to a map, extracting keys and values with the supplied functions.
    
    Type Parameters:
    
    K - The type of the keys.
    
    V - The type of the values.
    
    Parameters:
    
    keyFunction - The function to use to extract keys from the stream.
    
    valueFunction - The function to use to extract values from the stream.
    
    Returns:
    
    The collected result.
  - toArray
```
default T[] toArray(java.util.function.IntFunction<T[]> arrayConstructor)
```
    Stream this streamable, and collect the stream to an array.
    
    Parameters:
    
    arrayConstructor - A function that will construct a new empty array of the required size.
    
    Returns:
    
    The collected result.

Interface Streamable<T>

Method Summary

Methods inherited from interface java.util.function.Supplier

Method Detail

empty

of

of

of

of

of

ofAll

stream

concat

transform

map

flatMap

filter

sorted

skip

limit

forEach

forEachOrdered

collect

toList

toSet

toMap

toMap

toArray