dev.marksman.enhancediterables

Interface EnhancedIterable<A>

Type Parameters:

A - the element type

All Superinterfaces:

Iterable<A>

All Known Subinterfaces:

FiniteIterable<A>, ImmutableFiniteIterable<A>, ImmutableIterable<A>, ImmutableNonEmptyFiniteIterable<A>, ImmutableNonEmptyIterable<A>, NonEmptyFiniteIterable<A>, NonEmptyIterable<A>

public interface EnhancedIterable<A>
extends Iterable<A>

An Iterable with some additional methods.

May be infinite, finite, or empty.

Any Iterable can be upgraded to an EnhancedIterable by calling enhance(Iterable)}.

Method Summary

Modifier and Type	Method and Description
default NonEmptyIterable<A>	append(A element)
default EnhancedIterable<A>	concat(Iterable<A> other)
default EnhancedIterable<A>	drop(int count) Returns a new EnhancedIterable that drops the first count elements of this EnhancedIterable.
default EnhancedIterable<A>	dropWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
static <A> EnhancedIterable<A>	enhance(Iterable<A> underlying)
default EnhancedIterable<A>	filter(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default com.jnape.palatable.lambda.adt.Maybe<A>	find(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate) Finds the first element of this EnhancedIterable that satisfies a predicate, if any.
default <B> EnhancedIterable<B>	fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)
default EnhancedIterable<A>	intersperse(A a)
default boolean	isEmpty()
static <A> ImmutableNonEmptyFiniteIterable<A>	of(A first, A... more)
default <B,C> com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends EnhancedIterable<B>,? extends EnhancedIterable<C>>	partition(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends com.jnape.palatable.lambda.adt.coproduct.CoProduct2<B,C,?>> function) Partitions this EnhancedIterable given a disjoint mapping function.
default NonEmptyIterable<A>	prepend(A element)
default EnhancedIterable<A>	prependAll(A a)
default EnhancedIterable<? extends NonEmptyFiniteIterable<A>>	slide(int k) "Slide" a window of k elements across the EnhancedIterable by one element at a time.
default com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends EnhancedIterable<A>,? extends EnhancedIterable<A>>	span(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default NonEmptyIterable<? extends EnhancedIterable<A>>	tails()
default FiniteIterable<A>	take(int count)
default EnhancedIterable<A>	takeWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default A[]	toArray(Class<A[]> arrayType)
default <C extends Collection<A>> C	toCollection(com.jnape.palatable.lambda.functions.Fn0<C> cSupplier)
default <B,C> EnhancedIterable<C>	zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn, Iterable<B> other)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

append

default NonEmptyIterable<A> append(A element)

concat

default EnhancedIterable<A> concat(Iterable<A> other)

drop

default EnhancedIterable<A> drop(int count)

Returns a new EnhancedIterable that drops the first count elements of this EnhancedIterable.

Parameters:

count - the number of elements to drop from this EnhancedIterable. Must be >= 0. May exceed size of this EnhancedIterable, in which case, the result will be an empty EnhancedIterable.

Returns:

an EnhancedIterable<A>

dropWhile

default EnhancedIterable<A> dropWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

filter

default EnhancedIterable<A> filter(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

find

default com.jnape.palatable.lambda.adt.Maybe<A> find(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

Finds the first element of this EnhancedIterable that satisfies a predicate, if any.

Parameters:

predicate - a predicate; not null

Returns:

an element wrapped in a Maybe.just(A) if a matching element is found; Maybe.nothing() otherwise.

fmap

default <B> EnhancedIterable<B> fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)

intersperse

default EnhancedIterable<A> intersperse(A a)

isEmpty

default boolean isEmpty()

partition

default <B,C> com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends EnhancedIterable<B>,? extends EnhancedIterable<C>> partition(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends com.jnape.palatable.lambda.adt.coproduct.CoProduct2<B,C,?>> function)

Partitions this EnhancedIterable given a disjoint mapping function.

Note that while the returned tuple must be constructed eagerly, the left and right iterables contained therein are both lazy, so comprehension over infinite iterables is supported.

Type Parameters:

B - The output left Iterable element type, as well as the CoProduct2 A type

C - The output right Iterable element type, as well as the CoProduct2 B type

Parameters:

function - the mapping function

Returns:

a Tuple2<EnhancedIterable<B>, EnhancedIterable<C>>

prepend

default NonEmptyIterable<A> prepend(A element)

prependAll

default EnhancedIterable<A> prependAll(A a)

slide

default EnhancedIterable<? extends NonEmptyFiniteIterable<A>> slide(int k)

"Slide" a window of k elements across the EnhancedIterable by one element at a time.

Example: EnhancedIterable.of(1, 2, 3, 4, 5).slide(2); // [[1, 2], [2, 3], [3, 4], [4, 5]]

Parameters:

k - the number of elements in the sliding window. Must be >= 1.

Returns:

an EnhancedIterable<NonEmptyFiniteIterable<A>>

span

default com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends EnhancedIterable<A>,? extends EnhancedIterable<A>> span(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

tails

default NonEmptyIterable<? extends EnhancedIterable<A>> tails()

take

default FiniteIterable<A> take(int count)

takeWhile

default EnhancedIterable<A> takeWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

toArray

default A[] toArray(Class<A[]> arrayType)

toCollection

default <C extends Collection<A>> C toCollection(com.jnape.palatable.lambda.functions.Fn0<C> cSupplier)

zipWith

default <B,C> EnhancedIterable<C> zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn,
                                          Iterable<B> other)

enhance

static <A> EnhancedIterable<A> enhance(Iterable<A> underlying)

of

@SafeVarargs
static <A> ImmutableNonEmptyFiniteIterable<A> of(A first,
                                                               A... more)