BooleanIterables (Primitive-Collections 0.8.0 API)

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

public class BooleanIterables
extends java.lang.Object

A Helper class for Iterables

Constructor Summary

Constructors
Constructor and Description

BooleanIterables()

Constructors
Constructor and Description
`BooleanIterables()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <E> ObjectIterable<E>`	`arrayFlatMap(BooleanIterable iterable, BooleanFunction<E[]> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <E> ObjectIterable<E>`	`arrayFlatMap(java.lang.Iterable<? extends java.lang.Boolean> iterable, BooleanFunction<E[]> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static BooleanIterable`	`distinct(BooleanIterable iterable)` A Helper function that filters out all duplicated elements.
`static BooleanIterable`	`distinct(java.lang.Iterable<? extends java.lang.Boolean> iterable)` A Helper function that filters out all duplicated elements from a Java Iterable.
`static BooleanIterable`	`filter(BooleanIterable iterable, BooleanPredicate filter)` A Helper function that filters out all desired elements
`static BooleanIterable`	`filter(java.lang.Iterable<? extends java.lang.Boolean> iterable, BooleanPredicate filter)` A Helper function that filters out all desired elements from a Java-Iterable
`static <E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(BooleanIterable iterable, BooleanFunction<V> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(java.lang.Iterable<? extends java.lang.Boolean> iterable, BooleanFunction<V> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static BooleanIterable`	`limit(BooleanIterable iterable, long limit)` A Helper function that hard limits the Iterable to a specific size
`static BooleanIterable`	`limit(java.lang.Iterable<? extends java.lang.Boolean> iterable, long limit)` A Helper function that hard limits the Iterable to a specific size from a Java Iterable
`static <E> ObjectIterable<E>`	`map(BooleanIterable iterable, BooleanFunction<E> mapper)` A Helper function that maps a Iterable into a new Type.
`static <E> ObjectIterable<E>`	`map(java.lang.Iterable<? extends java.lang.Boolean> iterable, BooleanFunction<E> mapper)` A Helper function that maps a Java-Iterable into a new Type.
`static BooleanIterable`	`peek(BooleanIterable iterable, BooleanConsumer action)` A Helper function that allows to preview the result of a Iterable.
`static BooleanIterable`	`peek(java.lang.Iterable<? extends java.lang.Boolean> iterable, BooleanConsumer action)` A Helper function that allows to preview the result of a Iterable from a Java Iterable
`static BooleanIterable`	`repeat(BooleanIterable iterable, int repeats)` A Helper function that repeats the Iterable a specific amount of times
`static BooleanIterable`	`repeat(java.lang.Iterable<? extends java.lang.Boolean> iterable, int repeats)` A Helper function that repeats the Iterable a specific amount of times from a Java Iterable
`static BooleanIterable`	`sorted(BooleanIterable iterable, BooleanComparator sorter)` A Helper function that sorts the Iterable.
`static BooleanIterable`	`sorted(java.lang.Iterable<? extends java.lang.Boolean> iterable, BooleanComparator sorter)` A Helper function that sorts the Iterable from a Java Iterable This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
`static BooleanIterable`	`wrap(java.lang.Iterable<? extends java.lang.Boolean> iterable)` A Wrapper function that wraps a Java-Iterable into a Type Specific Iterable

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

- Constructor Detail
  - BooleanIterables
```
public BooleanIterables()
```
- Method Detail
  - map
```
public static <E> ObjectIterable<E> map(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                        BooleanFunction<E> mapper)
```
    A Helper function that maps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is mapped to a new result
  - map
```
public static <E> ObjectIterable<E> map(BooleanIterable iterable,
                                        BooleanFunction<E> mapper)
```
    A Helper function that maps a Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is mapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                                                            BooleanFunction<V> mapper)
```
    A Helper function that flatMaps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(BooleanIterable iterable,
                                                                            BooleanFunction<V> mapper)
```
    A Helper function that flatMaps a Iterable into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterable<E> arrayFlatMap(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                                 BooleanFunction<E[]> mapper)
