BooleanAsyncBuilder (Primitive-Collections 0.8.0 API)

java.lang.Object
- speiger.src.collections.booleans.utils.BooleanAsyncBuilder

```
public class BooleanAsyncBuilder
extends java.lang.Object
```
The Async API allows you to process collections on a different thread without having to deal with the Multithreading complexity.
It uses the Lightweight Stream Replace API to do its work, which can make it faster then sequential streams.
This feature isn't designed to do Multithreading work, but to allow moving work off the main thread into a worker thread.
So anything executed on this is still Singlethreaded.

How it works is you create the AsyncBuilder using a Iterable of the Type.
Then select things you want to use on the Iterable.
- For example: map/filter/peek/limit/etc

After that you select your action the Iterable should be applied on.
- For Example: forEach/findFirst/matchAny/etc

Then optionally a custom Executor or callback can be applied
At the end either execute or join can be called to start the task.
- execute will return the Task reference so that the task can be traced back.
- join will await the completion of the task and return the return value

During Construction a couple Disposable Builder Objects will be created.
These will be only used during construction.

The Task Object is also pause-able/Interruptable at any moment during the Processing.
A small example
```
 public void processFiles(ObjectCollection<String> potentialFiles) {
        potentialFiles.asAsync()
                .map(Paths::get).filter(Files::exists) //Modifies the collection (Optional)
                .forEach(Files::delete) //Creates the action (Required)
                .onCompletion(T -> {}} //Callback on completion (Optional)
                .execute() //Starts the task. (Required)
 }
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BooleanAsyncBuilder.BaseBooleanTask
Base Task of the Actions that can be performed.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BooleanAsyncBuilder.BaseBooleanTask` Base Task of the Actions that can be performed.

Constructor Summary

