StreamableIterable

All Superinterfaces:

java.lang.Iterable<T>
```
public interface StreamableIterable<T>
extends java.lang.Iterable<T>
```
An iterable capable of stream-like operations.
Whilst the Stream API is nice for some operations. There are some use cases where a simpler wrapped Iterable approach would be faster and more memory efficient, that's what this class aims to solve.
Created by covers1624 on 1/10/21.

Field Summary

Fields
Modifier and Type Field and Description

static StreamableIterable<?> EMPTY
Static empty instance.

Fields
Modifier and Type	Field and Description
`static StreamableIterable<?>`	`EMPTY` Static empty instance.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`allMatch(java.util.function.Predicate<? super T> test)` Check if all elements in this `StreamableIterable` match the given predicate.
`default boolean`	`anyMatch(java.util.function.Predicate<? super T> test)` Check if any elements in this `StreamableIterable` match the given predicate.
`static <T> StreamableIterable<T>`	`concat(java.lang.Iterable<StreamableIterable<T>> iterables)` Returns an `StreamableIterable` containing the elements from all the provided iterables concatenated together.
`static <T> StreamableIterable<T>`	`concat(StreamableIterable<T>... iterables)` Returns an `StreamableIterable` containing the elements from all the provided iterables concatenated together.
`default StreamableIterable<T>`	`concat(StreamableIterable<T> other)` Concatenates another `StreamableIterable` onto this one.
`default int`	`count()` Count the number of elements in this `StreamableIterable`.
`default StreamableIterable<T>`	`distinct()` Filter the elements in this `StreamableIterable` by their hashcode/equals.
`static <T> StreamableIterable<T>`	`empty()` Returns an empty `StreamableIterable`.
`default StreamableIterable<T>`	`filter(java.util.function.Predicate<? super T> pred)` Filter the elements in this `StreamableIterable` by matching a `Predicate`.
`default StreamableIterable<T>`	`filterNot(java.util.function.Predicate<? super T> pred)` Filter the elements in this `StreamableIterable` by matching a `Predicate`.
`default java.util.Optional<T>`	`findFirst()` Optionally get the first element within this `StreamableIterable`.
`default java.util.Optional<T>`	`findLast()` Optionally get the first element within this `StreamableIterable`.
`default <R> StreamableIterable<R>`	`flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends R>> func)` Flat map the elements in this `StreamableIterable`.
`default java.util.Optional<T>`	`fold(java.util.function.BinaryOperator<T> accumulator)` Folds each element of this `StreamableIterable` into the previous.
`default T`	`fold(T identity, java.util.function.BinaryOperator<T> accumulator)` Folds each element of this `StreamableIterable` into the previous.
`default StreamableIterable<T>`	`limit(int max)` Limit the number of elements returned by this `StreamableIterable` to the given value.
`default <R> StreamableIterable<R>`	`map(java.util.function.Function<? super T,? extends R> func)` Transform the elements in this `StreamableIterable`.
`default boolean`	`noneMatch(java.util.function.Predicate<? super T> test)` Check if no elements in this `StreamableIterable` match the given predicate.
`static <T> StreamableIterable<T>`	`of()` Returns an empty `StreamableIterable`.
`static <T> StreamableIterable<T>`	`of(java.lang.Iterable<T> itr)` Constructs a `StreamableIterable` wrapper from the given `Iterable`.
`static <T> StreamableIterable<T>`	`of(java.util.Optional<T> optional)` Creates an `StreamableIterable` for an `Optional` value.
`static <T> StreamableIterable<T>`	`of(T... things)` Creates an `StreamableIterable` from a variable list of inputs.
`static <T> StreamableIterable<T>`	`of(T thing)` Creates a `StreamableIterable` for single input.
`static <T> StreamableIterable<T>`	`ofNullable(T thing)` Creates an `StreamableIterable` for a Nullable value.
`default T`	`only()` Returns the only element in this `StreamableIterable`.
`default T`	`onlyOrDefault()` Returns the first element found in the `StreamableIterable` if it is the only element, otherwise `null` is returned.
`default T`	`onlyOrDefault(T _default)` Returns the first element found in the `StreamableIterable` if it is the only element, otherwise the default value is returned.
`default java.util.stream.Stream<T>`	`parallelStream()` Convert this `StreamableIterable` to a parallel `Stream`.
`default StreamableIterable<T>`	`peek(java.util.function.Consumer<T> action)` Peek the elements of this `StreamableIterable` as they are consumed.
`default StreamableIterable<T>`	`skip(int n)` Skip n number of elements in this `StreamableIterable`.
`default java.util.stream.Stream<T>`	`stream()` Convert this `StreamableIterable` to a `Stream`.
`default java.lang.Object[]`	`toArray()` Collect this `StreamableIterable` to an array.
`default T[]`	`toArray(T[] arr)` Collect this `StreamableIterable` to an array.
`default <any>`	`toImmutableList()` Collect this `StreamableIterable` to an `ImmutableList`.
`default <K,V> <any>`	`toImmutableMap(java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc)` Collect this `StreamableIterable` to am `ImmutableMap`.
`default <K,V> <any>`	`toImmutableMap(java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collect this `StreamableIterable` to am `ImmutableMap`.
`default <any>`	`toImmutableSet()` Collect this `StreamableIterable` to a `LinkedHashSet`.
`default <K,V> java.util.HashMap<K,V>`	`toLinkedHashMap(java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc)` Collect this `StreamableIterable` to a `LinkedHashMap`.
`default <K,V> java.util.HashMap<K,V>`	`toLinkedHashMap(java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collect this `StreamableIterable` to a `LinkedHashMap`.
`default java.util.LinkedHashSet<T>`	`toLinkedHashSet()` Collect this `StreamableIterable` to a `LinkedHashSet`.
`default java.util.LinkedList<T>`	`toLinkedList()` Collect this `StreamableIterable` to a `LinkedList`.
`default java.util.ArrayList<T>`	`toList()` Collect this `StreamableIterable` to an `ArrayList`.
`default <K,V> java.util.HashMap<K,V>`	`toMap(java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc)` Collect this `StreamableIterable` to a `HashMap`.
`default <K,V> java.util.HashMap<K,V>`	`toMap(java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collect this `StreamableIterable` to a `HashMap`.
`default <K,V,M extends java.util.Map<K,V>> M`	`toMap(M map, java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc)` Collect this `StreamableIterable` to a `Map`.
`default <K,V,M extends java.util.Map<K,V>> M`	`toMap(M map, java.util.function.Function<T,K> keyFunc, java.util.function.Function<T,V> valueFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collect this `StreamableIterable` to a `Map`.
`default java.util.HashSet<T>`	`toSet()` Collect this `StreamableIterable` to a `HashSet`.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Field Detail
  - EMPTY
```
static final StreamableIterable<?> EMPTY
```
    Static empty instance. You want empty().
- Method Detail
  - empty
```
static <T> StreamableIterable<T> empty()
```
    Returns an empty StreamableIterable.
    
    Returns:
    
    The empty StreamableIterable
  - of
```
static <T> StreamableIterable<T> of(java.lang.Iterable<T> itr)
```
    Constructs a StreamableIterable wrapper from the given Iterable.
    
    Parameters:
    
    itr - The Iterable to wrap.
    
    Returns:
    
    The StreamableIterable
  - of
```
static <T> StreamableIterable<T> of()
```
    Returns an empty StreamableIterable.
    
    Returns:
    
    The empty StreamableIterable
  - of
```
static <T> StreamableIterable<T> of(T thing)
```
    Creates a StreamableIterable for single input.
    
    Parameters:
    
    thing - The thing.
    
    Returns:
    
    the StreamableIterable.
  - ofNullable
```
static <T> StreamableIterable<T> ofNullable(T thing)
```
    Creates an StreamableIterable for a Nullable value.
    If the value provided is null, this method will return empty(), otherwise it will return a new StreamableIterable containing only the value provided.
    
    Parameters:
    
    thing - The thing.
    
    Returns:
    
    The StreamableIterable.
  - of
```
static <T> StreamableIterable<T> of(java.util.Optional<T> optional)
```
    Creates an StreamableIterable for an Optional value.
    If the value provided is not present, this method will return empty(), otherwise it will return a new StreamableIterable containing only the value provided.
    
    Parameters:
    
    optional - The thing.
    
    Returns:
    
    The StreamableIterable.
  - of
```
@SafeVarargs
static <T> StreamableIterable<T> of(T... things)
```
    Creates an StreamableIterable from a variable list of inputs.
    
    Parameters:
    
    things - The things.
    
    Returns:
    
    the StreamableIterable.
  - concat
```
@SafeVarargs
static <T> StreamableIterable<T> concat(StreamableIterable<T>... iterables)
```
    Returns an StreamableIterable containing the elements from all the provided iterables concatenated together.
    
    Parameters:
    
    iterables - The StreamableIterables to concatenate.
    
    Returns:
    
    The concatenated StreamableIterable.
  - concat
```
static <T> StreamableIterable<T> concat(java.lang.Iterable<StreamableIterable<T>> iterables)
```
    Returns an StreamableIterable containing the elements from all the provided iterables concatenated together.
    
    Parameters:
    
    iterables - The StreamableIterables to concatenate.
    
    Returns:
    
    The concatenated StreamableIterable.
  - concat
```
default StreamableIterable<T> concat(StreamableIterable<T> other)
```
    Concatenates another StreamableIterable onto this one.
    
    Parameters:
    
    other - The other StreamableIterable to append.
    
    Returns:
    
    The new concatenated StreamableIterable.
  - filter
```
default StreamableIterable<T> filter(java.util.function.Predicate<? super T> pred)
```
    Filter the elements in this StreamableIterable by matching a Predicate.
    All elements which match this Predicate will be in the resulting StreamableIterable.
    
    Parameters:
    
    pred - The predicate.
    
    Returns:
    
    A wrapped StreamableIterable with the filter applied.
  - filterNot
```
default StreamableIterable<T> filterNot(java.util.function.Predicate<? super T> pred)
```
    Filter the elements in this StreamableIterable by matching a Predicate.
    All elements which do not match this Predicate will be in the resulting StreamableIterable.
    
    Parameters:
    
    pred - The predicate.
    
    Returns:
    
    A wrapped StreamableIterable with the filter applied.
  - map
```
default <R> StreamableIterable<R> map(java.util.function.Function<? super T,? extends R> func)
```
    Transform the elements in this StreamableIterable.
    
    Parameters:
    
    func - The Function to transform with.
    
    Returns:
    
    A wrapped StreamableIterable with the mapped elements.
  - flatMap
```
default <R> StreamableIterable<R> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends R>> func)
```
    Flat map the elements in this StreamableIterable.
    
    Parameters:
    
    func - The function to get/create the iterable for a given element.
    
    Returns:
    
    A wrapped StreamableIterable with the flat mapped elements.
  - distinct
```
default StreamableIterable<T> distinct()
```
    Filter the elements in this StreamableIterable by their hashcode/equals.
    
    Returns:
    
    A wrapped StreamableIterable with the filtered elements.
  - peek
```
default StreamableIterable<T> peek(java.util.function.Consumer<T> action)
```
    Peek the elements of this StreamableIterable as they are consumed.
    
    Parameters:
    
    action - The consumer.
    
    Returns:
    
    A wrapped StreamableIterable with the peek function applied.
  - limit
```
default StreamableIterable<T> limit(int max)
```
    Limit the number of elements returned by this StreamableIterable to the given value.
    
    Parameters:
    
    max - The limit. -1 for infinite.
    
    Returns:
    
    A wrapped StreamableIterable with the max filter applied. In the event -1< is supplied, the same StreamableIterable will be provided. In the event 0 is supplied, an empty StreamableIterable will be provided.
  - skip
```
default StreamableIterable<T> skip(int n)
```
    Skip n number of elements in this StreamableIterable.
    
    Parameters:
    
    n - The number of elements to skip.
    
    Returns:
    
    A wrapped StreamableIterable with the max filter applied. In the event 0 is supplied, the same StreamableIterable will be provided.
  - toArray
```
default java.lang.Object[] toArray()
```
    Collect this StreamableIterable to an array.
    
    Returns:
    
    The array.
  - toArray
```
default T[] toArray(T[] arr)
```
    Collect this StreamableIterable to an array.
    
    Parameters:
    
    arr - The array to add the elements to. If all elements to not fit in this array a new array will be returned of appropriate size.
    
    Returns:
    
    Either the array passed in or one of appropriate size with all elements of the Iterable.
  - fold
```
default T fold(T identity,
               java.util.function.BinaryOperator<T> accumulator)
```
    Folds each element of this StreamableIterable into the previous.
    
    Parameters:
    
    identity - The starting element.
    
    accumulator - The function to fold elements with.
    
    Returns:
    
    The result.
  - fold
```
default java.util.Optional<T> fold(java.util.function.BinaryOperator<T> accumulator)
```
    Folds each element of this StreamableIterable into the previous.
    
    Parameters:
    
    accumulator - The function to fold elements with.
    
    Returns:
    
    The result. Empty if no elements exist.
  - count
```
default int count()
```
    Count the number of elements in this StreamableIterable.
    
    Returns:
    
    The number of elements.
  - anyMatch
```
default boolean anyMatch(java.util.function.Predicate<? super T> test)
```
    Check if any elements in this StreamableIterable match the given predicate.
    
    Parameters:
    
    test - The predicate.
    
    Returns:
    
    The result.
  - allMatch
```
default boolean allMatch(java.util.function.Predicate<? super T> test)
```
    Check if all elements in this StreamableIterable match the given predicate.
    
    Parameters:
    
    test - The predicate.
    
    Returns:
    
    The result.
  - noneMatch
```
default boolean noneMatch(java.util.function.Predicate<? super T> test)
```
    Check if no elements in this StreamableIterable match the given predicate.
    
    Parameters:
    
    test - The predicate.
    
    Returns:
    
    The result.
  - findFirst
```
default java.util.Optional<T> findFirst()
```
    Optionally get the first element within this StreamableIterable.
    
    Returns:
    
    The last element.
  - findLast
```
default java.util.Optional<T> findLast()
```
    Optionally get the first element within this StreamableIterable.
    
    Returns:
    
    The last element.
  - only
```
default T only()
```
    Returns the only element in this StreamableIterable.
    
    Returns:
    
    The single element.
    
    Throws:
    
    java.lang.IllegalArgumentException - If there are none, or more than one element.
  - onlyOrDefault
```
default T onlyOrDefault()
```
    Returns the first element found in the StreamableIterable if it is the only element, otherwise null is returned.
    
    Returns:
    
    The first element or null.
  - onlyOrDefault
```
default T onlyOrDefault(T _default)
```
    Returns the first element found in the StreamableIterable if it is the only element, otherwise the default value is returned.
    
    Parameters:
    
    _default - The default value, in the event the StreamableIterable is empty, or has more than one element.
    
    Returns:
    
    The first element or the default.
  - toList
```
default java.util.ArrayList<T> toList()
```
    Collect this StreamableIterable to an ArrayList.
    
    Returns:
    
    The ArrayList.
  - toLinkedList
```
default java.util.LinkedList<T> toLinkedList()
```
    Collect this StreamableIterable to a LinkedList.
    
    Returns:
    
    The LinkedList.
  - toImmutableList
```
default <any> toImmutableList()
```
    Collect this StreamableIterable to an ImmutableList.
    
    Returns:
    
    The ImmutableList.
  - toSet
```
default java.util.HashSet<T> toSet()
```
    Collect this StreamableIterable to a HashSet.
    
    Returns:
    
    The HashSet.
  - toLinkedHashSet
```
default java.util.LinkedHashSet<T> toLinkedHashSet()
```
    Collect this StreamableIterable to a LinkedHashSet.
    
    Returns:
    
    The LinkedHashSet.
  - toImmutableSet
```
default <any> toImmutableSet()
```
    Collect this StreamableIterable to a LinkedHashSet.
    
    Returns:
    
    The LinkedHashSet.
  - toMap
```
default <K,V> java.util.HashMap<K,V> toMap(java.util.function.Function<T,K> keyFunc,
                                           java.util.function.Function<T,V> valueFunc)
```
    Collect this StreamableIterable to a HashMap. This method will always resolve the existing element on collision.
    
    Parameters:
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    Returns:
    
    The Map.
  - toMap
```
default <K,V> java.util.HashMap<K,V> toMap(java.util.function.Function<T,K> keyFunc,
                                           java.util.function.Function<T,V> valueFunc,
                                           java.util.function.BinaryOperator<V> mergeFunc)
```
    Collect this StreamableIterable to a HashMap.
    
    Parameters:
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    mergeFunc - The function for merging 2 values on collision. (Left existing, Right toAdd)
    
    Returns:
    
    The Map.
  - toLinkedHashMap
```
default <K,V> java.util.HashMap<K,V> toLinkedHashMap(java.util.function.Function<T,K> keyFunc,
                                                     java.util.function.Function<T,V> valueFunc)
```
    Collect this StreamableIterable to a LinkedHashMap. This method will always resolve the existing element on collision.
    
    Parameters:
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    Returns:
    
    The Map.
  - toLinkedHashMap
```
default <K,V> java.util.HashMap<K,V> toLinkedHashMap(java.util.function.Function<T,K> keyFunc,
                                                     java.util.function.Function<T,V> valueFunc,
                                                     java.util.function.BinaryOperator<V> mergeFunc)
```
    Collect this StreamableIterable to a LinkedHashMap.
    
    Parameters:
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    mergeFunc - The function for merging 2 values on collision. (Left existing, Right toAdd)
    
    Returns:
    
    The Map.
  - toImmutableMap
```
default <K,V> <any> toImmutableMap(java.util.function.Function<T,K> keyFunc,
                                   java.util.function.Function<T,V> valueFunc)
```
    Collect this StreamableIterable to am ImmutableMap.
    This function collects to an intermediate LinkedHashMap internally, iteration order will be preserved.
    
    Parameters:
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    Returns:
    
    The ImmutableMap.
  - toImmutableMap
```
default <K,V> <any> toImmutableMap(java.util.function.Function<T,K> keyFunc,
                                   java.util.function.Function<T,V> valueFunc,
                                   java.util.function.BinaryOperator<V> mergeFunc)
```
    Collect this StreamableIterable to am ImmutableMap.
    This function collects to an intermediate LinkedHashMap internally, iteration order will be preserved.
    
    Parameters:
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    mergeFunc - The function for merging 2 values on collision. (Left existing, Right toAdd)
    
    Returns:
    
    The ImmutableMap.
  - toMap
```
default <K,V,M extends java.util.Map<K,V>> M toMap(M map,
                                                   java.util.function.Function<T,K> keyFunc,
                                                   java.util.function.Function<T,V> valueFunc)
```
    Collect this StreamableIterable to a Map. This method will always resolve the existing element on collision.
    
    Parameters:
    
    map - The map to add the elements to.
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    Returns:
    
    The same map that was passed in.
  - toMap
```
default <K,V,M extends java.util.Map<K,V>> M toMap(M map,
                                                   java.util.function.Function<T,K> keyFunc,
                                                   java.util.function.Function<T,V> valueFunc,
                                                   java.util.function.BinaryOperator<V> mergeFunc)
```
    Collect this StreamableIterable to a Map.
    
    Parameters:
    
    map - The map to add the elements to.
    
    keyFunc - The function for extracting the key.
    
    valueFunc - The function for extracting the value.
    
    mergeFunc - The function for merging 2 values on collision. (Left existing, Right toAdd)
    
    Returns:
    
    The same map that was passed in.
  - stream
```
default java.util.stream.Stream<T> stream()
```
    Convert this StreamableIterable to a Stream.
    
    Returns:
    
    The Stream
  - parallelStream
```
default java.util.stream.Stream<T> parallelStream()
```
    Convert this StreamableIterable to a parallel Stream.
    
    Returns:
    
    The Stream

Interface StreamableIterable<T>

Field Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Field Detail

EMPTY

Method Detail

empty

of

of

of

ofNullable

of

of

concat

concat

concat

filter

filterNot

map

flatMap

distinct

peek

limit

skip

toArray

toArray

fold

fold

count

anyMatch

allMatch

noneMatch

findFirst

findLast

only

onlyOrDefault

onlyOrDefault

toList

toLinkedList

toImmutableList

toSet

toLinkedHashSet

toImmutableSet

toMap

toMap

toLinkedHashMap

toLinkedHashMap

toImmutableMap

toImmutableMap

toMap

toMap

stream

parallelStream