CharIterables (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.chars.utils.CharIterables

public class CharIterables
extends java.lang.Object

A Helper class for Iterables

Constructor Summary

Constructors
Constructor and Description

CharIterables()

Constructors
Constructor and Description
`CharIterables()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <E> ObjectIterable<E>`	`arrayFlatMap(CharIterable iterable, Char2ObjectFunction<E[]> mapper)` A Helper function that flatMaps a Iterable into a new Type.
`static <E> ObjectIterable<E>`	`arrayFlatMap(java.lang.Iterable<? extends java.lang.Character> iterable, Char2ObjectFunction<E[]> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static CharIterable`	`distinct(CharIterable iterable)` A Helper function that filters out all duplicated elements.
`static CharIterable`	`distinct(java.lang.Iterable<? extends java.lang.Character> iterable)` A Helper function that filters out all duplicated elements from a Java Iterable.
`static CharIterable`	`filter(CharIterable iterable, Char2BooleanFunction filter)` A Helper function that filters out all desired elements
`static CharIterable`	`filter(java.lang.Iterable<? extends java.lang.Character> iterable, Char2BooleanFunction 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(CharIterable iterable, Char2ObjectFunction<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.Character> iterable, Char2ObjectFunction<V> mapper)` A Helper function that flatMaps a Java-Iterable into a new Type.
`static CharIterable`	`limit(CharIterable iterable, long limit)` A Helper function that hard limits the Iterable to a specific size
`static CharIterable`	`limit(java.lang.Iterable<? extends java.lang.Character> iterable, long limit)` A Helper function that hard limits the Iterable to a specific size from a Java Iterable
`static <E> ObjectIterable<E>`	`map(CharIterable iterable, Char2ObjectFunction<E> mapper)` A Helper function that maps a Iterable into a new Type.
`static <E> ObjectIterable<E>`	`map(java.lang.Iterable<? extends java.lang.Character> iterable, Char2ObjectFunction<E> mapper)` A Helper function that maps a Java-Iterable into a new Type.
`static CharIterable`	`peek(CharIterable iterable, CharConsumer action)` A Helper function that allows to preview the result of a Iterable.
`static CharIterable`	`peek(java.lang.Iterable<? extends java.lang.Character> iterable, CharConsumer action)` A Helper function that allows to preview the result of a Iterable from a Java Iterable
`static CharIterable`	`sorted(CharIterable iterable, CharComparator sorter)` A Helper function that sorts the Iterable.
`static CharIterable`	`sorted(java.lang.Iterable<? extends java.lang.Character> iterable, CharComparator 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 CharIterable`	`wrap(java.lang.Iterable<? extends java.lang.Character> 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
  - CharIterables
```
public CharIterables()
```
- Method Detail
  - map
```
public static <E> ObjectIterable<E> map(java.lang.Iterable<? extends java.lang.Character> iterable,
                                        Char2ObjectFunction<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(CharIterable iterable,
                                        Char2ObjectFunction<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.Character> iterable,
                                                                            Char2ObjectFunction<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(CharIterable iterable,
                                                                            Char2ObjectFunction<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.Character> iterable,
                                                 Char2ObjectFunction<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(CharIterable iterable,
                                                 Char2ObjectFunction<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 CharIterable filter(java.lang.Iterable<? extends java.lang.Character> iterable,
                                  Char2BooleanFunction 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 CharIterable filter(CharIterable iterable,
                                  Char2BooleanFunction 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 CharIterable distinct(CharIterable iterable)
```
    A Helper function that filters out all duplicated elements.
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - distinct
```
public static CharIterable distinct(java.lang.Iterable<? extends java.lang.Character> iterable)
```
    A Helper function that filters out all duplicated elements from a Java Iterable.
    
    Parameters:
    
    iterable - that should be distinct
    
    Returns:
    
    a distinct iterable
  - limit
```
public static CharIterable limit(CharIterable 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 CharIterable limit(java.lang.Iterable<? extends java.lang.Character> 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 CharIterable sorted(CharIterable iterable,
                                  CharComparator 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 CharIterable sorted(java.lang.Iterable<? extends java.lang.Character> iterable,
                                  CharComparator 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 CharIterable peek(CharIterable iterable,
                                CharConsumer 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 CharIterable peek(java.lang.Iterable<? extends java.lang.Character> iterable,
                                CharConsumer 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 CharIterable wrap(java.lang.Iterable<? extends java.lang.Character> 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 CharIterables

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CharIterables

Method Detail

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

limit

limit

sorted

sorted

peek

peek

wrap