enumj

Class AbstractEnumerator<E>

java.lang.Object

enumj.AbstractEnumerator<E>

Type Parameters:

E - Type of elements being enumerated.

All Implemented Interfaces:

Enumerator<E>, Iterator<E>

Direct Known Subclasses:

ArrayEnumerator, CacheEnumerator, ChoiceEnumerator, EnumerationEnumerator, IteratorEnumerator, LateBindingEnumerator, LazyEnumerator, PipeEnumerator, ShareableEnumerator, SharingEnumerator, SuppliedEnumerator, TolerantEnumerator

abstract class AbstractEnumerator<E>
extends Object
implements Enumerator<E>

Abstract implementation of the Enumerator interface.

This class forms the basis for all the concrete implementations of Enumerator within the enumj package.

See Also:

AbstractEnumerable, Enumerable, Enumerator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEnumerator() Constructs a new AbstractEnumerator instance.

Method Summary

Modifier and Type	Method and Description
protected void	cleanup() Cleans up the internals of the current enumerator when enumeration ends.
boolean	enumerating() Returns whether the enumerator has started enumerating.
boolean	hasNext()
protected abstract boolean	internalHasNext() Returns whether the enumerator has more elements.
protected abstract E	internalNext() Returns the next enumerated element.
E	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

AbstractEnumerator

protected AbstractEnumerator()

Constructs a new AbstractEnumerator instance.

The new AbstractEnumerable instance gets initialised as non-enumerating.

See Also:

enumerating()

Method Detail

enumerating

public final boolean enumerating()

Description copied from interface: Enumerator

Returns whether the enumerator has started enumerating.

This method returns false before the first call to hasNext and true afterwards.

Specified by:

enumerating in interface Enumerator<E>

Returns:

true if the enumerator has started enumerating, false otherwise.

See Also:

Iterator.hasNext(), Iterator.next()

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface Iterator<E>

next

public final E next()

Specified by:

next in interface Iterator<E>

internalHasNext

protected abstract boolean internalHasNext()

Returns whether the enumerator has more elements.

This method is the internal counterpart of hasNext().

Returns:

true if the enumerator has more elements, false otherwise.

See Also:

next()

internalNext

protected abstract E internalNext()

Returns the next enumerated element.

This method is the internal counterpart of hasNext()

Returns:

next enumerated element.

cleanup

protected void cleanup()

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

By default this method does nothing.

See Also:

hasNext(), next(), internalHasNext(), internalNext()