BooleanIterable (Primitive-Collections 0.8.0 API)

All Superinterfaces:

java.lang.Iterable<java.lang.Boolean>

All Known Subinterfaces:

BooleanCollection, BooleanList, BooleanPriorityDequeue, BooleanPriorityQueue

All Known Implementing Classes:

AbstractBooleanCollection, AbstractBooleanList, AbstractBooleanPriorityQueue, BooleanArrayFIFOQueue, BooleanArrayList, BooleanArrayPriorityQueue, BooleanCollections.EmptyCollection, BooleanCollections.SynchronizedCollection, BooleanCollections.UnmodifiableCollection, BooleanHeapPriorityQueue, BooleanLinkedList, BooleanPriorityQueues.SynchronizedPriorityDequeue, BooleanPriorityQueues.SynchronizedPriorityQueue, CopyOnWriteBooleanArrayList, ImmutableBooleanList
```
public interface BooleanIterable
extends java.lang.Iterable<java.lang.Boolean>
```
A Type-Specific Iterable that reduces (un)boxing

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default <E> ObjectIterable<E>`	`arrayflatMap(BooleanFunction<E[]> mapper)` A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
`default BooleanAsyncBuilder`	`asAsync()` Creates a Async Builder for moving work of the thread.
`default int`	`count(BooleanPredicate filter)` Helper function to reduce stream usage that allows to count the valid elements.
`default BooleanIterable`	`distinct()` A Helper function to reduce the usage of Streams and allows to filter out duplicated elements
`default BooleanIterable`	`filter(BooleanPredicate filter)` A Helper function to reduce the usage of Streams and allows to filter out unwanted elements
`default boolean`	`findFirst(BooleanPredicate filter)` Helper function to reduce stream usage that allows to filter for the first match.
`default <E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(BooleanFunction<V> mapper)` A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
`default void`	`forEach(BooleanConsumer action)` A Type Specific foreach function that reduces (un)boxing
`default void`	`forEach(java.util.function.Consumer<? super java.lang.Boolean> action)` Deprecated. Please use the corresponding type-specific function instead.
`default <E> void`	`forEach(E input, ObjectBooleanConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`default void`	`forEachIndexed(IntBooleanConsumer action)` A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
`BooleanIterator`	`iterator()` Returns an iterator over elements of type `T`.
`default BooleanIterable`	`limit(long limit)` A Helper function to reduce the usage of Streams and allows to limit the amount of elements
`default <E> ObjectIterable<E>`	`map(BooleanFunction<E> mapper)` A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
`default boolean`	`matchesAll(BooleanPredicate filter)` Helper function to reduce stream usage that allows to filter for all matches.
`default boolean`	`matchesAny(BooleanPredicate filter)` Helper function to reduce stream usage that allows to filter for any matches.
`default boolean`	`matchesNone(BooleanPredicate filter)` Helper function to reduce stream usage that allows to filter for no matches.
`default BooleanIterable`	`peek(BooleanConsumer action)` A Helper function to reduce the usage of Streams and allows to preview elements before they are iterated through
`default <E extends BooleanCollection> E`	`pour(E collection)` A Helper function to reduce the usage of Streams and allows to collect all elements
`default BooleanList`	`pourAsList()` A Helper function that reduces the usage of streams and allows to collect all elements as a ArrayList
`default boolean`	`reduce(boolean identity, BooleanBooleanUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`default boolean`	`reduce(BooleanBooleanUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`default BooleanIterable`	`repeat(int repeats)` A Helper function to reduce the usage of Streams and allows to repeat elements a desired amount of times
`default BooleanIterable`	`sorted(BooleanComparator sorter)` A Helper function to reduce the usage of Streams and allows to sort the elements
`default BooleanSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`default boolean[]`	`toBooleanArray()` A Helper function that reduces the usage of streams and allows to collect all elements as a Array

- Method Detail
  - iterator
```
BooleanIterator iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Boolean>
    
    Returns:
    
    an Iterator.
  - forEach
```
default void forEach(BooleanConsumer action)
```
    A Type Specific foreach function that reduces (un)boxing
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
    
    See Also:
    
    Iterable.forEach(Consumer)
    
    ImplSpec:
    The default implementation behaves as if:
    iterator().forEachRemaining(action);
  - forEach
```
@Deprecated
default void forEach(java.util.function.Consumer<? super java.lang.Boolean> action)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    forEach in interface java.lang.Iterable<java.lang.Boolean>
  - forEachIndexed
```
default void forEachIndexed(IntBooleanConsumer action)
```
    A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
    
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - forEach
```
default <E> void forEach(E input,
                         ObjectBooleanConsumer<E> action)
```
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - spliterator
```
default BooleanSplititerator spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Boolean>
    
    Returns:
    
    type specific splititerator
  - asAsync
```
default BooleanAsyncBuilder asAsync()
```
    Creates a Async Builder for moving work of the thread. It is not designed to split the work to multithreaded work, so using this keep it singlethreaded, but it allows to be moved to another thread.
    
    Returns:
    
    a AsyncBuilder
    
    See Also:
    
    BooleanAsyncBuilder
  - map
```
default <E> ObjectIterable<E> map(BooleanFunction<E> mapper)
```
    A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    mapper - the mapping function
    
    Returns:
    
    a new Iterable that returns the desired result
  - flatMap
```
default <E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(BooleanFunction<V> mapper)
```
    A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    mapper - the flatMapping function
    
    Returns:
    
    a new Iterable that returns the desired result
    
    Note:
    
    does not support toBooleanArray optimizations.
  - arrayflatMap
```
default <E> ObjectIterable<E> arrayflatMap(BooleanFunction<E[]> mapper)
```
    A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    mapper - the flatMapping function
    
    Returns:
    
    a new Iterable that returns the desired result
    
    Note:
    
    does not support toBooleanArray optimizations.
  - filter
```
default BooleanIterable filter(BooleanPredicate filter)
```
    A Helper function to reduce the usage of Streams and allows to filter out unwanted elements
    
    Parameters:
    
    filter - the elements that should be kept.
    
    Returns:
    
    a Iterable that filtered out all unwanted elements
    
    Note:
    
    does not support toBooleanArray optimizations.
  - distinct
```
default BooleanIterable distinct()
```
    A Helper function to reduce the usage of Streams and allows to filter out duplicated elements
    
    Returns:
    
    a Iterable that filtered out all duplicated elements
    
    Note:
    
    does not support toBooleanArray optimizations.
  - repeat
```
default BooleanIterable repeat(int repeats)
```
    A Helper function to reduce the usage of Streams and allows to repeat elements a desired amount of times
    
    Parameters:
    
    repeats - how many times the elements should be repeated
    
    Returns:
    
    a Iterable that is repeating multiple times
  - limit
```
default BooleanIterable limit(long limit)
```
    A Helper function to reduce the usage of Streams and allows to limit the amount of elements
    
    Parameters:
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a Iterable that is limited in length
  - sorted
```
default BooleanIterable sorted(BooleanComparator sorter)
```
    A Helper function to reduce the usage of Streams and allows to sort the elements
    
    Parameters:
    
    sorter - that sorts the elements.
    
    Returns:
    
    a Iterable that is sorted
  - peek
```
default BooleanIterable peek(BooleanConsumer action)
```
    A Helper function to reduce the usage of Streams and allows to preview elements before they are iterated through
    
    Parameters:
    
    action - the action that should be applied
    
    Returns:
    
    a Peeked Iterable
  - pour
```
default <E extends BooleanCollection> E pour(E collection)
```
    A Helper function to reduce the usage of Streams and allows to collect all elements
    
    Type Parameters:
    
    E - the collection type
    
    Parameters:
    
    collection - that the elements should be inserted to
    
    Returns:
    
    the input with the desired elements
  - pourAsList
```
default BooleanList pourAsList()
```
    A Helper function that reduces the usage of streams and allows to collect all elements as a ArrayList
    
    Returns:
    
    a new ArrayList of all elements
  - toBooleanArray
```
default boolean[] toBooleanArray()
```
    A Helper function that reduces the usage of streams and allows to collect all elements as a Array
    
    Returns:
    
    a new Array of all elements
  - matchesAny
```
default boolean matchesAny(BooleanPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
default boolean matchesNone(BooleanPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
default boolean matchesAll(BooleanPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
default boolean findFirst(BooleanPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - reduce
```
default boolean reduce(boolean identity,
                       BooleanBooleanUnaryOperator operator)
```
    Performs a reduction on the elements of this Iterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    identity - the start value
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
default boolean reduce(BooleanBooleanUnaryOperator operator)
```
    Performs a reduction on the elements of this Iterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - count
```
default int count(BooleanPredicate filter)
```
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements

Interface BooleanIterable

Method Summary

Method Detail

iterator

forEach

forEach

forEachIndexed

forEach

spliterator

asAsync

map

flatMap

arrayflatMap

filter

distinct

repeat

limit

sorted

peek

pour

pourAsList

toBooleanArray

matchesAny

matchesNone

matchesAll

findFirst

reduce

reduce

count