enumj

Interface Enumerable<E>

Type Parameters:

E - the type of elements returned by this enumerable.

All Superinterfaces:

Iterable<E>

All Known Implementing Classes:

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

public interface Enumerable<E>
extends Iterable<E>

Iterable with high composability that returns an Enumerator instance for its Iterator.

See Also:

Enumerator, Iterable, Iterator

Method Summary

Modifier and Type	Method and Description
default Enumerable<E>	append(E... elements) Appends the given elements to the end of the current Enumerable.
default <T> Enumerable<T>	as(Class<T> clazz) Converts the current enumerable to another type.
default Enumeration<E>	asEnumeration() Returns an Enumeration enumerating the elements of the current Enumerable.
default <T> Enumerable<T>	asFiltered(Class<T> clazz) Converts and filters the current enumerable to another type.
default Spliterator<E>	asSpliterator() Returns a Spliterator iterating the elements of the current Enumerable.
default Stream<E>	asStream() Returns a Stream streaming the elements of the current Enumerable.
default Enumerable<E>	asTolerant(Consumer<? super Exception> handler) Returns a tolerant Enumerable with 0 retries enumerating over the elements of the current Enumerable.
default Enumerable<E>	asTolerant(Consumer<? super Exception> handler, int retries) Returns a tolerant Enumerable enumerating over the elements of the current Enumerable.
default CachedEnumerable<E>	cached() Returns a CachedEnumerable that caches the enumerated elements.
default CachedEnumerable<E>	cached(long limit, Consumer<CachedEnumerable<E>> onLimitCallback) Returns a CachedEnumerable that caches the enumerated elements up to a given limit.
static <E> Enumerable<E>	choiceOf(Supplier<IntSupplier> indexSupplier, Iterable<E> first, Iterable<? extends E> second, Iterable<? extends E>... rest) Returns an Enumerable that chooses its elements from other Iterable instances.
static <E> Enumerable<E>	choiceOf(Supplier<IntSupplier> indexSupplier, Supplier<IntUnaryOperator> altIndexSupplier, Iterable<E> first, Iterable<? extends E> second, Iterable<? extends E>... rest) Returns an Enumerable that chooses its elements from other Iterable instances.
default Enumerable<E>	concat(Iterable<? extends E> elements) Concatenates the given Iterable to the current Enumerable.
default Enumerable<E>	concatOn(E... elements) Concatenates the given elements to the current Enumerable.
default Enumerable<E>	distinct() Returns an Enumerable enumerating over the distinct elements of the current Enumerable.
default <T> boolean	elementsEqual(Iterable<T> elements) Checks whether the current Enumerable matches element-wise the given Iterable.
static <E> Enumerable<E>	empty() Returns an Enumerable with no elements.
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.
default Enumerable<E>	filter(Predicate<? super E> predicate) Returns an Enumerable enumerating over the current elements satisfying the given Predicate.
default <R> Enumerable<R>	flatMap(Function<? super E,? extends Iterable<? extends R>> mapper) Returns an Enumerable enumerating over the iterables produced by applying the given mapper over the elements of the current Enumerable.
static <E> Enumerable<E>	iterate(E seed, UnaryOperator<E> f) Returns an Enumerable enumerating over the elements generated by repeatedly applying the given unary operator on the given seed.
default Iterator<E>	iterator() Returns a new Iterator instance that can traverse the current Enumerable.
default Enumerable<E>	limit(long maxSize) Returns an Enumerable enumerating over the current elements up to the given limit.
default Enumerable<E>	limitWhile(Predicate<? super E> predicate) Returns an Enumerable enumerating over the current elements while the given predicate holds true.
default <R> Enumerable<R>	map(BiFunction<? super E,? super Long,? extends R> mapper) Returns an Enumerable enumerating over the current indexed elements mapped by the given mapper.
default <R> Enumerable<R>	map(Function<? super E,? extends R> mapper) Returns an Enumerable enumerating over the current elements mapped by the given mapper.
static <E> OnceEnumerable<E>	of(Enumeration<E> source) Returns an OnceEnumerable enumerating over the given Enumeration.
static <E> Enumerable<E>	of(Iterable<E> source) Returns an Enumerable enumerating over the given Iterable source.
static <E> OnceEnumerable<E>	of(Iterator<E> source) Returns an OnceEnumerable enumerating over the given Iterator source.
static <E> OnceEnumerable<E>	of(Spliterator<E> source) Returns an OnceEnumerable enumerating over the given Spliterator.
static <E> OnceEnumerable<E>	of(Stream<E> source) Returns an OnceEnumerable enumerating over the given Stream.
static <E> OnceEnumerable<E>	of(Supplier<Optional<E>> source) Returns an OnceEnumerable enumerating over a sequence of elements supplied lazily.
static <E> LateBindingEnumerable<E>	ofLateBinding(Class<E> clazz) Returns a LateBindingEnumerable of elements of the given type.
static <E> OnceEnumerable<E>	ofLazyEnumeration(Supplier<? extends Enumeration<E>> source) Returns an OnceEnumerable enumerating over an Enumeration supplied lazily.
static <E> Enumerable<E>	ofLazyIterable(Supplier<? extends Iterable<E>> source) Returns an Enumerable enumerating over an Iterable supplied lazily.
static <E> OnceEnumerable<E>	ofLazyIterator(Supplier<? extends Iterator<E>> source) Returns an OnceEnumerable enumerating over an Iterator supplied lazily.
static <E> OnceEnumerable<E>	ofLazySpliterator(Supplier<? extends Spliterator<E>> source) Returns an OnceEnumerable enumerating over a Spliterator supplied lazily.
static <E> OnceEnumerable<E>	ofLazyStream(Supplier<? extends Stream<E>> source) Returns an OnceEnumerable enumerating over a Stream supplied lazily.
static <E> Enumerable<E>	on(E... elements) Returns an Enumerable enumerating over the given elements.
boolean	onceOnly() Returns whether the enumerable may generate only one iterator or not.
static boolean	onceOnly(Iterable<?> iterable) Returns whether the given iterable may generated only one iterator or not.
default Enumerable<E>	peek(Consumer<? super E> action) Returns an Enumerable enumerating the current elements while feeding them to the given Consumer.
default Enumerable<E>	prepend(Iterable<? extends E> elements) Prepends the current Enumerable by the given Iterable.
default Enumerable<E>	prependOn(E... elements) Prepends the current Enumerable by the given elements.
static <E> Enumerable<E>	range(E startInclusive, E endExclusive, UnaryOperator<E> succ, Comparator<? super E> cmp) Returns an Enumerable enumerating over a range of elements.
static <E> Enumerable<E>	rangeClosed(E startInclusive, E endInclusive, UnaryOperator<E> succ, Comparator<? super E> cmp) Returns an Enumerable enumerating over a range of elements.
static Enumerable<Integer>	rangeInt(int startInclusive, int endExclusive) Returns an Enumerable enumerating over a range of integers.
static Enumerable<Integer>	rangeIntClosed(int startInclusive, int endInclusive) Returns an Enumerable enumerating over a range of integers.
static Enumerable<Long>	rangeLong(long startInclusive, long endExclusive) Returns an Enumerable enumerating over a range of long integers.
static Enumerable<Long>	rangeLongClosed(long startInclusive, long endInclusive) Returns an Enumerable enumerating over a range of long integers.
static <E> Enumerable<E>	repeat(E element, long count) Returns an Enumerable repeating the given element the given number of time.
default Enumerable<E>	repeatAll(int count) Returns an Enumerable repeating all the current elements the given number of times.
default Enumerable<E>	repeatEach(long count) Returns an Enumerable repeating each current element the given number of times.
default Enumerable<E>	reverse() Returns an Enumerable enumerating over the current elements in reversed order.
default Enumerable<E>	skip(long n) Returns an Enumerable that skips the given number of current elements.
default Enumerable<E>	skipWhile(Predicate<? super E> predicate) Returns an Enumerable that skips while the given condition holds true.
default Enumerable<E>	sorted() Returns an Enumerable enumerating over the current elements in sorted order.
default Enumerable<E>	sorted(Comparator<? super E> comparator) Returns an Enumerable enumerating over the current elements in sorted order according to the given comparator.
default Enumerable<E>	take(long n) Returns an Enumerable enumerating over the current elements up to the given limit.
default Enumerable<E>	takeWhile(Predicate<? super E> predicate) Returns an Enumerable enumerating over the current elements while the given predicate holds true.
default Enumerable<E>	union(Iterable<E> others) Returns an Enumerable enumerating over the current elements and over the given Iterable while avoiding duplicates.
default Enumerable<E>	unionOn(E... others) Returns an Enumerable enumerating over the current elements and over the given elements while avoiding duplicates.
default Enumerable<Optional<E>[]>	zipAll(Iterable<? extends E> first, Iterable<? extends E>... rest) Returns an Enumerable consisting of an array of Optional objects containing elements from the current enumerator and the given Iterable instances, while any has elements.
default <T> Enumerable<Pair<Optional<E>,Optional<T>>>	zipAny(Iterable<T> elements) Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while any of them has elements.
default <T> Enumerable<Pair<E,T>>	zipBoth(Enumerable<T> elements) Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while both have elements.
default <T> Enumerable<Pair<E,Optional<T>>>	zipLeft(Iterable<T> elements) Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while the current enumerator has elements.
default <T> Enumerable<Pair<Optional<E>,T>>	zipRight(Iterable<T> elements) Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while the provided iterator has elements.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

