CharIterators (Primitive-Collections 0.8.0 API)

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

public class CharIterators
extends java.lang.Object

A Helper class for Iterators

Constructor Summary

Constructors
Constructor and Description

CharIterators()

Constructors
Constructor and Description
`CharIterators()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <E> ObjectIterator<E>`	`arrayFlatMap(CharIterator iterator, CharFunction<E[]> mapper)` A Helper function that flatMaps a Iterator into a new Type.
`static <E> ObjectIterator<E>`	`arrayFlatMap(java.util.Iterator<? extends java.lang.Character> iterator, CharFunction<E[]> mapper)` A Helper function that flatMaps a Java-Iterator into a new Type.
`static CharIterator`	`concat(CharIterator... array)` Helper Iterator that concats other iterators together
`static CharIterator`	`concat(CharIterator[] array, int offset, int length)` Helper Iterator that concats other iterators together
`static CharIterator`	`distinct(CharIterator iterator)` A Helper function that filters out all duplicated elements.
`static CharIterator`	`distinct(java.util.Iterator<? extends java.lang.Character> iterator)` A Helper function that filters out all duplicated elements from a Java Iterator.
`static speiger.src.collections.chars.utils.CharIterators.EmptyIterator`	`empty()` Returns a Immutable EmptyIterator instance that is automatically casted.
`static CharIterator`	`filter(CharIterator iterator, CharPredicate filter)` A Helper function that filters out all desired elements
`static CharIterator`	`filter(java.util.Iterator<? extends java.lang.Character> iterator, CharPredicate filter)` A Helper function that filters out all desired elements from a Java-Iterator
`static <E,V extends java.lang.Iterable<E>> ObjectIterator<E>`	`flatMap(CharIterator iterator, CharFunction<V> mapper)` A Helper function that flatMaps a Iterator into a new Type.
`static <E,V extends java.lang.Iterable<E>> ObjectIterator<E>`	`flatMap(java.util.Iterator<? extends java.lang.Character> iterator, CharFunction<V> mapper)` A Helper function that flatMaps a Java-Iterator into a new Type.
`static CharBidirectionalIterator`	`invert(CharBidirectionalIterator it)` Inverter function for Bidirectional Iterators
`static CharListIterator`	`invert(CharListIterator it)` Inverter function for List Iterators
`static CharIterator`	`limit(CharIterator iterator, long limit)` A Helper function that hard limits the Iterator to a specific size
`static CharIterator`	`limit(java.util.Iterator<? extends java.lang.Character> iterator, long limit)` A Helper function that hard limits the Iterator to a specific size from a Java Iterator
`static <E> ObjectIterator<E>`	`map(CharIterator iterator, CharFunction<E> mapper)` A Helper function that maps a Iterator into a new Type.
`static <E> ObjectIterator<E>`	`map(java.util.Iterator<? extends java.lang.Character> iterator, CharFunction<E> mapper)` A Helper function that maps a Java-Iterator into a new Type.
`static CharIterator`	`peek(CharIterator iterator, CharConsumer action)` A Helper function that allows to preview the result of a Iterator.
`static CharIterator`	`peek(java.util.Iterator<? extends java.lang.Character> iterator, CharConsumer action)` A Helper function that allows to preview the result of a Iterator from a Java Iterator
`static CharList`	`pour(CharIterator iter)` A Helper function to pours all elements of a Iterator into a List
`static int`	`pour(CharIterator iter, CharCollection c)` A Helper function to pours all elements of a Iterator into a Collection
`static int`	`pour(CharIterator iter, CharCollection c, int max)` A Helper function to pours all elements of a Iterator into a Collection
`static CharList`	`pour(CharIterator iter, int max)` A Helper function to pours all elements of a Iterator into a List
`static CharIterator`	`repeat(CharIterator iterator, int repeats)` A Helper function that repeats the Iterator a specific amount of times
`static CharIterator`	`repeat(java.util.Iterator<? extends java.lang.Character> iterator, int repeats)` A Helper function that repeats the Iterator a specific amount of times from a Java Iterator
`static CharIterator`	`sorted(CharIterator iterator, CharComparator sorter)` A Helper function that sorts the Iterator beforehand.
`static CharIterator`	`sorted(java.util.Iterator<? extends java.lang.Character> iterator, CharComparator sorter)` A Helper function that sorts the Iterator beforehand from a Java Iterator.
`static CharBidirectionalIterator`	`unmodifiable(CharBidirectionalIterator iterator)` Returns a Immutable Iterator instance based on the instance given.
`static CharIterator`	`unmodifiable(CharIterator iterator)` Returns a Immutable Iterator instance based on the instance given.
`static CharListIterator`	`unmodifiable(CharListIterator iterator)` Returns a Immutable ListIterator instance based on the instance given.
`static int`	`unwrap(char[] a, CharIterator i)` A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(char[] a, CharIterator i, int offset)` A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(char[] a, CharIterator i, int offset, int max)` A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(char[] a, java.util.Iterator<? extends java.lang.Character> i)` Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(char[] a, java.util.Iterator<? extends java.lang.Character> i, int offset)` Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(char[] a, java.util.Iterator<? extends java.lang.Character> i, int offset, int max)` Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
`static int`	`unwrap(java.lang.Character[] a, CharIterator i)` A Function to convert a Primitive Iterator to a Object array.
`static int`	`unwrap(java.lang.Character[] a, CharIterator i, int offset)` A Function to convert a Primitive Iterator to a Object array.
`static int`	`unwrap(java.lang.Character[] a, CharIterator i, int offset, int max)` A Function to convert a Primitive Iterator to a Object array.
`static speiger.src.collections.chars.utils.CharIterators.ArrayIterator`	`wrap(char... a)` Returns a Array Wrapping iterator
`static speiger.src.collections.chars.utils.CharIterators.ArrayIterator`	`wrap(char[] a, int start, int end)` Returns a Array Wrapping iterator
`static CharIterator`	`wrap(java.util.Iterator<? extends java.lang.Character> iterator)` Helper function to convert a Object Iterator into a Primitive Iterator

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

- Constructor Detail
  - CharIterators
```
public CharIterators()
```
- Method Detail
  - empty
```
public static speiger.src.collections.chars.utils.CharIterators.EmptyIterator empty()
```
    Returns a Immutable EmptyIterator instance that is automatically casted.
    
    Returns:
    
    an empty iterator
  - invert
```
public static CharBidirectionalIterator invert(CharBidirectionalIterator it)
```
    Inverter function for Bidirectional Iterators
    
    Parameters:
    
    it - the iterator that should be inverted
    
    Returns:
    
    a Inverted Bidirectional Iterator. If it was inverted then it just gives back the original reference
  - invert
```
public static CharListIterator invert(CharListIterator it)
```
    Inverter function for List Iterators
    
    Parameters:
    
    it - the iterator that should be inverted
    
    Returns:
    
    a Inverted List Iterator. If it was inverted then it just gives back the original reference
  - unmodifiable
```
public static CharIterator unmodifiable(CharIterator iterator)
```
    Returns a Immutable Iterator instance based on the instance given.
    
    Parameters:
    
    iterator - that should be made immutable/unmodifiable
    
    Returns:
    
    a unmodifiable iterator wrapper. If the Iterator already a unmodifiable wrapper then it just returns itself.
  - unmodifiable
```
public static CharBidirectionalIterator unmodifiable(CharBidirectionalIterator iterator)
```
    Returns a Immutable Iterator instance based on the instance given.
    
    Parameters:
    
    iterator - that should be made immutable/unmodifiable
    
    Returns:
    
    a unmodifiable iterator wrapper. If the Iterator already a unmodifiable wrapper then it just returns itself.
  - unmodifiable
```
public static CharListIterator unmodifiable(CharListIterator iterator)
```
    Returns a Immutable ListIterator instance based on the instance given.
    
    Parameters:
    
    iterator - that should be made immutable/unmodifiable
    
    Returns:
    
    a unmodifiable listiterator wrapper. If the ListIterator already a unmodifiable wrapper then it just returns itself.
  - map
```
public static <E> ObjectIterator<E> map(java.util.Iterator<? extends java.lang.Character> iterator,
                                        CharFunction<E> mapper)
