Consumers (emaze-dysfunctional 5.1 API)

java.lang.Object
- net.emaze.dysfunctional.Consumers

```
public abstract class Consumers
extends Object
```
all, maybeFirst, first, maybeOne, one, maybeLast, last, nth, maybeNth, at, maybeAt, pipe.

Author:

rferranti

Constructor Summary

Constructors
Constructor and Description

Consumers()

Constructors
Constructor and Description
`Consumers()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <E> List<E>`	`all(E[] array)` Yields all element of the array in a list.
`static <R extends Collection<E>,E> R`	`all(E[] array, Provider<R> provider)` Yields all elements of the iterator (in a collection created by the provider).
`static <R extends Collection<E>,E> R`	`all(E[] array, R collection)` Yields all elements of the array (in the provided collection).
`static <E> List<E>`	`all(Iterable<E> iterable)` Yields all elements of the iterable's iterator (in a list).
`static <E,R extends Collection<E>> R`	`all(Iterable<E> iterable, Provider<R> provider)` Yields all elements of the iterator (in a collection created by the provider).
`static <R extends Collection<E>,E> R`	`all(Iterable<E> iterable, R collection)` Yields all elements of the iterator (in the provided collection).
`static <E> List<E>`	`all(Iterator<E> iterator)` yields all elements of the iterator (in a list).
`static <E,R extends Collection<E>> R`	`all(Iterator<E> iterator, Provider<R> provider)` Yields all elements of the iterator (in a collection created by the provider).
`static <R extends Collection<E>,E> R`	`all(Iterator<E> iterator, R collection)` Yields all elements of the iterator (in the provided collection).
`static <E> E`	`at(long index, E[] array)` Yields element at (0-based) position of the array.
`static <E> E`	`at(long index, Iterable<E> iterable)` Yields element at (0-based) position of the iterable.
`static <E> E`	`at(long index, Iterator<E> iterator)` Yields element at (0-based) position of the iterator.
`static <K,V> Map<K,V>`	`dict(Iterable<Pair<K,V>> iterable)` Yields all elements of the iterable's iterator (in a map).
`static <M extends Map<K,V>,K,V> M`	`dict(Iterable<Pair<K,V>> iterable, M map)` Yields all elements of the iterator (in the provided map).
`static <M extends Map<K,V>,K,V> M`	`dict(Iterable<Pair<K,V>> iterable, Provider<M> provider)` Yields all elements of the iterator (in a map created by the provider).
`static <K,V> Map<K,V>`	`dict(Iterator<Pair<K,V>> iterator)` Yields all elements of the iterator (in a map).
`static <M extends Map<K,V>,K,V> M`	`dict(Iterator<Pair<K,V>> iterator, M map)` Yields all elements of the iterator (in the provided map).
`static <M extends Map<K,V>,K,V> M`	`dict(Iterator<Pair<K,V>> iterator, Provider<M> provider)` Yields all elements of the iterator (in a map created by the provider).
`static <M extends Map<K,V>,K,V> M`	`dict(M map, Pair<K,V>... array)` Yields all elements of the array (in the provided map).
`static <K,V> Map<K,V>`	`dict(Pair<K,V>... array)` Yields all element of the array in a map.
`static <M extends Map<K,V>,K,V> M`	`dict(Provider<M> provider, Pair<K,V>... array)` Yields all elements of the iterator (in a map created by the provider).
`static <E> E`	`first(E[] array)` Yields the first element of the array.
`static <E> E`	`first(Iterable<E> iterable)` Yields the first element of the iterable.
`static <E> E`	`first(Iterator<E> iterator)` Yields the first element of the iterator.
`static <E> E`	`last(E[] array)` Yields the last element.
`static <E> E`	`last(Iterable<E> iterable)` Yields the last element.
`static <E> E`	`last(Iterator<E> iterator)` Yields the last element.
`static <E> Maybe<E>`	`maybeAt(long index, E[] array)` Yields element at (0-based) position of the array if found or nothing.
`static <E> Maybe<E>`	`maybeAt(long index, Iterable<E> iterable)` Yields element at (0-based) position of the iterable if found or nothing.
`static <E> Maybe<E>`	`maybeAt(long index, Iterator<E> iterator)` Yields element at (0-based) position of the iterator if found or nothing.
`static <E> Maybe<E>`	`maybeFirst(E[] array)` Yields the first element if present, nothing otherwise.
`static <E> Maybe<E>`	`maybeFirst(Iterable<E> iterable)` Yields the first element if present, nothing otherwise.
`static <E> Maybe<E>`	`maybeFirst(Iterator<E> iterator)` Yields the first element if present, nothing otherwise.
`static <E> Maybe<E>`	`maybeLast(E[] array)` Yields the last element if present, nothing otherwise.
`static <E> Maybe<E>`	`maybeLast(Iterable<E> iterable)` Yields the last element if present, nothing otherwise.
`static <E> Maybe<E>`	`maybeLast(Iterator<E> iterator)` Yields the last element if present, nothing otherwise.
`static <E> Maybe<E>`	`maybeNth(long count, E[] array)` Yields nth (1-based) element of the array if found or nothing.
`static <E> Maybe<E>`	`maybeNth(long count, Iterable<E> iterable)` Yields nth (1-based) element of the iterable if found or nothing.
`static <E> Maybe<E>`	`maybeNth(long count, Iterator<E> iterator)` Yields nth (1-based) element of the iterator if found or nothing.
`static <E> Maybe<E>`	`maybeOne(E[] array)` Yields the only element if found, nothing otherwise.
`static <E> Maybe<E>`	`maybeOne(Iterable<E> iterable)` Yields the only element if found, nothing otherwise.
`static <E> Maybe<E>`	`maybeOne(Iterator<E> iterator)` Yields the only element if found, nothing otherwise.
`static <E> E`	`nth(long count, E[] array)` Yields nth (1-based) element of the array.
`static <E> E`	`nth(long count, Iterable<E> iterable)` Yields nth (1-based) element of the iterable.
`static <E> E`	`nth(long count, Iterator<E> iterator)` Yields nth (1-based) element of the iterator.
`static <E> E`	`one(E[] array)` Yields the only element.
`static <E> E`	`one(Iterable<E> iterable)` Yields the only element.
`static <E> E`	`one(Iterator<E> iterator)` Yields the only element.
`static <E> void`	`pipe(E[] array, OutputIterator<E> outputIterator)` Consumes the array into the output iterator.
`static <E> void`	`pipe(Iterable<E> iterable, OutputIterator<E> outputIterator)` Consumes an iterable into the output iterator.
`static <E> void`	`pipe(Iterator<E> iterator, OutputIterator<E> outputIterator)` Consumes the input iterator to the output iterator.

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