default Iterator<E> iterator()

Returns a new Iterator instance that can traverse the current Enumerable.

The default implementation of this method returns the result of enumerator().

Specified by:

iterator in interface Iterable<E>

Returns:

Iterator instance iterating over the current Enumerable instance.

See Also:

enumerator(), Iterable

enumerator

Enumerator<E> enumerator()

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

The default implementation of iterator() calls this method.

Returns:

Enumerator instance enumerating over the current Enumerable instance.

See Also:

iterator()

enumerating

boolean enumerating()

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

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

Returns:

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

onceOnly

boolean onceOnly()

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

Returns:

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

onceOnly

static boolean onceOnly(Iterable<?> iterable)

Returns whether the given iterable may generated only one iterator or not.

This method assumes that non-Enumerable iterables may return more than one iterator.

Parameters:

iterable - Iterable to check.

Returns:

true if iterable may return only one Iterator, false otherwise.

on

@SafeVarargs
static <E> Enumerable<E> on(E... elements)

Returns an Enumerable enumerating over the given elements.

Type Parameters:

E - type of enumerated elements.

Parameters:

elements - succession of elements to enumerate over.

Returns:

Enumerable instance enumerating over elements.

of

static <E> Enumerable<E> of(Iterable<E> source)

Returns an Enumerable enumerating over the given Iterable source.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Iterable providing the elements to enumerate upon.