```
    A Helper function that maps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is mapped to a new result
  - map
```
public static <E> ObjectIterator<E> map(CharIterator iterator,
                                        CharFunction<E> mapper)
```
    A Helper function that maps a Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be mapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is mapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterator<E> flatMap(java.util.Iterator<? extends java.lang.Character> iterator,
                                                                            CharFunction<V> mapper)
```
    A Helper function that flatMaps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - flatMap
```
public static <E,V extends java.lang.Iterable<E>> ObjectIterator<E> flatMap(CharIterator iterator,
                                                                            CharFunction<V> mapper)
```
    A Helper function that flatMaps a Iterator into a new Type.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterator<E> arrayFlatMap(java.util.Iterator<? extends java.lang.Character> iterator,
                                                 CharFunction<E[]> mapper)
```
    A Helper function that flatMaps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - arrayFlatMap
```
public static <E> ObjectIterator<E> arrayFlatMap(CharIterator iterator,
                                                 CharFunction<E[]> mapper)
```
    A Helper function that flatMaps a Iterator into a new Type.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    iterator - that should be flatMapped
    
    mapper - the function that decides what the result turns into.
    
    Returns:
    
    a iterator that is flatMapped to a new result
  - filter
```
public static CharIterator filter(java.util.Iterator<? extends java.lang.Character> iterator,
                                  CharPredicate filter)
