enumj

Class ChoiceEnumerator<E>

java.lang.Object

enumj.AbstractEnumerator<E>

enumj.ChoiceEnumerator<E>

Type Parameters:

E - Type of enumerated elements.

All Implemented Interfaces:

Enumerator<E>, Iterator<E>

final class ChoiceEnumerator<E>
extends AbstractEnumerator<E>

Enumerator implementation that enumerates by choosing among the elements of given source Iterator instances.

Constructor Summary

Constructors

Constructor and Description
ChoiceEnumerator(IntSupplier indexSupplier, IntUnaryOperator nextIndexSupplier, Iterator<E> first, Iterator<E> second, List<Iterator<E>> rest) Constructs a ChoiceEnumerator 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.

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

ChoiceEnumerator

public ChoiceEnumerator(IntSupplier indexSupplier,
                        IntUnaryOperator nextIndexSupplier,
                        Iterator<E> first,
                        Iterator<E> second,
                        List<Iterator<E>> rest)

Constructs a ChoiceEnumerator instance.

Parameters:

indexSupplier - IntSupplier instance that yields the index of the source Iterator instance to get the next element from.

nextIndexSupplier - IntSupplier instance that yields the subsequent indexes of the source Iterator instance to get the next element from, if the source indicated by indexSupplier runs out of elements.

first - first Iterator source to choose elements from.

second - second Iterator source to choose elements from.

rest - rest of Iterator sources to choose elements from.

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()