Returns:

Enumerable enumerating over source.

of

static <E> OnceEnumerable<E> of(Iterator<E> source)

Returns an OnceEnumerable enumerating over the given Iterator source.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Iterator providing the elements to enumerate upon.

Returns:

OnceEnumerable enumerating over source.

of

static <E> OnceEnumerable<E> of(Enumeration<E> source)

Returns an OnceEnumerable enumerating over the given Enumeration.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Enumeration providing the elements to enumerate upon.

Returns:

OnceEnumerable enumerating over source.

of

static <E> OnceEnumerable<E> of(Stream<E> source)

Returns an OnceEnumerable enumerating over the given Stream.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Stream providing the elements to enumerate upon.

Returns:

OnceEnumerable enumerating over source.

of

static <E> OnceEnumerable<E> of(Spliterator<E> source)

Returns an OnceEnumerable enumerating over the given Spliterator.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Spliterator providing the elements to enumerate upon.

Returns:

OnceEnumerable enumerating over source.

of

static <E> OnceEnumerable<E> of(Supplier<Optional<E>> source)

Returns an OnceEnumerable enumerating over a sequence of elements supplied lazily.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Supplier providing the elements to enumerate. The sequence ends with an empty Optional.

Returns:

OnceEnumerable enumerating over the sequence of elements.

