enumj

Class ChoiceEnumerable<E>

java.lang.Object

enumj.AbstractEnumerable<E>

enumj.ChoiceEnumerable<E>

Type Parameters:

E - Type of enumerated elements.

All Implemented Interfaces:

Enumerable<E>, Iterable<E>

final class ChoiceEnumerable<E>
extends AbstractEnumerable<E>

Enumerable that chooses among the elements of the given Iterator instances.

Constructor Summary

Constructors

Constructor and Description
ChoiceEnumerable(Supplier<IntSupplier> indexSupplier, Supplier<IntUnaryOperator> nextIndexSupplier, Iterable<E> first, Iterable<? extends E> second, List<Iterable<E>> rest) Constructs a ChoiceEnumerable instance.

Method Summary

Modifier and Type	Method and Description
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

ChoiceEnumerable

public ChoiceEnumerable(Supplier<IntSupplier> indexSupplier,
                        Supplier<IntUnaryOperator> nextIndexSupplier,
                        Iterable<E> first,
                        Iterable<? extends E> second,
                        List<Iterable<E>> rest)

Constructs a ChoiceEnumerable instance.

Parameters:

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

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

first - first Iterable source to choose elements from.

second - second Iterable source to choose elements from.

rest - rest of Iterable sources to choose elements from.

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