ObjectIterators (Primitive-Collections 0.7.0 API)

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

public class ObjectIterators
extends java.lang.Object

A Helper class for Iterators

Constructor Summary

Constructors
Constructor and Description

ObjectIterators()

Constructors
Constructor and Description
`ObjectIterators()`

Method Summary

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

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

- Constructor Detail
  - ObjectIterators
```
public ObjectIterators()
```
- Method Detail
  - empty
```
public static <T> speiger.src.collections.objects.utils.ObjectIterators.EmptyIterator<T> empty()
```
    Returns a Immutable EmptyIterator instance that is automatically casted.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Returns:
    
    an empty iterator
  - invert
```
public static <T> ObjectBidirectionalIterator<T> invert(ObjectBidirectionalIterator<T> it)
```
    Inverter function for Bidirectional Iterators
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectListIterator<T> invert(ObjectListIterator<T> it)
```
    Inverter function for List Iterators
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterator<T> unmodifiable(ObjectIterator<T> iterator)
```
    Returns a Immutable Iterator instance based on the instance given.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectBidirectionalIterator<T> unmodifiable(ObjectBidirectionalIterator<T> iterator)
```
    Returns a Immutable Iterator instance based on the instance given.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectListIterator<T> unmodifiable(ObjectListIterator<T> iterator)
```
    Returns a Immutable ListIterator instance based on the instance given.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E> ObjectIterator<E> map(java.util.Iterator<? extends T> iterator,
                                          Object2ObjectFunction<T,E> mapper)
```
    A Helper function that maps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E> ObjectIterator<E> map(ObjectIterator<T> iterator,
                                          Object2ObjectFunction<T,E> mapper)
```
    A Helper function that maps a Iterator into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E,V extends java.lang.Iterable<E>> ObjectIterator<E> flatMap(java.util.Iterator<? extends T> iterator,
                                                                              Object2ObjectFunction<T,V> mapper)
```
    A Helper function that flatMaps a Java-Iterator 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:
    
    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 <T,E,V extends java.lang.Iterable<E>> ObjectIterator<E> flatMap(ObjectIterator<T> iterator,
                                                                              Object2ObjectFunction<T,V> mapper)
```
    A Helper function that flatMaps a Iterator 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:
    
    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 <T,E> ObjectIterator<E> arrayFlatMap(java.util.Iterator<? extends T> iterator,
                                                   Object2ObjectFunction<T,E[]> mapper)
```
    A Helper function that flatMaps a Java-Iterator into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T,E> ObjectIterator<E> arrayFlatMap(ObjectIterator<T> iterator,
                                                   Object2ObjectFunction<T,E[]> mapper)
```
    A Helper function that flatMaps a Iterator into a new Type.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterator<T> filter(java.util.Iterator<? extends T> iterator,
                                           Object2BooleanFunction<T> filter)
```
    A Helper function that filters out all desired elements from a Java-Iterator
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterator
  - filter
```
public static <T> ObjectIterator<T> filter(ObjectIterator<T> iterator,
                                           Object2BooleanFunction<T> filter)
```
    A Helper function that filters out all desired elements
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be filtered.
    
    filter - the filter that decides that should be let through
    
    Returns:
    
    a filtered iterator
  - distinct
```
public static <T> ObjectIterator<T> distinct(ObjectIterator<T> iterator)
```
    A Helper function that filters out all duplicated elements.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be distinct
    
    Returns:
    
    a distinct iterator
  - distinct
```
public static <T> ObjectIterator<T> distinct(java.util.Iterator<? extends T> iterator)
```
    A Helper function that filters out all duplicated elements from a Java Iterator.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be distinct
    
    Returns:
    
    a distinct iterator
  - limit
```
public static <T> ObjectIterator<T> limit(ObjectIterator<T> iterator,
                                          long limit)
```
    A Helper function that hard limits the Iterator to a specific size
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterator
  - limit
```
public static <T> ObjectIterator<T> limit(java.util.Iterator<? extends T> iterator,
                                          long limit)