ofLazyIterable

static <E> Enumerable<E> ofLazyIterable(Supplier<? extends Iterable<E>> source)

Returns an Enumerable enumerating over an Iterable supplied lazily.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Supplier of Iterable.

Returns:

Enumerable enumerating over source.

ofLazyIterator

static <E> OnceEnumerable<E> ofLazyIterator(Supplier<? extends Iterator<E>> source)

Returns an OnceEnumerable enumerating over an Iterator supplied lazily.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Supplier of Iterator.

Returns:

OnceEnumerable enumerating over source.

ofLazyEnumeration

static <E> OnceEnumerable<E> ofLazyEnumeration(Supplier<? extends Enumeration<E>> source)

Returns an OnceEnumerable enumerating over an Enumeration supplied lazily.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Supplier of Iterator.

Returns:

OnceEnumerable enumerating over source.

ofLazyStream

static <E> OnceEnumerable<E> ofLazyStream(Supplier<? extends Stream<E>> source)

Returns an OnceEnumerable enumerating over a Stream supplied lazily.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Supplier of Stream.

Returns:

OnceEnumerable enumerating over source.

ofLazySpliterator

static <E> OnceEnumerable<E> ofLazySpliterator(Supplier<? extends Spliterator<E>> source)

Returns an OnceEnumerable enumerating over a Spliterator supplied lazily.

Type Parameters:

E - type of enumerated elements.

Parameters:

source - Supplier of Spliterator.

Returns:

OnceEnumerable enumerating over source.

ofLateBinding

static <E> LateBindingEnumerable<E> ofLateBinding(Class<E> clazz)

Returns a LateBindingEnumerable of elements of the given type.

Type Parameters:

E - type of enumerated elements.

Parameters:

clazz - class of enumerated elements.

Returns:

LateBindingEnumerable that can be bound to elements of type clazz.

as

default <T> Enumerable<T> as(Class<T> clazz)

Converts the current enumerable to another type.

Type Parameters:

T - new type of enumerated elements.

Parameters:

clazz - new class of enumerated elements.

Returns:

Enumerable of another type.

asFiltered

default <T> Enumerable<T> asFiltered(Class<T> clazz)

Converts and filters the current enumerable to another type.

The new enumerable contains only elements of the given type.

Type Parameters:

T - new type of enumerated and filtered elements.

Parameters:

clazz - new class of enumerated and filtered elements.

Returns:

filtered Enumerable of another type.

asEnumeration

default Enumeration<E> asEnumeration()

Returns an Enumeration enumerating the elements of the current Enumerable.

Returns:

Enumeration instance.

asSpliterator

default Spliterator<E> asSpliterator()

Returns a Spliterator iterating the elements of the current Enumerable.

Returns:

Spliterator instance.

asStream

default Stream<E> asStream()

Returns a Stream streaming the elements of the current Enumerable.

Returns:

Stream instance.

asTolerant

default Enumerable<E> asTolerant(Consumer<? super Exception> handler)

Returns a tolerant Enumerable with 0 retries enumerating over the elements of the current Enumerable.

Parameters:

handler - error handler.

Returns:

tolerant Enumerable.

asTolerant

default Enumerable<E> asTolerant(Consumer<? super Exception> handler,
                                 int retries)

Returns a tolerant Enumerable enumerating over the elements of the current Enumerable.

Parameters:

handler - error handler.

retries - positive number of retries on error.

Returns:

tolerant Enumerable.

append

default Enumerable<E> append(E... elements)

Appends the given elements to the end of the current Enumerable.

Parameters:

elements - succession of elements to append.

Returns:

appended Enumerable.

cached

default CachedEnumerable<E> cached()

Returns a CachedEnumerable that caches the enumerated elements.

Returns:

CachedEnumerable instance.

See Also:

cached(long, java.util.function.Consumer)

cached

default CachedEnumerable<E> cached(long limit,
                                   Consumer<CachedEnumerable<E>> onLimitCallback)

Returns a CachedEnumerable that caches the enumerated elements up to a given limit.

