net.emaze.dysfunctional.consumers

Class FirstElement<E>

java.lang.Object

net.emaze.dysfunctional.consumers.FirstElement<E>

Type Parameters:

E - the iterator element type

All Implemented Interfaces:

Function<Iterator<E>,E>

public class FirstElement<E>
extends Object
implements Function<Iterator<E>,E>

A unary function consuming the first element from an iterator.

Author:

rferranti

Constructor Summary

Constructors

Constructor and Description
FirstElement()

Method Summary

Modifier and Type	Method and Description
E	apply(Iterator<E> consumable) Consumes the first element from the passed iterator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

FirstElement

public FirstElement()

Method Detail

apply

public E apply(Iterator<E> consumable)

Consumes the first element from the passed iterator.

Specified by:

apply in interface Function<Iterator<E>,E>

Parameters:

consumable - the iterator to be consumed

Returns:

the consumed value

Throws:

IllegalArgumentException - if the passed iterator is empty