enumj

Class IteratorEnumerator<E>

java.lang.Object

enumj.AbstractEnumerator<E>

enumj.IteratorEnumerator<E>

Type Parameters:

E - type of enumerated elements.

All Implemented Interfaces:

Enumerator<E>, Iterator<E>

Direct Known Subclasses:

PipeSource

class IteratorEnumerator<E>
extends AbstractEnumerator<E>

Enumerator encapsulating an Iterator.

Important: this class may not be final because PipeSource extends it.

See Also:

Enumerator, AbstractEnumerator, Iterator, PipeSource

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IteratorEnumerator(Iterator<E> source) Creates an IteratorEnumerator instance.

Method Summary

Modifier and Type	Method and Description
protected void	cleanup() Cleans up the internals of the current enumerator when enumeration ends.
protected boolean	internalHasNext() Returns whether the enumerator has more elements.
protected E	internalNext() Returns the next enumerated element.
(package private) static <T> Enumerator<T>	of(Iterator<T> source) Constructs an Enumerator from an Iterator.

Methods inherited from class enumj.AbstractEnumerator

enumerating, hasNext, next

Methods inherited from class java.lang.Object

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

Methods inherited from interface enumj.Enumerator

allMatch, anyMatch, append, as, asEnumerable, asEnumeration, asFiltered, asOptional, asShareable, asSpliterator, asStream, asSupplier, asTolerant, asTolerant, choiceOf, choiceOf, collect, concat, concat, concat, concat, concat, concat, concatOn, contains, count, distinct, elementAt, elementsEqual, empty, filter, first, flatMap, forEach, iterate, last, limit, limitWhile, map, map, max, min, noneMatch, of, of, of, of, of, of, of, ofLateBinding, ofLazyEnumeration, ofLazyIterable, ofLazyIterator, ofLazySpliterator, ofLazyStream, on, peek, prepend, prepend, prepend, prepend, prepend, prepend, prependOn, range, rangeClosed, rangeInt, rangeIntClosed, rangeLong, rangeLongClosed, reduce, reduce, repeat, repeatAll, repeatAll, repeatEach, reverse, single, skip, skipWhile, sorted, sorted, take, takeWhile, toArray, toList, toMap, toSet, union, union, union, union, union, union, unionOn, zipAll, zipAny, zipBoth, zipLeft, zipRight

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

IteratorEnumerator

protected IteratorEnumerator(Iterator<E> source)

Creates an IteratorEnumerator instance.

The new IteratorEnumerator stores its source internally.

Parameters:

source - Iterator to encapsulate.

Method Detail

internalHasNext

protected boolean internalHasNext()

Description copied from class: AbstractEnumerator

Returns whether the enumerator has more elements.

This method is the internal counterpart of AbstractEnumerator.hasNext().

Specified by:

internalHasNext in class AbstractEnumerator<E>

Returns:

true if the enumerator has more elements, false otherwise.

See Also:

AbstractEnumerator.next()

internalNext

protected E internalNext()

Description copied from class: AbstractEnumerator

Returns the next enumerated element.

This method is the internal counterpart of AbstractEnumerator.hasNext()

Specified by:

internalNext in class AbstractEnumerator<E>

Returns:

next enumerated element.

cleanup

protected void cleanup()

Description copied from class: AbstractEnumerator

Cleans up the internals of the current enumerator when enumeration ends.

By default this method does nothing.

Overrides:

cleanup in class AbstractEnumerator<E>

See Also:

AbstractEnumerator.hasNext(), AbstractEnumerator.next(), AbstractEnumerator.internalHasNext(), AbstractEnumerator.internalNext()

of

static <T> Enumerator<T> of(Iterator<T> source)

Constructs an Enumerator from an Iterator. If the iterator is already an enumerator, it returns is unchanged, otherwise it returns an IteratorEnumerator encapsulating it.

Type Parameters:

T - type of enumerated elements.

Parameters:

source - Iterator to get elements from.

Returns:

Enumerator instance.