- Constructor Detail
  - Consumers
```
public Consumers()
```
- Method Detail
  - all
```
public static <R extends Collection<E>,E> R all(Iterator<E> iterator,
                                R collection)
```
    Yields all elements of the iterator (in the provided collection).
    
    Type Parameters:
    R - the returned collection type
    E - the collection element type
    Parameters:
    iterator - the iterator that will be consumed
    collection - the collection where the iterator is consumed
    
    Returns:
    the collection filled with iterator values
  - all
```
public static <R extends Collection<E>,E> R all(Iterable<E> iterable,
                                R collection)
```
    Yields all elements of the iterator (in the provided collection).
    
    Type Parameters:
    R - the returned collection type
    E - the collection element type
    Parameters:
    iterable - the iterable that will be consumed
    collection - the collection where the iterator is consumed
    
    Returns:
    the collection filled with iterator values
  - all
```
public static <R extends Collection<E>,E> R all(E[] array,
                                R collection)
```
    Yields all elements of the array (in the provided collection).
    
    Type Parameters:
    R - the returned collection type
    E - the collection element type
    Parameters:
    array - the array that will be consumed
    collection - the collection where the iterator is consumed
    
    Returns:
    the collection filled with iterator values
  - all
```
public static <E,R extends Collection<E>> R all(Iterator<E> iterator,
                                Provider<R> provider)
```
    Yields all elements of the iterator (in a collection created by the provider).
    
    Type Parameters:
    R - the returned collection type
    E - the collection element type
    Parameters:
    iterator - the iterator that will be consumed
    provider - the factory used to provide the returned collection
    
    Returns:
    a collection filled with iterator values
  - all
```
public static <E,R extends Collection<E>> R all(Iterable<E> iterable,
                                Provider<R> provider)
```
    Yields all elements of the iterator (in a collection created by the provider).
    
    Type Parameters:
    R - the returned collection type
    E - the collection element type
    Parameters:
    iterable - the iterable that will be consumed
    provider - the factory used to provide the returned collection
    
    Returns:
    a collection filled with iterator values
  - all
```
public static <R extends Collection<E>,E> R all(E[] array,
                                Provider<R> provider)
```
    Yields all elements of the iterator (in a collection created by the provider).
    
    Type Parameters:
    R - the returned collection type
    E - the collection element type
    Parameters:
    array - the array that will be consumed
    provider - the factory used to provide the returned collection
    
    Returns:
    a collection filled with iterator values
  - all
