enumj

Class AbstractEnumerable<E>

java.lang.Object

enumj.AbstractEnumerable<E>

Type Parameters:

E - Type of elements being enumerated.

All Implemented Interfaces:

Enumerable<E>, Iterable<E>

Direct Known Subclasses:

CachedEnumerable, ChoiceEnumerable, EnumeratorEnumerable, IterableEnumerable, LateBindingEnumerable, LazyEnumerable, PipeEnumerable, SuppliedEnumerable

abstract class AbstractEnumerable<E>
extends Object
implements Enumerable<E>

Abstract implementation of the Enumerable interface.

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

See Also:

AbstractEnumerator, Enumerable, Enumerator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	enumerating() Returns whether enumerator() has been called at least once.
Enumerator<E>	enumerator() Returns a new Enumerator instance that enumerates over the current Enumerable.
protected abstract Enumerator<E>	internalEnumerator() Yields a new Enumerator for the current Enumerable.
protected abstract boolean	internalOnceOnly() Gets whether the current instance may yield a Enumerator only once.
boolean	onceOnly() Returns whether the enumerable may generate only one iterator or not.

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

AbstractEnumerable

protected AbstractEnumerable()

Constructs a new AbstractEnumerable instance.

The new AbstractEnumerable instance gets initialised as non-enumerating.

See Also:

enumerating

Method Detail

enumerating

public final boolean enumerating()

Description copied from interface: Enumerable

Returns whether enumerator() has been called at least once.

Most non-static methods of Enumerable require that this method returns false.

Specified by:

enumerating in interface Enumerable<E>

Returns:

true if Enumerable.enumerating() has been called, false otherwise.

onceOnly

public final boolean onceOnly()

Description copied from interface: Enumerable

Returns whether the enumerable may generate only one iterator or not.

Specified by:

onceOnly in interface Enumerable<E>

Returns:

true if the enumerable may generate only one iterator, false otherwise.

enumerator

public final Enumerator<E> enumerator()

Description copied from interface: Enumerable

Returns a new Enumerator instance that enumerates over the current Enumerable.

The default implementation of Enumerable.iterator() calls this method.

Specified by:

enumerator in interface Enumerable<E>

Returns:

Enumerator instance enumerating over the current Enumerable instance.

See Also:

Enumerable.iterator()

internalOnceOnly

protected abstract boolean internalOnceOnly()

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

This method is the internal counterpart of onceOnly().

Returns:

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

internalEnumerator

protected abstract Enumerator<E> internalEnumerator()

Yields a new Enumerator for the current Enumerable.

This method is the internal counterpart of enumerator().

Returns:

Enumerator instance.

See Also:

Enumerable