```
    A Helper function that hard limits the Iterator to a specific size from a Java Iterator
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be limited
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a limited iterator
  - sorted
```
public static <T> ObjectIterator<T> sorted(ObjectIterator<T> iterator,
                                           java.util.Comparator<T> 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.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be sorted.
    
    sorter - the sorter of the iterator. Can be null.
    
    Returns:
    
    a new sorted iterator
  - sorted
```
public static <T> ObjectIterator<T> sorted(java.util.Iterator<? extends T> iterator,
                                           java.util.Comparator<T> 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.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    iterator - that should be sorted.
    
    sorter - the sorter of the iterator. Can be null.
    
    Returns:
    
    a new sorted iterator
  - peek
```
public static <T> ObjectIterator<T> peek(ObjectIterator<T> iterator,
                                         java.util.function.Consumer<T> action)
```
    A Helper function that allows to preview the result of a Iterator.
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterator<T> peek(java.util.Iterator<? extends T> iterator,
                                         java.util.function.Consumer<T> action)
```
    A Helper function that allows to preview the result of a Iterator from a Java Iterator
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectIterator<T> wrap(java.util.Iterator<? extends T> iterator)
```
    Helper function to convert a Object Iterator into a Primitive Iterator
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    Parameters:
    
    iterator - that should be converted to a unboxing iterator
    
    Returns:
    
    a primitive iterator
  - wrap
```
public static <T> speiger.src.collections.objects.utils.ObjectIterators.ArrayIterator<T> wrap(T... a)
```
    Returns a Array Wrapping iterator
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    Parameters:
    
    a - the array that should be wrapped
    
    Returns:
    
    a Iterator that is wrapping a array.
  - wrap
```
public static <T> speiger.src.collections.objects.utils.ObjectIterators.ArrayIterator<T> wrap(T[] a,
                                                                                              int start,
                                                                                              int end)
```
    Returns a Array Wrapping iterator
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int unwrap(T[] a,
                             java.util.Iterator<? extends T> i)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int unwrap(T[] a,
                             java.util.Iterator<? extends T> i,
                             int offset)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int unwrap(T[] a,
                             java.util.Iterator<? extends T> i,
                             int offset,
                             int max)
```
    Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int unwrap(T[] a,
                             ObjectIterator<T> i)
```
    A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int unwrap(T[] a,
                             ObjectIterator<T> i,
                             int offset)
```
    A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int unwrap(T[] a,
                             ObjectIterator<T> i,
                             int offset,
                             int max)
```
    A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> ObjectList<T> pour(ObjectIterator<T> iter)
```
    A Helper function to pours all elements of a Iterator into a List
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    Parameters:
    
    iter - the elements that should be poured into list.
    
    Returns:
    
    A list of all elements of the Iterator
  - pour
```
public static <T> ObjectList<T> pour(ObjectIterator<T> iter,
                                     int max)
```
    A Helper function to pours all elements of a Iterator into a List
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int pour(ObjectIterator<T> iter,
                           ObjectCollection<T> c)
```
    A Helper function to pours all elements of a Iterator into a Collection
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> int pour(ObjectIterator<T> iter,
                           ObjectCollection<T> c,
                           int max)
```
    A Helper function to pours all elements of a Iterator into a Collection
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 <T> ObjectIterator<T> concat(ObjectIterator<T>... array)
```
    Helper Iterator that concats other iterators together
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    Parameters:
    
    array - the Iterators that should be concatenated
    
    Returns:
    
    iterator of the inputted iterators
  - concat
```
public static <T> ObjectIterator<T> concat(ObjectIterator<T>[] array,
                                           int offset,
                                           int length)
```
    Helper Iterator that concats other iterators together
    
    Type Parameters:
    
    T - the type of array that the operation should be applied
    
    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 ObjectIterators

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectIterators

Method Detail

empty

invert

invert

unmodifiable

unmodifiable

unmodifiable

map

map

flatMap

flatMap

arrayFlatMap

arrayFlatMap

filter

filter

distinct

distinct

limit

limit

sorted

sorted

peek

peek

wrap

wrap

wrap

unwrap

unwrap

unwrap

unwrap

unwrap

unwrap

pour

pour

pour

pour

concat

concat