Enumeration does not stop at the given limit but the overflow callback may call CachedEnumerable methods to cancel caching on overflowing the limit.

Parameters:

limit - cache limit.

onLimitCallback - handler called on surpassing the limit.

Returns:

CachedEnumerable instance.

See Also:

cached()

choiceOf

static <E> Enumerable<E> choiceOf(Supplier<IntSupplier> indexSupplier,
                                  Iterable<E> first,
                                  Iterable<? extends E> second,
                                  Iterable<? extends E>... rest)

Returns an Enumerable that chooses its elements from other Iterable instances.

Type Parameters:

E - type of enumerated elements.

Parameters:

indexSupplier - Supplier of IntSupplier. The supplied index indicates the source providing the next enumerated element.

first - first Iterable source.

second - second Iterable source.

rest - rest of Iterable sources.

Returns:

Enumerable that chooses its elements from other Iterable instances.

choiceOf

static <E> Enumerable<E> choiceOf(Supplier<IntSupplier> indexSupplier,
                                  Supplier<IntUnaryOperator> altIndexSupplier,
                                  Iterable<E> first,
                                  Iterable<? extends E> second,
                                  Iterable<? extends E>... rest)

Returns an Enumerable that chooses its elements from other Iterable instances.

Type Parameters:

E - Type of enumerated elements.

Parameters:

indexSupplier - Supplier of IntSupplier. The supplied index indicates the source of the next enumerated element.

altIndexSupplier - Supplier of IntSupplier. The supplied index indicates the source of the next enumerated element if the Iterable indicated by indexSupplier runs out of elements.

first - first Iterable source.

second - second Iterable source.

rest - rest of Iterable sources.

Returns:

Enumerable that chooses its elements from other Iterable instances.

concat

default Enumerable<E> concat(Iterable<? extends E> elements)

Concatenates the given Iterable to the current Enumerable.

Parameters:

elements - Iterable to concatenate.

Returns:

concatenated Enumerable.

concatOn

default Enumerable<E> concatOn(E... elements)

Concatenates the given elements to the current Enumerable.

Parameters:

elements - elements to concatenate.

Returns:

concatenated Enumerable.

distinct

default Enumerable<E> distinct()

Returns an Enumerable enumerating over the distinct elements of the current Enumerable.

Returns:

distinct Enumerable.

elementsEqual

default <T> boolean elementsEqual(Iterable<T> elements)

Checks whether the current Enumerable matches element-wise the given Iterable.

Type Parameters:

T - type of elements to match against.

Parameters:

elements - Iterable to match against.

Returns:

true if the elements match, false otherwise.

empty

static <E> Enumerable<E> empty()

Returns an Enumerable with no elements.

Type Parameters:

E - Type of enumerated elements.

Returns:

empty Enumerable.

filter

default Enumerable<E> filter(Predicate<? super E> predicate)

Returns an Enumerable enumerating over the current elements satisfying the given Predicate.

Parameters:

predicate - predicate to filter by.

Returns:

filtered Enumerable.

flatMap

default <R> Enumerable<R> flatMap(Function<? super E,? extends Iterable<? extends R>> mapper)

Returns an Enumerable enumerating over the iterables produced by applying the given mapper over the elements of the current Enumerable.

Type Parameters:

R - type of resulted elements.

Parameters:

mapper - Function instance mapping the current elements to iterables.

Returns:

flat-mapped Enumerable.

iterate

static <E> Enumerable<E> iterate(E seed,
                                 UnaryOperator<E> f)

Returns an Enumerable enumerating over the elements generated by repeatedly applying the given unary operator on the given seed.

Type Parameters:

E - type of enumerated elements.

Parameters:

seed - seed element.

f - unary operator.

Returns:

iterated Enumerable.

limit

default Enumerable<E> limit(long maxSize)

Returns an Enumerable enumerating over the current elements up to the given limit.

Parameters:

maxSize - limit to iterate up to.

Returns:

limited Enumerable.

limitWhile

default Enumerable<E> limitWhile(Predicate<? super E> predicate)

Returns an Enumerable enumerating over the current elements while the given predicate holds true.

