dev.marksman.enhancediterables

Interface ImmutableFiniteIterable<A>

Type Parameters:

A - the element type

All Superinterfaces:

EnhancedIterable<A>, FiniteIterable<A>, ImmutableIterable<A>, Iterable<A>

All Known Subinterfaces:

ImmutableNonEmptyFiniteIterable<A>

public interface ImmutableFiniteIterable<A>
extends ImmutableIterable<A>, FiniteIterable<A>

An EnhancedIterable that is both finite and safe from mutation.

Method Summary

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

Methods inherited from interface dev.marksman.enhancediterables.ImmutableIterable

concat

Methods inherited from interface dev.marksman.enhancediterables.FiniteIterable

concat, cross, finiteIterable, finiteIterable, foldLeft, zipWith

Methods inherited from interface dev.marksman.enhancediterables.EnhancedIterable

concat, enhance, find, isEmpty, toArray, toCollection

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

append

default ImmutableNonEmptyFiniteIterable<A> append(A element)

Specified by:

append in interface EnhancedIterable<A>

Specified by:

append in interface FiniteIterable<A>

Specified by:

append in interface ImmutableIterable<A>

concat

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

cross

default <B> ImmutableFiniteIterable<com.jnape.palatable.lambda.adt.hlist.Tuple2<A,B>> cross(ImmutableFiniteIterable<B> other)

Returns the lazily computed cartesian product of this ImmutableFiniteIterable with another ImmutableFiniteIterable.

Type Parameters:

B - the type of the other ImmutableFiniteIterable

Parameters:

other - an ImmutableFiniteIterable of any type

Returns:

a ImmutableFiniteIterable<Tuple2<A, B>>

drop

default ImmutableFiniteIterable<A> drop(int count)

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

Specified by:

drop in interface EnhancedIterable<A>

Specified by:

drop in interface FiniteIterable<A>

Specified by:

drop in interface ImmutableIterable<A>

Parameters:

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

Returns:

an ImmutableFiniteIterable<A>

dropWhile

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

Specified by:

dropWhile in interface EnhancedIterable<A>

Specified by:

dropWhile in interface FiniteIterable<A>

Specified by:

dropWhile in interface ImmutableIterable<A>

filter

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

Specified by:

filter in interface EnhancedIterable<A>

Specified by:

filter in interface FiniteIterable<A>

Specified by:

filter in interface ImmutableIterable<A>

fmap

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

Specified by:

fmap in interface EnhancedIterable<A>

Specified by:

fmap in interface FiniteIterable<A>

Specified by:

fmap in interface ImmutableIterable<A>

inits

default NonEmptyIterable<? extends ImmutableFiniteIterable<A>> inits()

Specified by:

inits in interface FiniteIterable<A>

intersperse

default ImmutableFiniteIterable<A> intersperse(A a)

Specified by:

intersperse in interface EnhancedIterable<A>

Specified by:

intersperse in interface FiniteIterable<A>

Specified by:

intersperse in interface ImmutableIterable<A>

partition

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

Partitions this ImmutableFiniteIterable given a disjoint mapping function.

Specified by:

partition in interface EnhancedIterable<A>

Specified by:

partition in interface FiniteIterable<A>

Specified by:

partition in interface ImmutableIterable<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<ImmutableFiniteIterable<B>, ImmutableFiniteIterable<C>>

prepend

default ImmutableNonEmptyFiniteIterable<A> prepend(A element)

Specified by:

prepend in interface EnhancedIterable<A>

Specified by:

prepend in interface FiniteIterable<A>

Specified by:

prepend in interface ImmutableIterable<A>

prependAll

default ImmutableFiniteIterable<A> prependAll(A a)

Specified by:

prependAll in interface EnhancedIterable<A>

Specified by:

prependAll in interface FiniteIterable<A>

Specified by:

prependAll in interface ImmutableIterable<A>

reverse

default ImmutableFiniteIterable<A> reverse()

Specified by:

reverse in interface FiniteIterable<A>

slide

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

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

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

Specified by:

slide in interface EnhancedIterable<A>

Specified by:

slide in interface FiniteIterable<A>

Specified by:

slide in interface ImmutableIterable<A>

Parameters:

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

Returns:

an ImmutableFiniteIterable<ImmutableNonEmptyFiniteIterable<A>>

span

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

Specified by:

span in interface EnhancedIterable<A>

Specified by:

span in interface FiniteIterable<A>

Specified by:

span in interface ImmutableIterable<A>

tails

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

Specified by:

tails in interface EnhancedIterable<A>

Specified by:

tails in interface FiniteIterable<A>

Specified by:

tails in interface ImmutableIterable<A>

take

default ImmutableFiniteIterable<A> take(int count)

Specified by:

take in interface EnhancedIterable<A>

Specified by:

take in interface ImmutableIterable<A>

takeWhile

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

Specified by:

takeWhile in interface EnhancedIterable<A>

Specified by:

takeWhile in interface FiniteIterable<A>

Specified by:

takeWhile in interface ImmutableIterable<A>

zipWith

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

Specified by:

zipWith in interface ImmutableIterable<A>

of

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

Specified by:

of in interface EnhancedIterable<A>

Specified by:

of in interface FiniteIterable<A>

Specified by:

of in interface ImmutableIterable<A>