Constructors
Constructor and Description
`BooleanAsyncBuilder(BooleanAsyncBuilder.BaseBooleanTask task)` Helper constructor.
`BooleanAsyncBuilder(BooleanIterable iterable)` Main Constructor that uses a Iterable to build a Offthread Task.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<E> ObjectAsyncBuilder<E>`	`arrayflatMap(BooleanFunction<E[]> mapper)` Maps the elements to something else
`IntAsyncBuilder`	`count(BooleanPredicate filter)` Counts all desired elements inside the Iterable
`BooleanAsyncBuilder`	`distinct()` Removes duplicated elements out of the Iterable
`BooleanTask`	`execute()` Starts the Execution of the task without awaiting its result
`BooleanAsyncBuilder`	`executor(java.util.concurrent.Executor executor)` Optional way to add a custom executor that runs this offthread task.
`BooleanAsyncBuilder`	`filter(BooleanPredicate filter)` Filters out the unwanted elements out of the Iterable
`BooleanAsyncBuilder`	`findFirst(BooleanPredicate filter)` Searches through the elements of the Iterable to find if the desired element.
`<E,V extends java.lang.Iterable<E>> ObjectAsyncBuilder<E>`	`flatMap(BooleanFunction<V> mapper)` Maps the elements to something else
`ObjectAsyncBuilder<java.lang.Void>`	`forEach(BooleanConsumer action)` Iterates over the Iterable with a desired action
`boolean`	`join()` Starts the Execution of the task and will await its completion, returning the result.
`boolean`	`join(long timeout, java.util.concurrent.TimeUnit unit)` Starts the Execution of the task and will await its completion with a timeout, returning the result.
`BooleanAsyncBuilder`	`limit(long limit)` Limits how many elements are inside of the Iterable
`<E> ObjectAsyncBuilder<E>`	`map(BooleanFunction<E> mapper)` Maps the elements to something else
`BooleanAsyncBuilder`	`matchAll(BooleanPredicate filter)` Searches through the elements of the Iterable to find if all the desired elements are present.
`BooleanAsyncBuilder`	`matchAny(BooleanPredicate filter)` Searches through the elements of the Iterable to find if the desired element is present.
`BooleanAsyncBuilder`	`matchNone(BooleanPredicate filter)` Searches through the elements of the Iterable to find if unwanted elements are present.
`static BooleanAsyncBuilder`	`of(boolean... values)` Helper function that automatically wraps a array into a AsyncBuilder since it forces this collections Iterable.
`static BooleanAsyncBuilder`	`of(java.lang.Iterable<java.lang.Boolean> iterable)` Helper function that automatically wraps a Iterable into a AsyncBuilder since it forces this collections Iterable.
`BooleanAsyncBuilder`	`onCompletion(java.util.function.Consumer<BooleanTask> callback)` Optional way to set a callback that allows to compute actions after the task was completed.
`BooleanAsyncBuilder`	`peek(BooleanConsumer action)` Allows to preview elements before they are processed
`<E extends BooleanCollection> ObjectAsyncBuilder<E>`	`pour(E collection)` Pours all elements into a collection that can be later
`ObjectAsyncBuilder<BooleanList>`	`pourAsList()` Pours all elements into a List that can be later
`BooleanAsyncBuilder`	`reduce(boolean identity, BooleanBooleanUnaryOperator operator)` Reduces the elements inside of the Iterable down to one element using a identity element.
`BooleanAsyncBuilder`	`reduce(BooleanBooleanUnaryOperator operator)` Reduces the elements inside of the Iterable down to one element
`BooleanAsyncBuilder`	`repeat(int repeats)` Repeats the elements inside of the Iterable
`BooleanAsyncBuilder`	`sorted(BooleanComparator sorter)` Sorts the elements inside of the Iterable.
`ObjectAsyncBuilder<boolean[]>`	`toBooleanArray()` Pours all elements of the Iterable down into a Array.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BooleanAsyncBuilder
```
public BooleanAsyncBuilder(BooleanIterable iterable)
```
    Main Constructor that uses a Iterable to build a Offthread Task.
    
    Parameters:
    
    iterable - that should be processed
  - BooleanAsyncBuilder
```
public BooleanAsyncBuilder(BooleanAsyncBuilder.BaseBooleanTask task)
```
    Helper constructor.
    
    Parameters:
    
    task - that had been build
- Method Detail
  - of
```
public static BooleanAsyncBuilder of(java.lang.Iterable<java.lang.Boolean> iterable)
```
    Helper function that automatically wraps a Iterable into a AsyncBuilder since it forces this collections Iterable.
    
    Parameters:
    
    iterable - that should be wrapped
    
    Returns:
    
    a AsyncBuilder with the iterable wrapped
  - of
```
public static BooleanAsyncBuilder of(boolean... values)
```
    Helper function that automatically wraps a array into a AsyncBuilder since it forces this collections Iterable.
    
    Parameters:
    
    values - that should be wrapped
    
    Returns:
    
    a AsyncBuilder with the values wrapped
  - map
```
public <E> ObjectAsyncBuilder<E> map(BooleanFunction<E> mapper)
```
    Maps the elements to something else
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    mapper - the mapping function
    
    Returns:
    
    a new Builder Object with the mapped Iterable
  - flatMap
```
public <E,V extends java.lang.Iterable<E>> ObjectAsyncBuilder<E> flatMap(BooleanFunction<V> mapper)
```
    Maps the elements to something else
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    mapper - the flatMapping function
    
    Returns:
    
    a new Builder Object with the mapped Iterable
  - arrayflatMap
```
public <E> ObjectAsyncBuilder<E> arrayflatMap(BooleanFunction<E[]> mapper)
```
    Maps the elements to something else
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    mapper - the flatMapping function
    
    Returns:
    
    a new Builder Object with the mapped Iterable
  - filter
```
public BooleanAsyncBuilder filter(BooleanPredicate filter)
```
    Filters out the unwanted elements out of the Iterable
    
    Parameters:
    
    filter - the elements that should be kept
    
    Returns:
    
    Self with a filter applied
  - distinct
```
public BooleanAsyncBuilder distinct()
```
    Removes duplicated elements out of the Iterable
    
    Returns:
    
    Self with a deduplicator applied
  - repeat
```
public BooleanAsyncBuilder repeat(int repeats)
```
    Repeats the elements inside of the Iterable
    
    Parameters:
    
    repeats - the amount of times the elements should be repeated
    
    Returns:
    
    self with a repeater applied
  - limit
```
public BooleanAsyncBuilder limit(long limit)
```
    Limits how many elements are inside of the Iterable
    
    Parameters:
    
    limit - how many elements should max be iterated through
    
    Returns:
    
    self with a limiter applied
  - sorted
```
public BooleanAsyncBuilder sorted(BooleanComparator sorter)
```
    Sorts the elements inside of the Iterable. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it, and this will affect the pausing feature.
    
    Parameters:
    
    sorter - that sorts the elements.
    
    Returns:
    
    self with a sorter applied
  - peek
```
public BooleanAsyncBuilder peek(BooleanConsumer action)
```
    Allows to preview elements before they are processed
    
    Parameters:
    
    action - the action that should be applied
    
    Returns:
    
    self with a preview applied
  - forEach
```
public ObjectAsyncBuilder<java.lang.Void> forEach(BooleanConsumer action)
```
    Iterates over the Iterable with a desired action
    
    Parameters:
    
    action - that should be applied
    
    Returns:
    
    a new Builder with the forEach action applied.
  - reduce
```
public BooleanAsyncBuilder reduce(BooleanBooleanUnaryOperator operator)
```
    Reduces the elements inside of the Iterable down to one element
    
    Parameters:
    
    operator - that reduces the elements.
    
    Returns:
    
    self with the reduce action applied
  - reduce
```
public BooleanAsyncBuilder reduce(boolean identity,
                                  BooleanBooleanUnaryOperator operator)