Parameters:

predicate - condition to continue enumeration.

Returns:

limited Enumerable.

map

default <R> Enumerable<R> map(Function<? super E,? extends R> mapper)

Returns an Enumerable enumerating over the current elements mapped by the given mapper.

Type Parameters:

R - type of resulted elements.

Parameters:

mapper - Function instance mapping the current elements.

Returns:

mapped Enumerable.

map

default <R> Enumerable<R> map(BiFunction<? super E,? super Long,? extends R> mapper)

Returns an Enumerable enumerating over the current indexed elements mapped by the given mapper.

Type Parameters:

R - type of resulted elements.

Parameters:

mapper - BiFunction instance mapping the current indexed elements.

Returns:

mapped Enumerable.

peek

default Enumerable<E> peek(Consumer<? super E> action)

Returns an Enumerable enumerating the current elements while feeding them to the given Consumer.

Parameters:

action - Consumer instance to apply upon each element.

Returns:

peeked Enumerable.

prepend

default Enumerable<E> prepend(Iterable<? extends E> elements)

Prepends the current Enumerable by the given Iterable.

Parameters:

elements - Iterable to prepend.

Returns:

prepended Enumerable.

prependOn

default Enumerable<E> prependOn(E... elements)

Prepends the current Enumerable by the given elements.

Parameters:

elements - elements to prepend.

Returns:

prepended Enumerable.

range

static <E> Enumerable<E> range(E startInclusive,
                               E endExclusive,
                               UnaryOperator<E> succ,
                               Comparator<? super E> cmp)

Returns an Enumerable enumerating over a range of elements.

Type Parameters:

E - type of enumerated elements.

Parameters:

startInclusive - inclusive start of range.

endExclusive - exclusive end of range.

succ - successor unary operator.

cmp - comparison binary operator.

Returns:

range Enumerable.

rangeClosed

static <E> Enumerable<E> rangeClosed(E startInclusive,
                                     E endInclusive,
                                     UnaryOperator<E> succ,
                                     Comparator<? super E> cmp)

Returns an Enumerable enumerating over a range of elements.

Type Parameters:

E - type of enumerated elements.

Parameters:

startInclusive - inclusive start of range.

endInclusive - inclusive end of range.

succ - successor unary operator.

cmp - comparison binary operator.

Returns:

range Enumerable.

rangeInt

static Enumerable<Integer> rangeInt(int startInclusive,
                                    int endExclusive)

Returns an Enumerable enumerating over a range of integers.

Parameters:

startInclusive - inclusive start of range.

endExclusive - exclusive end of range.

Returns:

range Enumerable.

rangeIntClosed

static Enumerable<Integer> rangeIntClosed(int startInclusive,
                                          int endInclusive)

Returns an Enumerable enumerating over a range of integers.

Parameters:

startInclusive - inclusive start of range.

endInclusive - inclusive end of range.

Returns:

range Enumerable.

rangeLong

static Enumerable<Long> rangeLong(long startInclusive,
                                  long endExclusive)

Returns an Enumerable enumerating over a range of long integers.

Parameters:

startInclusive - inclusive start of range.

endExclusive - exclusive end of range.

Returns:

range Enumerable.

rangeLongClosed

static Enumerable<Long> rangeLongClosed(long startInclusive,
                                        long endInclusive)

Returns an Enumerable enumerating over a range of long integers.

Parameters:

startInclusive - inclusive start of range.

endInclusive - inclusive end of range.

Returns:

range Enumerable.

repeat

static <E> Enumerable<E> repeat(E element,
                                long count)

Returns an Enumerable repeating the given element the given number of time.

Type Parameters:

E - type of enumerated elements.

Parameters:

element - element to repeat.

count - number of times to repeat.

Returns:

repeated Enumerable.

repeatAll

default Enumerable<E> repeatAll(int count)

Returns an Enumerable repeating all the current elements the given number of times.

Parameters:

count - number of times to repeat.

Returns:

repeated Enumerable.

repeatEach

default Enumerable<E> repeatEach(long count)