```
    A Helper function that filters out all desired elements from a Java-Iterator
    
    Parameters:
    
    iterator - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterator
  - filter
```
public static CharIterator filter(CharIterator iterator,
                                  CharPredicate filter)
```
    A Helper function that filters out all desired elements
    
    Parameters:
    
    iterator - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterator
  - distinct
```
public static CharIterator distinct(CharIterator iterator)
```
    A Helper function that filters out all duplicated elements.
    
    Parameters:
    
    iterator - that should be distinct
    
    Returns:
    
    a distinct iterator
  - distinct
```
public static CharIterator distinct(java.util.Iterator<? extends java.lang.Character> iterator)
```
    A Helper function that filters out all duplicated elements from a Java Iterator.
    
    Parameters:
    
    iterator - that should be distinct
    
    Returns:
    
    a distinct iterator
  - repeat
```
public static CharIterator repeat(CharIterator iterator,
                                  int repeats)
```
    A Helper function that repeats the Iterator a specific amount of times
    
    Parameters:
    
    iterator - that should be repeated
    
    repeats - the amount of times the iterator should be repeated
    
    Returns:
    
    a repeating iterator
  - repeat
```
public static CharIterator repeat(java.util.Iterator<? extends java.lang.Character> iterator,
                                  int repeats)
```
    A Helper function that repeats the Iterator a specific amount of times from a Java Iterator
    
    Parameters:
    
    iterator - that should be repeated
    
    repeats - the amount of times the iterator should be repeated
    
    Returns:
    
    a repeating iterator
  - limit
```
public static CharIterator limit(CharIterator iterator,
                                 long limit)
```
    A Helper function that hard limits the Iterator to a specific size
    
    Parameters:
    
    iterator - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterator
  - limit
```
public static CharIterator limit(java.util.Iterator<? extends java.lang.Character> iterator,
                                 long limit)
```
    A Helper function that hard limits the Iterator to a specific size from a Java Iterator
    
    Parameters:
    
    iterator - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterator
  - sorted
```
public static CharIterator sorted(CharIterator iterator,
                                  CharComparator sorter)
```
    A Helper function that sorts the Iterator beforehand. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterator - that should be sorted.
    
    sorter - the sorter of the iterator. Can be null.
    
    Returns:
    
    a new sorted iterator
  - sorted
```
public static CharIterator sorted(java.util.Iterator<? extends java.lang.Character> iterator,
                                  CharComparator sorter)
```
    A Helper function that sorts the Iterator beforehand from a Java Iterator. This operation is heavily hurting performance because it rebuilds the entire iterator and then sorts it.
    
    Parameters:
    
    iterator - that should be sorted.
    
    sorter - the sorter of the iterator. Can be null.
    
    Returns:
    
    a new sorted iterator
  - peek
```
public static CharIterator peek(CharIterator iterator,
                                CharConsumer action)
```
    A Helper function that allows to preview the result of a Iterator.
    
    Parameters:
    
    iterator - that should be peeked at
    
    action - callback that receives the value before the iterator returns it
    
    Returns:
    
    a peeked iterator
  - peek
```
public static CharIterator peek(java.util.Iterator<? extends java.lang.Character> iterator,
                                CharConsumer action)