```
    Reduces the elements inside of the Iterable down to one element using a identity element.
    
    Parameters:
    
    identity - the element the reduce function should start with
    
    operator - that reduces the elements.
    
    Returns:
    
    a new Builder with the reduce function applied
  - toBooleanArray
```
public ObjectAsyncBuilder<boolean[]> toBooleanArray()
```
    Pours all elements of the Iterable down into a Array.
    
    Returns:
    
    a new Builder with the ToArray function applied
  - pourAsList
```
public ObjectAsyncBuilder<BooleanList> pourAsList()
```
    Pours all elements into a List that can be later
    
    Returns:
    
    a new Builder with the pour function applied
  - pour
```
public <E extends BooleanCollection> ObjectAsyncBuilder<E> pour(E collection)
```
    Pours all elements into a collection that can be later
    
    Type Parameters:
    
    E - the return type
    
    Parameters:
    
    collection - the collection the elements
    
    Returns:
    
    a new Builder with the pour function applied
  - matchAny
```
public BooleanAsyncBuilder matchAny(BooleanPredicate filter)
```
    Searches through the elements of the Iterable to find if the desired element is present.
    
    Parameters:
    
    filter - that decides the desired elements
    
    Returns:
    
    a new Builder with the matchAny function applied
  - matchNone
```
public BooleanAsyncBuilder matchNone(BooleanPredicate filter)
```
    Searches through the elements of the Iterable to find if unwanted elements are present.
    
    Parameters:
    
    filter - that decides the unwanted elements
    
    Returns:
    
    a new Builder with the matchNone function applied
  - matchAll
```
public BooleanAsyncBuilder matchAll(BooleanPredicate filter)
```
    Searches through the elements of the Iterable to find if all the desired elements are present.
    
    Parameters:
    
    filter - that decides the desired elements
    
    Returns:
    
    a new Builder with the matchAll function applied
  - findFirst
```
public BooleanAsyncBuilder findFirst(BooleanPredicate filter)
```
    Searches through the elements of the Iterable to find if the desired element. If not present it will return the default value of the type
    
    Parameters:
    
    filter - that decides the desired elements
    
    Returns:
    
    self with the findFirst function applied
  - count
```
public IntAsyncBuilder count(BooleanPredicate filter)
```
    Counts all desired elements inside the Iterable
    
    Parameters:
    
    filter - that decides the desired elements
    
    Returns:
    
    a new Builder with the count function applied
  - executor
```
public BooleanAsyncBuilder executor(java.util.concurrent.Executor executor)
```
    Optional way to add a custom executor that runs this offthread task. Can only be set after the action was decided on.
    
    Parameters:
    
    executor - that executes the task, defaults to SanityChecks.invokeAsyncTask(Runnable)
    
    Returns:
    
    self with the executor set
    
    Note:
    
    has to be NonNull
  - onCompletion
```
public BooleanAsyncBuilder onCompletion(java.util.function.Consumer<BooleanTask> callback)
```
    Optional way to set a callback that allows to compute actions after the task was completed. The state of the task has to be validated by the callback.
    
    Parameters:
    
    callback - that should be notified after completion of the task
    
    Returns:
    
    self with the callback set
    
    Note:
    
    can be null
  - execute
```
public BooleanTask execute()
```
    Starts the Execution of the task without awaiting its result
    
    Returns:
    
    the task object that allow to trace it.
  - join
```
public boolean join()
             throws java.util.concurrent.ExecutionException,
                    java.lang.InterruptedException
```
    Starts the Execution of the task and will await its completion, returning the result.
    
    Returns:
    
    the result of the task provided.
    
    Throws:
    
    java.util.concurrent.ExecutionException - if the task threw a exception
    
    java.lang.InterruptedException - if the caller thread was interrupted
  - join
```
public boolean join(long timeout,
                    java.util.concurrent.TimeUnit unit)
             throws java.lang.InterruptedException,
                    java.util.concurrent.ExecutionException,
                    java.util.concurrent.TimeoutException
```
    Starts the Execution of the task and will await its completion with a timeout, returning the result.
    
    Parameters:
    
    timeout - of how long the thread should wait the task to be completed
    
    unit - of the desired waiting time.
    
    Returns:
    
    the result of the provided task
    
    Throws:
    
    java.lang.InterruptedException - if the caller thread was interrupted
    
    java.util.concurrent.ExecutionException - if the task threw a exception
    
    java.util.concurrent.TimeoutException - if the timeout was reached before the task was finished

Class BooleanAsyncBuilder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BooleanAsyncBuilder

BooleanAsyncBuilder

Method Detail

of

of

map

flatMap

arrayflatMap

filter

distinct

repeat

limit

sorted

peek

forEach

reduce

reduce

toBooleanArray

pourAsList

pour

matchAny

matchNone

matchAll

findFirst

count

executor

onCompletion

execute

join

join