```
public static <E> List<E> all(Iterator<E> iterator)
```
    yields all elements of the iterator (in a list).
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterator - the iterator that will be consumed
    
    Returns:
    a list filled with iterator values
  - all
```
public static <E> List<E> all(Iterable<E> iterable)
```
    Yields all elements of the iterable's iterator (in a list).
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    iterable - the iterable that will be consumed
    
    Returns:
    a list filled with iterable values
  - all
```
public static <E> List<E> all(E[] array)
```
    Yields all element of the array in a list.
    
    Type Parameters:
    E - the array element type
    Parameters:
    array - the array that will be consumed
    
    Returns:
    a list filled with array values
  - dict
```
public static <M extends Map<K,V>,K,V> M dict(Iterator<Pair<K,V>> iterator,
                              M map)
```
    Yields all elements of the iterator (in the provided map).
    
    Type Parameters:
    M - the returned map type
    K - the map key type
    V - the map value type
    Parameters:
    iterator - the iterator that will be consumed
    map - the map where the iterator is consumed
    
    Returns:
    the map filled with iterator values
  - dict
```
public static <M extends Map<K,V>,K,V> M dict(Iterable<Pair<K,V>> iterable,
                              M map)
```
    Yields all elements of the iterator (in the provided map).
    
    Type Parameters:
    M - the returned map type
    K - the map key type
    V - the map value type
    Parameters:
    iterable - the iterable that will be consumed
    map - the map where the iterator is consumed
    
    Returns:
    the map filled with iterator values
  - dict
```
public static <M extends Map<K,V>,K,V> M dict(M map,
                              Pair<K,V>... array)
```
    Yields all elements of the array (in the provided map).
    
    Type Parameters:
    M - the returned map type
    K - the map key type
    V - the map value type
    Parameters:
    map - the map where the iterator is consumed
    array - the array that will be consumed
    
    Returns:
    the map filled with iterator values
  - dict
```
public static <M extends Map<K,V>,K,V> M dict(Iterator<Pair<K,V>> iterator,
                              Provider<M> provider)
```
    Yields all elements of the iterator (in a map created by the provider).
    
    Type Parameters:
    M - the returned map type
    K - the map key type
    V - the map value type
    Parameters:
    iterator - the iterator that will be consumed
    provider - the factory used to provide the returned map
    
    Returns:
    a map filled with iterator values
  - dict
```
public static <M extends Map<K,V>,K,V> M dict(Iterable<Pair<K,V>> iterable,
                              Provider<M> provider)
```
    Yields all elements of the iterator (in a map created by the provider).
    
    Type Parameters:
    M - the returned map type
    K - the map key type
    V - the map value type
    Parameters:
    iterable - the iterable that will be consumed
    provider - the factory used to provide the returned map
    
    Returns:
    a map filled with iterator values
  - dict
```
public static <M extends Map<K,V>,K,V> M dict(Provider<M> provider,
                              Pair<K,V>... array)
```
    Yields all elements of the iterator (in a map created by the provider).
    
    Type Parameters:
    M - the returned map type
    K - the map key type
    V - the map value type
    Parameters:
    provider - the factory used to provide the returned map
    array - the array that will be consumed
    
    Returns:
    a map filled with iterator values
  - dict
```
public static <K,V> Map<K,V> dict(Iterator<Pair<K,V>> iterator)
```
    Yields all elements of the iterator (in a map).
    
    Type Parameters:
    K - the map key type
    V - the map value type
    Parameters:
    iterator - the iterator that will be consumed
    
    Returns:
    a list filled with iterator values
  - dict
```
public static <K,V> Map<K,V> dict(Iterable<Pair<K,V>> iterable)
```
    Yields all elements of the iterable's iterator (in a map).
    
    Type Parameters:
    K - the map key type
    V - the map value type
    Parameters:
    iterable - the iterable that will be consumed
    
    Returns:
    a list filled with iterable values
  - dict
```
public static <K,V> Map<K,V> dict(Pair<K,V>... array)
```
    Yields all element of the array in a map.
    
    Type Parameters:
    K - the map key type
    V - the map value type
    Parameters:
    array - the array that will be consumed
    
    Returns:
    a map filled with array values
  - pipe
```
public static <E> void pipe(Iterator<E> iterator,
            OutputIterator<E> outputIterator)
```
    Consumes the input iterator to the output iterator.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterator - the iterator that will be consumed
    outputIterator - the iterator that will be filled
  - pipe
```
public static <E> void pipe(Iterable<E> iterable,
            OutputIterator<E> outputIterator)
```
    Consumes an iterable into the output iterator.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterable - the iterable that will be consumed
    outputIterator - the iterator that will be filled
  - pipe
