dev.marksman.enhancediterables

Interface ImmutableIterable<A>

Type Parameters:

A - the element type

All Superinterfaces:

EnhancedIterable<A>, Iterable<A>

All Known Subinterfaces:

ImmutableFiniteIterable<A>, ImmutableNonEmptyFiniteIterable<A>, ImmutableNonEmptyIterable<A>

public interface ImmutableIterable<A>
extends EnhancedIterable<A>

An EnhancedIterable that is safe from mutation.

May be infinite, finite, or empty.

Method Summary

Modifier and Type	Method and Description
default ImmutableNonEmptyIterable<A>	append(A element)
default ImmutableIterable<A>	concat(ImmutableIterable<A> other)
default ImmutableIterable<A>	drop(int count) Returns a new ImmutableIterable that drops the first count elements of this ImmutableIterable.
default ImmutableIterable<A>	dropWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default ImmutableIterable<A>	filter(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default <B> ImmutableIterable<B>	fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)
default ImmutableIterable<A>	intersperse(A a)
static <A> ImmutableNonEmptyFiniteIterable<A>	of(A first, A... more)
default <B,C> com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends ImmutableIterable<B>,? extends ImmutableIterable<C>>	partition(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends com.jnape.palatable.lambda.adt.coproduct.CoProduct2<B,C,?>> function) Partitions this ImmutableIterable given a disjoint mapping function.
default ImmutableNonEmptyIterable<A>	prepend(A element)
default ImmutableIterable<A>	prependAll(A a)
default ImmutableIterable<? extends ImmutableNonEmptyFiniteIterable<A>>	slide(int k) "Slide" a window of k elements across the ImmutableIterable by one element at a time.
default com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends ImmutableIterable<A>,? extends ImmutableIterable<A>>	span(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default NonEmptyIterable<? extends ImmutableIterable<A>>	tails()
default ImmutableFiniteIterable<A>	take(int count)
default ImmutableIterable<A>	takeWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default <B,C> ImmutableIterable<C>	zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn, ImmutableIterable<B> other)

Methods inherited from interface dev.marksman.enhancediterables.EnhancedIterable

concat, enhance, find, isEmpty, toArray, toCollection, zipWith

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

append

default ImmutableNonEmptyIterable<A> append(A element)

Specified by:

append in interface EnhancedIterable<A>

concat

default ImmutableIterable<A> concat(ImmutableIterable<A> other)

drop

default ImmutableIterable<A> drop(int count)

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

Specified by:

drop in interface EnhancedIterable<A>

Parameters:

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

Returns:

an ImmutableIterable<A>

dropWhile

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

Specified by:

dropWhile in interface EnhancedIterable<A>

filter

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

Specified by:

filter in interface EnhancedIterable<A>

fmap

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

Specified by:

fmap in interface EnhancedIterable<A>

intersperse

default ImmutableIterable<A> intersperse(A a)

Specified by:

intersperse in interface EnhancedIterable<A>

partition

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

Partitions this ImmutableIterable 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.

Specified by:

partition in interface EnhancedIterable<A>

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<ImmutableIterable<B>, ImmutableIterable<C>>

prepend

default ImmutableNonEmptyIterable<A> prepend(A element)

Specified by:

prepend in interface EnhancedIterable<A>

prependAll

default ImmutableIterable<A> prependAll(A a)

Specified by:

prependAll in interface EnhancedIterable<A>

slide

default ImmutableIterable<? extends ImmutableNonEmptyFiniteIterable<A>> slide(int k)

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

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

Specified by:

slide in interface EnhancedIterable<A>

Parameters:

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

Returns:

an ImmutableIterable<ImmutableNonEmptyFiniteIterable<A>>

span

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

Specified by:

span in interface EnhancedIterable<A>

tails

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

Specified by:

tails in interface EnhancedIterable<A>

take

default ImmutableFiniteIterable<A> take(int count)

Specified by:

take in interface EnhancedIterable<A>

takeWhile

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

Specified by:

takeWhile in interface EnhancedIterable<A>

zipWith

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

of

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

Specified by:

of in interface EnhancedIterable<A>