ObjectIterables (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.objects.utils.ObjectIterables

public class ObjectIterables
extends java.lang.Object

A Helper class for Iterables

Constructor Summary

Constructors
Constructor and Description

ObjectIterables()

Constructors
Constructor and Description
`ObjectIterables()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T,E> ObjectIterable<E>`	`arrayFlatMap(java.lang.Iterable<? extends T> iterable, Object2ObjectFunction<T,E[]> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static <T,E> ObjectIterable<E>`	`arrayFlatMap(ObjectIterable<T> iterable, Object2ObjectFunction<T,E[]> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <T> ObjectIterable<T>`	`distinct(java.lang.Iterable<? extends T> iterable)` A Helper function that filters out all duplicated elements from a Java Iterable.
`static <T> ObjectIterable<T>`	`distinct(ObjectIterable<T> iterable)` A Helper function that filters out all duplicated elements.
`static <T> ObjectIterable<T>`	`filter(java.lang.Iterable<? extends T> iterable, Object2BooleanFunction<T> filter)` A Helper function that filters out all desired elements from a Java-Iterable
`static <T> ObjectIterable<T>`	`filter(ObjectIterable<T> iterable, Object2BooleanFunction<T> filter)` A Helper function that filters out all desired elements
`static <T,E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(java.lang.Iterable<? extends T> iterable, Object2ObjectFunction<T,V> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static <T,E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(ObjectIterable<T> iterable, Object2ObjectFunction<T,V> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <T> ObjectIterable<T>`	`limit(java.lang.Iterable<? extends T> iterable, long limit)` A Helper function that hard limits the Iterable to a specific size from a Java Iterable
`static <T> ObjectIterable<T>`	`limit(ObjectIterable<T> iterable, long limit)` A Helper function that hard limits the Iterable to a specific size
`static <T,E> ObjectIterable<E>`	`map(java.lang.Iterable<? extends T> iterable, Object2ObjectFunction<T,E> mapper)` A Helper function that maps a Java-Iterable into a new Type.
`static <T,E> ObjectIterable<E>`	`map(ObjectIterable<T> iterable, Object2ObjectFunction<T,E> mapper)` A Helper function that maps a Iterable into a new Type.
`static <T> ObjectIterable<T>`	`peek(java.lang.Iterable<? extends T> iterable, java.util.function.Consumer<T> action)` A Helper function that allows to preview the result of a Iterable from a Java Iterable
`static <T> ObjectIterable<T>`	`peek(ObjectIterable<T> iterable, java.util.function.Consumer<T> action)` A Helper function that allows to preview the result of a Iterable.
`static <T> ObjectIterable<T>`	`sorted(java.lang.Iterable<? extends T> iterable, java.util.Comparator<T> 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 <T> ObjectIterable<T>`	`sorted(ObjectIterable<T> iterable, java.util.Comparator<T> sorter)` A Helper function that sorts the Iterable.
`static <T> ObjectIterable<T>`	`wrap(java.lang.Iterable<? extends T> 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
  - ObjectIterables
```
public ObjectIterables()
```
- Method Detail
  - map
```
public static <T,E> ObjectIterable<E> map(java.lang.Iterable<? extends T> iterable,
                                          Object2ObjectFunction<T,E> mapper)
```
    A Helper function that maps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E> ObjectIterable<E> map(ObjectIterable<T> iterable,
                                          Object2ObjectFunction<T,E> mapper)
```
    A Helper function that maps a Iterable into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(java.lang.Iterable<? extends T> iterable,
                                                                              Object2ObjectFunction<T,V> mapper)
```
    A Helper function that flatMaps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(ObjectIterable<T> iterable,
                                                                              Object2ObjectFunction<T,V> mapper)
```
    A Helper function that flatMaps a Iterable into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E> ObjectIterable<E> arrayFlatMap(java.lang.Iterable<? extends T> iterable,
                                                   Object2ObjectFunction<T,E[]> mapper)
```
    A Helper function that flatMaps a Java-Iterable into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E> ObjectIterable<E> arrayFlatMap(ObjectIterable<T> iterable,
                                                   Object2ObjectFunction<T,E[]> mapper)
```
    A Helper function that flatMaps a Iterable into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterable<T> filter(java.lang.Iterable<? extends T> iterable,
                                           Object2BooleanFunction<T> filter)
```
    A Helper function that filters out all desired elements from a Java-Iterable
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterable
  - filter
```
public static <T> ObjectIterable<T> filter(ObjectIterable<T> iterable,
                                           Object2BooleanFunction<T> filter)
```
    A Helper function that filters out all desired elements
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterable
  - distinct
```
public static <T> ObjectIterable<T> distinct(ObjectIterable<T> iterable)
```
    A Helper function that filters out all duplicated elements.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - distinct
```
public static <T> ObjectIterable<T> distinct(java.lang.Iterable<? extends T> iterable)
```
    A Helper function that filters out all duplicated elements from a Java Iterable.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - limit
```
public static <T> ObjectIterable<T> limit(ObjectIterable<T> iterable,
                                          long limit)
```
    A Helper function that hard limits the Iterable to a specific size
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterable
  - limit
```
public static <T> ObjectIterable<T> limit(java.lang.Iterable<? extends T> iterable,
                                          long limit)
```
    A Helper function that hard limits the Iterable to a specific size from a Java Iterable
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterable
  - sorted
```
public static <T> ObjectIterable<T> sorted(ObjectIterable<T> iterable,
                                           java.util.Comparator<T> sorter)
```
    A Helper function that sorts the Iterable. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be sorted
    
    sorter - that sorts the iterable. Can be null.
    
    Returns:
    
    a sorted iterable.
  - sorted
```
public static <T> ObjectIterable<T> sorted(java.lang.Iterable<? extends T> iterable,
                                           java.util.Comparator<T> 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.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be sorted
    
    sorter - that sorts the iterable. Can be null.
    
    Returns:
    
    a sorted iterable.
  - peek
```
public static <T> ObjectIterable<T> peek(ObjectIterable<T> iterable,
                                         java.util.function.Consumer<T> action)
```
    A Helper function that allows to preview the result of a Iterable.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterable<T> peek(java.lang.Iterable<? extends T> iterable,
                                         java.util.function.Consumer<T> action)
```
    A Helper function that allows to preview the result of a Iterable from a Java Iterable
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterable<T> wrap(java.lang.Iterable<? extends T> iterable)
```
    A Wrapper function that wraps a Java-Iterable into a Type Specific Iterable
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterable - that should be wrapped
    
    Returns:
    
    a type specific iterable

Class ObjectIterables

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectIterables

Method Detail

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

limit

limit

sorted

sorted

peek

peek

wrap