```
public static <E> void pipe(E[] array,
            OutputIterator<E> outputIterator)
```
    Consumes the array into the output iterator.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    array - the array that will be consumed
    outputIterator - the iterator that will be filled
  - maybeFirst
```
public static <E> Maybe<E> maybeFirst(Iterable<E> iterable)
```
    Yields the first element if present, nothing otherwise.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    iterable - the iterable that will be consumed
    
    Returns:
    just the first element or nothing
  - maybeFirst
```
public static <E> Maybe<E> maybeFirst(Iterator<E> iterator)
```
    Yields the first element if present, nothing otherwise.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterator - the iterator that will be consumed
    
    Returns:
    just the first element or nothing
  - maybeFirst
```
public static <E> Maybe<E> maybeFirst(E[] array)
```
    Yields the first element if present, nothing otherwise.
    
    Type Parameters:
    E - the array element type
    Parameters:
    array - the array that will be consumed
    
    Returns:
    just the first element or nothing
  - first
```
public static <E> E first(Iterator<E> iterator)
```
    Yields the first element of the iterator.
    
    Type Parameters:
    E - the element type parameter
    Parameters:
    iterator - the iterator to be searched
    
    Returns:
    the found element
    
    Throws:
    
    IllegalArgumentException - if no element is present
  - first
```
public static <E> E first(Iterable<E> iterable)
```
    Yields the first element of the iterable.
    
    Type Parameters:
    E - the element type parameter
    Parameters:
    iterable - the iterable to be searched
    
    Returns:
    the found element
    
    Throws:
    
    IllegalArgumentException - if no element is present
  - first
```
public static <E> E first(E[] array)
```
    Yields the first element of the array.
    
    Type Parameters:
    E - the element type parameter
    Parameters:
    array - the array to be searched
    
    Returns:
    the found element
    
    Throws:
    
    IllegalArgumentException - if no element matches
  - maybeOne
```
public static <E> Maybe<E> maybeOne(Iterator<E> iterator)
```
    Yields the only element if found, nothing otherwise.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterator - the iterator that will be consumed
    
    Returns:
    just the element or nothing
    
    Throws:
    
    IllegalStateException - if the iterator contains more than one element
  - maybeOne
```
public static <E> Maybe<E> maybeOne(Iterable<E> iterable)
```
    Yields the only element if found, nothing otherwise.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    iterable - the iterable that will be consumed
    
    Returns:
    just the element or nothing
    
    Throws:
    
    IllegalStateException - if the iterator contains more than one element
  - maybeOne
```
public static <E> Maybe<E> maybeOne(E[] array)
```
    Yields the only element if found, nothing otherwise.
    
    Type Parameters:
    E - the array element type
    Parameters:
    array - the array that will be consumed
    
    Returns:
    just the element or nothing
    
    Throws:
    
    IllegalStateException - if the iterator contains more than one element
  - one
```
public static <E> E one(Iterator<E> iterator)
```
    Yields the only element.
    
    Type Parameters:
    E - the element type parameter
    Parameters:
    iterator - the iterator to be searched
    
    Returns:
    the found element
    
    Throws:
    
    IllegalStateException - if more than one element is found
    
    IllegalArgumentException - if no element matches
  - one
```
public static <E> E one(Iterable<E> iterable)
```
    Yields the only element.
    
    Type Parameters:
    E - the element type parameter
    Parameters:
    iterable - the iterable to be searched
    
    Returns:
    the found element
    
    Throws:
    
    IllegalStateException - if more than one element is found
    
    IllegalArgumentException - if no element matches
  - one
```
public static <E> E one(E[] array)
```
    Yields the only element.
    
    Type Parameters:
    E - the element type parameter
    Parameters:
    array - the array to be searched
    
    Returns:
    the found element
    
    Throws:
    
    IllegalStateException - if more than one element is found
    
    IllegalArgumentException - if no element matches
  - maybeLast
```
public static <E> Maybe<E> maybeLast(Iterator<E> iterator)
```
    Yields the last element if present, nothing otherwise.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterator - the iterator that will be consumed
    
    Returns:
    the last element or nothing
  - maybeLast
```
public static <E> Maybe<E> maybeLast(Iterable<E> iterable)
```
    Yields the last element if present, nothing otherwise.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    iterable - the iterable that will be consumed
    
    Returns:
    the last element or nothing
  - maybeLast
```
public static <E> Maybe<E> maybeLast(E[] array)
```
    Yields the last element if present, nothing otherwise.
    
    Type Parameters:
    E - the array element type
    Parameters:
    array - the array that will be consumed
    
    Returns:
    the last element or nothing
  - last
