enumj

Class EnumeratorEnumerable<E>

java.lang.Object

enumj.AbstractEnumerable<E>

enumj.EnumeratorEnumerable<E>

All Implemented Interfaces:

Enumerable<E>, Iterable<E>

Direct Known Subclasses:

OnceEnumerable

class EnumeratorEnumerable<E>
extends AbstractEnumerable<E>

Enumerable that encapsulates an enumerator.

This Enumerable supports only one enumerator, despite not stating this. It is the responsibility of the user to call its AbstractEnumerable.enumerator() only once.

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

See Also:

OnceEnumerable

Constructor Summary

Constructors

Constructor and Description
EnumeratorEnumerable(Iterator<E> source) Creates a EnumeratorEnumerable instance.

Method Summary

Modifier and Type	Method and Description
protected void	clearSource() Clears the internal source.
protected Enumerator<E>	getSource() Gets the the internal source.
protected Enumerator<E>	internalEnumerator() Yields a new Enumerator for the current Enumerable.
protected boolean	internalOnceOnly() Gets whether the current instance may yield a Enumerator only once.

Methods inherited from class enumj.AbstractEnumerable

enumerating, enumerator, onceOnly

Methods inherited from class java.lang.Object

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

Methods inherited from interface enumj.Enumerable

append, as, asEnumeration, asFiltered, asSpliterator, asStream, asTolerant, asTolerant, cached, cached, choiceOf, choiceOf, concat, concatOn, distinct, elementsEqual, empty, filter, flatMap, iterate, iterator, limit, limitWhile, map, map, of, of, of, of, of, of, ofLateBinding, ofLazyEnumeration, ofLazyIterable, ofLazyIterator, ofLazySpliterator, ofLazyStream, on, onceOnly, peek, prepend, prependOn, range, rangeClosed, rangeInt, rangeIntClosed, rangeLong, rangeLongClosed, repeat, repeatAll, repeatEach, reverse, skip, skipWhile, sorted, sorted, take, takeWhile, union, unionOn, zipAll, zipAny, zipBoth, zipLeft, zipRight

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EnumeratorEnumerable

public EnumeratorEnumerable(Iterator<E> source)

Creates a EnumeratorEnumerable instance.

The new EnumeratorEnumerable stores its source internally.

Parameters:

source - Iterator providing the enumerated elements.

Method Detail

internalOnceOnly

protected boolean internalOnceOnly()

Description copied from class: AbstractEnumerable

Gets whether the current instance may yield a Enumerator only once.

This method is the internal counterpart of AbstractEnumerable.onceOnly().

Specified by:

internalOnceOnly in class AbstractEnumerable<E>

Returns:

true if AbstractEnumerable.enumerator() may be called only once, false otherwise.

internalEnumerator

protected Enumerator<E> internalEnumerator()

Description copied from class: AbstractEnumerable

Yields a new Enumerator for the current Enumerable.

This method is the internal counterpart of AbstractEnumerable.enumerator().

Specified by:

internalEnumerator in class AbstractEnumerable<E>

Returns:

Enumerator instance.

See Also:

Enumerable

getSource

protected final Enumerator<E> getSource()

Gets the the internal source.

Returns:

internal Enumerator source;

clearSource

protected final void clearSource()

Clears the internal source.