```
    A Helper function that flatMaps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterable<E> arrayFlatMap(BooleanIterable iterable,
                                                 BooleanFunction<E[]> mapper)
```
    A Helper function that flatMaps a Iterable into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterable - the iterable that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterable that is flatMapped to a new result
  - filter
```
public static BooleanIterable filter(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                     BooleanPredicate filter)
```
    A Helper function that filters out all desired elements from a Java-Iterable
    
    Parameters:
    
    iterable - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterable
  - filter
```
public static BooleanIterable filter(BooleanIterable iterable,
                                     BooleanPredicate filter)
```
    A Helper function that filters out all desired elements
    
    Parameters:
    
    iterable - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterable
  - distinct
```
public static BooleanIterable distinct(BooleanIterable iterable)
```
    A Helper function that filters out all duplicated elements.
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - distinct
```
public static BooleanIterable distinct(java.lang.Iterable<? extends java.lang.Boolean> iterable)
```
    A Helper function that filters out all duplicated elements from a Java Iterable.
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - repeat
```
public static BooleanIterable repeat(BooleanIterable iterable,
                                     int repeats)
```
    A Helper function that repeats the Iterable a specific amount of times
    
    Parameters:
    
    iterable - that should be repeated
    
    repeats - the amount of times the iterable should be repeated
    
    Returns:
    
    a repeating iterable
  - repeat
```
public static BooleanIterable repeat(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                     int repeats)
```
    A Helper function that repeats the Iterable a specific amount of times from a Java Iterable
    
    Parameters:
    
    iterable - that should be repeated
    
    repeats - the amount of times the iterable should be repeated
    
    Returns:
    
    a repeating iterable
  - limit
```
public static BooleanIterable limit(BooleanIterable iterable,
                                    long limit)
```
    A Helper function that hard limits the Iterable to a specific size
    
    Parameters:
    
    iterable - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterable
  - limit
```
public static BooleanIterable limit(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                    long limit)
```
    A Helper function that hard limits the Iterable to a specific size from a Java Iterable
    
    Parameters:
    
    iterable - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterable
  - sorted
```
public static BooleanIterable sorted(BooleanIterable iterable,
                                     BooleanComparator sorter)
```
    A Helper function that sorts the Iterable. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterable - that should be sorted
    
    sorter - that sorts the iterable. Can be null.
    
    Returns:
    
    a sorted iterable.
  - sorted
```
public static BooleanIterable sorted(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                     BooleanComparator sorter)
```
    A Helper function that sorts the Iterable from a Java Iterable This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterable - that should be sorted
    
    sorter - that sorts the iterable. Can be null.
    
    Returns:
    
    a sorted iterable.
  - peek
```
public static BooleanIterable peek(BooleanIterable iterable,
                                   BooleanConsumer action)
```
    A Helper function that allows to preview the result of a Iterable.
    
    Parameters:
    
    iterable - that should be peeked at
    
    action - callback that receives the value before the iterable returns it
    
    Returns:
    
    a peeked iterable
  - peek
```
public static BooleanIterable peek(java.lang.Iterable<? extends java.lang.Boolean> iterable,
                                   BooleanConsumer action)
```
    A Helper function that allows to preview the result of a Iterable from a Java Iterable
    
    Parameters:
    
    iterable - that should be peeked at
    
    action - callback that receives the value before the iterable returns it
    
    Returns:
    
    a peeked iterable
  - wrap
```
public static BooleanIterable wrap(java.lang.Iterable<? extends java.lang.Boolean> iterable)
```
    A Wrapper function that wraps a Java-Iterable into a Type Specific Iterable
    
    Parameters:
    
    iterable - that should be wrapped
    
    Returns:
    
    a type specific iterable

Class BooleanIterables

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BooleanIterables

Method Detail

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

repeat

repeat

limit

limit

sorted

sorted

peek

peek

wrap