Returns an Enumerable repeating each current element the given number of times.

Parameters:

count - number of times to repeat.

Returns:

repeated Enumerable.

reverse

default Enumerable<E> reverse()

Returns an Enumerable enumerating over the current elements in reversed order.

Returns:

reversed Enumerable.

skip

default Enumerable<E> skip(long n)

Returns an Enumerable that skips the given number of current elements.

Parameters:

n - number of elements to skip.

Returns:

skipped Enumerable.

skipWhile

default Enumerable<E> skipWhile(Predicate<? super E> predicate)

Returns an Enumerable that skips while the given condition holds true.

Parameters:

predicate - skipping condition.

Returns:

skipped Enumerable.

sorted

default Enumerable<E> sorted()

Returns an Enumerable enumerating over the current elements in sorted order.

Returns:

sorted Enumerable.

sorted

default Enumerable<E> sorted(Comparator<? super E> comparator)

Returns an Enumerable enumerating over the current elements in sorted order according to the given comparator.

Parameters:

comparator - sorting criterion.

Returns:

sorted Enumerable.

take

default Enumerable<E> take(long n)

Returns an Enumerable enumerating over the current elements up to the given limit.

Parameters:

n - limit to iterate up to.

Returns:

limited Enumerable.

takeWhile

default Enumerable<E> takeWhile(Predicate<? super E> predicate)

Returns an Enumerable enumerating over the current elements while the given predicate holds true.

Parameters:

predicate - condition to continue enumeration.

Returns:

limited Enumerable.

union

default Enumerable<E> union(Iterable<E> others)

Returns an Enumerable enumerating over the current elements and over the given Iterable while avoiding duplicates.

Parameters:

others - Iterable to perform union with.

Returns:

union Enumerable.

unionOn

default Enumerable<E> unionOn(E... others)

Returns an Enumerable enumerating over the current elements and over the given elements while avoiding duplicates.

Parameters:

others - elements to perform union with.

Returns:

union Enumerable.

zipAny

default <T> Enumerable<Pair<Optional<E>,Optional<T>>> zipAny(Iterable<T> elements)

Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while any of them has elements.

The resulted enumerator stops when both the current enumerable and the provided Iterable stop. The first element of a returned pair is empty Optional if the current enumerator has no elements. Likewise, the second element of a returned pair is empty Optional if the provided Iterable has no elements.

Type Parameters:

T - the of elements to zip with.

Parameters:

elements - Iterable to zip with.

Returns:

zipped Enumerable.

zipBoth

default <T> Enumerable<Pair<E,T>> zipBoth(Enumerable<T> elements)

Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while both have elements.

The resulted enumerator stops when aby of the current enumerator or the provided Iterable stop.

Type Parameters:

T - the of elements to zip with.

Parameters:

elements - Iterable to zip with.

Returns:

zipped Enumerable.

zipLeft

default <T> Enumerable<Pair<E,Optional<T>>> zipLeft(Iterable<T> elements)

Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while the current enumerator has elements.

The resulted enumerator stops when the current enumerator stops. The second element of a returned pair is empty Optional if the provided Iterable has no elements.

Type Parameters:

T - the of elements to zip with

Parameters:

elements - Iterable to zip with

Returns:

zipped Enumerable

zipRight

default <T> Enumerable<Pair<Optional<E>,T>> zipRight(Iterable<T> elements)

Returns an Enumerable consisting of pairs of elements from the current enumerator and the given Iterable, while the provided iterator has elements.

The resulted enumerator stops when the provided Iterable stops. The first element of a returned pair is empty Optional if the current enumerator has no elements.

Type Parameters:

T - the of elements to zip with

Parameters:

elements - Iterable to zip with

Returns:

zipped Enumerable

zipAll

default Enumerable<Optional<E>[]> zipAll(Iterable<? extends E> first,
                                         Iterable<? extends E>... rest)

Returns an Enumerable consisting of an array of Optional objects containing elements from the current enumerator and the given Iterable instances, while any has elements.

Parameters:

first - first iterable to zip with.

rest - the rest of iterables to zip with.

Returns:

zipped Enumerable.