```
    A Helper function that allows to preview the result of a Iterator from a Java Iterator
    
    Parameters:
    
    iterator - that should be peeked at
    
    action - callback that receives the value before the iterator returns it
    
    Returns:
    
    a peeked iterator
  - wrap
```
public static CharIterator wrap(java.util.Iterator<? extends java.lang.Character> iterator)
```
    Helper function to convert a Object Iterator into a Primitive Iterator
    
    Parameters:
    
    iterator - that should be converted to a unboxing iterator
    
    Returns:
    
    a primitive iterator
  - wrap
```
public static speiger.src.collections.chars.utils.CharIterators.ArrayIterator wrap(char... a)
```
    Returns a Array Wrapping iterator
    
    Parameters:
    
    a - the array that should be wrapped
    
    Returns:
    
    a Iterator that is wrapping a array.
  - wrap
```
public static speiger.src.collections.chars.utils.CharIterators.ArrayIterator wrap(char[] a,
                                                                                   int start,
                                                                                   int end)
```
    Returns a Array Wrapping iterator
    
    Parameters:
    
    a - the array that should be wrapped.
    
    start - the index to be started from.
    
    end - the index that should be ended.
    
    Returns:
    
    a Iterator that is wrapping a array.
  - unwrap
```
public static int unwrap(char[] a,
                         java.util.Iterator<? extends java.lang.Character> i)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(char[] a,
                         java.util.Iterator<? extends java.lang.Character> i,
                         int offset)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(char[] a,
                         java.util.Iterator<? extends java.lang.Character> i,
                         int offset,
                         int max)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    max - the maximum values that should be extracted from the source
    
    Returns:
    
    the amount of elements that were inserted into the array.
    
    Throws:
    
    java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array
  - unwrap
```
public static int unwrap(char[] a,
                         CharIterator i)
```
    A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(char[] a,
                         CharIterator i,
                         int offset)
```
    A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(char[] a,
                         CharIterator i,
                         int offset,
                         int max)
```
    A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    max - the maximum values that should be extracted from the source
    
    Returns:
    
    the amount of elements that were inserted into the array.
    
    Throws:
    
    java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array
  - unwrap
```
public static int unwrap(java.lang.Character[] a,
                         CharIterator i)
```
    A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(java.lang.Character[] a,
                         CharIterator i,
                         int offset)
```
    A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    Returns:
    
    the amount of elements that were inserted into the array.
  - unwrap
```
public static int unwrap(java.lang.Character[] a,
                         CharIterator i,
                         int offset,
                         int max)
```
    A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Parameters:
    
    a - where the elements should be inserted
    
    i - the source iterator
    
    offset - the array offset where the start should be
    
    max - the maximum values that should be extracted from the source
    
    Returns:
    
    the amount of elements that were inserted into the array.
    
    Throws:
    
    java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array
  - pour
```
public static CharList pour(CharIterator iter)
```
    A Helper function to pours all elements of a Iterator into a List
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    Returns:
    
    A list of all elements of the Iterator
  - pour
```
public static CharList pour(CharIterator iter,
                            int max)
```
    A Helper function to pours all elements of a Iterator into a List
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    max - the maximum amount of elements that should be collected
    
    Returns:
    
    A list of all requested elements of the Iterator
  - pour
```
public static int pour(CharIterator iter,
                       CharCollection c)
```
    A Helper function to pours all elements of a Iterator into a Collection
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    c - the collection where the elements should be poured into
    
    Returns:
    
    the amount of elements that were added
  - pour
```
public static int pour(CharIterator iter,
                       CharCollection c,
                       int max)
```
    A Helper function to pours all elements of a Iterator into a Collection
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    c - the collection where the elements should be poured into
    
    max - the maximum amount of elements that should be collected
    
    Returns:
    
    the amount of elements that were added
  - concat
```
public static CharIterator concat(CharIterator... array)
```
    Helper Iterator that concats other iterators together
    
    Parameters:
    
    array - the Iterators that should be concatenated
    
    Returns:
    
    iterator of the inputted iterators
  - concat
```
public static CharIterator concat(CharIterator[] array,
                                  int offset,
                                  int length)
```
    Helper Iterator that concats other iterators together
    
    Parameters:
    
    array - the Iterators that should be concatenated
    
    offset - where to start within the array
    
    length - the length of the array
    
    Returns:
    
    iterator of the inputted iterators

Class CharIterators

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CharIterators

Method Detail

empty

invert

invert

unmodifiable

unmodifiable

unmodifiable

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

repeat

repeat

limit

limit

sorted

sorted

peek

peek

wrap

wrap

wrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

pour

pour

pour

pour

concat

concat