```
public static <E> E last(Iterator<E> iterator)
```
    Yields the last element.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    iterator - the iterator that will be consumed @throw IllegalArgumentException if no element is found
    
    Returns:
    the last element
  - last
```
public static <E> E last(Iterable<E> iterable)
```
    Yields the last element.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    iterable - the iterable that will be consumed @throw IllegalArgumentException if no element is found
    
    Returns:
    the last element
  - last
```
public static <E> E last(E[] array)
```
    Yields the last element.
    
    Type Parameters:
    E - the array element type
    Parameters:
    array - the array that will be consumed @throw IllegalArgumentException if no element is found
    
    Returns:
    the last element
  - nth
```
public static <E> E nth(long count,
        Iterator<E> iterator)
```
    Yields nth (1-based) element of the iterator.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    count - the element cardinality
    iterator - the iterator that will be consumed
    
    Returns:
    the nth element
  - nth
```
public static <E> E nth(long count,
        Iterable<E> iterable)
```
    Yields nth (1-based) element of the iterable.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    count - the element cardinality
    iterable - the iterable that will be consumed
    
    Returns:
    the nth element
  - nth
```
public static <E> E nth(long count,
        E[] array)
```
    Yields nth (1-based) element of the array.
    
    Type Parameters:
    E - the array element type
    Parameters:
    count - the element cardinality
    array - the array that will be consumed
    
    Returns:
    the nth element
  - maybeNth
```
public static <E> Maybe<E> maybeNth(long count,
                    Iterator<E> iterator)
```
    Yields nth (1-based) element of the iterator if found or nothing.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    count - the element cardinality
    iterator - the iterator that will be consumed
    
    Returns:
    just the element or nothing
  - maybeNth
```
public static <E> Maybe<E> maybeNth(long count,
                    Iterable<E> iterable)
```
    Yields nth (1-based) element of the iterable if found or nothing.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    count - the element cardinality
    iterable - the iterable that will be consumed
    
    Returns:
    just the element or nothing
  - maybeNth
```
public static <E> Maybe<E> maybeNth(long count,
                    E[] array)
```
    Yields nth (1-based) element of the array if found or nothing.
    
    Type Parameters:
    E - the array element type
    Parameters:
    count - the element cardinality
    array - the array that will be consumed
    
    Returns:
    just the element or nothing
  - at
```
public static <E> E at(long index,
       Iterator<E> iterator)
```
    Yields element at (0-based) position of the iterator.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    index - the element index
    iterator - the iterator that will be consumed
    
    Returns:
    the element
  - at
```
public static <E> E at(long index,
       Iterable<E> iterable)
```
    Yields element at (0-based) position of the iterable.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    index - the element index
    iterable - the iterable that will be consumed
    
    Returns:
    the element
  - at
```
public static <E> E at(long index,
       E[] array)
```
    Yields element at (0-based) position of the array.
    
    Type Parameters:
    E - the array element type
    Parameters:
    index - the element index
    array - the array that will be consumed
    
    Returns:
    just the element or nothing
  - maybeAt
```
public static <E> Maybe<E> maybeAt(long index,
                   Iterator<E> iterator)
```
    Yields element at (0-based) position of the iterator if found or nothing.
    
    Type Parameters:
    E - the iterator element type
    Parameters:
    index - the element index
    iterator - the iterator that will be consumed
    
    Returns:
    just the element or nothing
  - maybeAt
```
public static <E> Maybe<E> maybeAt(long index,
                   Iterable<E> iterable)
```
    Yields element at (0-based) position of the iterable if found or nothing.
    
    Type Parameters:
    E - the iterable element type
    Parameters:
    index - the element index
    iterable - the iterable that will be consumed
    
    Returns:
    just the element or nothing
  - maybeAt
```
public static <E> Maybe<E> maybeAt(long index,
                   E[] array)
```
    Yields element at (0-based) position of the array if found or nothing.
    
    Type Parameters:
    E - the array element type
    Parameters:
    index - the element index
    array - the array that will be consumed
    
    Returns:
    just the element or nothing

Class Consumers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Consumers

Method Detail

all

all

all

all

all

all

all

all

all

dict

dict

dict

dict

dict

dict

dict

dict

dict

pipe

pipe

pipe

maybeFirst

maybeFirst

maybeFirst

first

first

first

maybeOne

maybeOne

maybeOne

one

one

one

maybeLast

maybeLast

maybeLast

last

last

last

nth

nth

nth

maybeNth

maybeNth

maybeNth

at

at

at

maybeAt

maybeAt

maybeAt