Package software.kes.enhancediterables

Interface ImmutableNonEmptyFiniteIterable<A>

Type Parameters:

A - the element type

All Superinterfaces:

EnhancedIterable<A>, FiniteIterable<A>, com.jnape.palatable.lambda.functor.Functor<A,EnhancedIterable<?>>, ImmutableFiniteIterable<A>, ImmutableIterable<A>, ImmutableNonEmptyIterable<A>, java.lang.Iterable<A>, NonEmptyFiniteIterable<A>, NonEmptyIterable<A>

public interface ImmutableNonEmptyFiniteIterable<A>
extends ImmutableFiniteIterable<A>, ImmutableNonEmptyIterable<A>, NonEmptyFiniteIterable<A>

An EnhancedIterable that is finite, safe from mutation, and guaranteed to contain at least one element.

Method Summary

Modifier and Type	Method	Description
default ImmutableNonEmptyFiniteIterable<A>	concat(ImmutableFiniteIterable<A> other)	Lazily concatenates another ImmutableFiniteIterable to the end of this ImmutableNonEmptyFiniteIterable, yielding a new ImmutableIterable.
default <B> ImmutableNonEmptyFiniteIterable<com.jnape.palatable.lambda.adt.hlist.Tuple2<A,B>>	cross(ImmutableNonEmptyFiniteIterable<B> other)	Returns the lazily computed cartesian product of this ImmutableNonEmptyFiniteIterable with another ImmutableNonEmptyFiniteIterable.
default ImmutableNonEmptyIterable<A>	cycle()	Returns an infinite ImmutableNonEmptyIterable that repeatedly cycles this ImmutableNonEmptyFiniteIterable's elements, in order.
default ImmutableNonEmptyFiniteIterable<A>	distinct()	Returns a ImmutableNonEmptyFiniteIterable of the distinct values from this ImmutableNonEmptyFiniteIterable.
default <B> ImmutableNonEmptyFiniteIterable<B>	fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)	Returns a new ImmutableNonEmptyFiniteIterable by applying a function to all elements of this ImmutableNonEmptyFiniteIterable.
static <A> ImmutableNonEmptyFiniteIterable<A>	immutableNonEmptyFiniteIterable(A head, ImmutableFiniteIterable<A> tail)	Creates an ImmutableNonEmptyFiniteIterable.
default ImmutableFiniteIterable<A>	init()	Returns an ImmutableFiniteIterable containing all of elements of this one, except for the last element.
default ImmutableNonEmptyFiniteIterable<A>	intersperse(A separator)	Returns a new ImmutableNonEmptyFiniteIterable with the provided separator value injected between each value of this ImmutableNonEmptyFiniteIterable.
default ImmutableNonEmptyFiniteIterable<? extends ImmutableNonEmptyFiniteIterable<A>>	magnetizeBy(com.jnape.palatable.lambda.functions.Fn2<A,A,java.lang.Boolean> predicate)	Returns an Iterable of contiguous groups of elements in this ImmutableNonEmptyFiniteIterable that match a predicate pairwise.
static <A> ImmutableNonEmptyFiniteIterable<A>	of(A first, A... more)	Creates an ImmutableNonEmptyFiniteIterable containing the given elements.
default ImmutableNonEmptyFiniteIterable<A>	prepend(A element)	Lazily prepends an element to the front of this ImmutableNonEmptyFiniteIterable, yielding a new ImmutableNonEmptyFiniteIterable.
default ImmutableNonEmptyFiniteIterable<A>	prependAll(A separator)	Returns a new ImmutableNonEmptyFiniteIterable with the provided separator value injected before each value of this ImmutableNonEmptyFiniteIterable.
default ImmutableNonEmptyFiniteIterable<A>	reverse()	Returns a reversed representation of this ImmutableNonEmptyFiniteIterable.
ImmutableFiniteIterable<A>	tail()	Returns an ImmutableFiniteIterable containing all subsequent elements of this one beyond the first.
default com.jnape.palatable.lambda.adt.Maybe<? extends ImmutableNonEmptyFiniteIterable<A>>	toFinite()	Always succeeds because ImmutableNonEmptyFiniteIterables are always finite.
default com.jnape.palatable.lambda.adt.Maybe<? extends ImmutableNonEmptyFiniteIterable<A>>	toNonEmpty()	Always succeeds because ImmutableNonEmptyFiniteIterables are always non-empty.
default <B,C> ImmutableNonEmptyFiniteIterable<C>	zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn, ImmutableNonEmptyIterable<B> other)	Zips together this ImmutableNonEmptyFiniteIterable with another ImmutableNonEmptyIterable by applying a zipping function.

Methods inherited from interface software.kes.enhancediterables.EnhancedIterable

concat, find, toArray, toCollection, zipWith, zipWith

Methods inherited from interface software.kes.enhancediterables.FiniteIterable

append, concat, cross, cross, drop, dropWhile, filter, foldLeft, foldRight, partition, size, slide, span, tails, takeWhile, zipWith

Methods inherited from interface com.jnape.palatable.lambda.functor.Functor

coerce

Methods inherited from interface software.kes.enhancediterables.ImmutableFiniteIterable

append, concat, cross, drop, dropWhile, filter, inits, partition, slide, span, tails, takeWhile, zipWith

Methods inherited from interface software.kes.enhancediterables.ImmutableIterable

concat, take, zipWith

Methods inherited from interface software.kes.enhancediterables.ImmutableNonEmptyIterable

concat, zipWith

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface software.kes.enhancediterables.NonEmptyFiniteIterable

concat, concat, cross, last, reduceLeft, reduceRight, zipWith

Methods inherited from interface software.kes.enhancediterables.NonEmptyIterable

concat, head, isEmpty, iterator, zipWith

Method Detail

tail

ImmutableFiniteIterable<A> tail()

Returns an ImmutableFiniteIterable containing all subsequent elements of this one beyond the first.

Specified by:

tail in interface ImmutableNonEmptyIterable<A>

Specified by:

tail in interface NonEmptyFiniteIterable<A>

Specified by:

tail in interface NonEmptyIterable<A>

Returns:

an ImmutableFiniteIterable<A>

concat

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

Lazily concatenates another ImmutableFiniteIterable to the end of this ImmutableNonEmptyFiniteIterable, yielding a new ImmutableIterable.

Specified by:

concat in interface ImmutableFiniteIterable<A>

Parameters:

other - the other ImmutableIterable

Returns:

an ImmutableIterable<A>

cross

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

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

Type Parameters:

B - the type of the other ImmutableNonEmptyFiniteIterable

Parameters:

other - an ImmutableNonEmptyFiniteIterable of any type

Returns:

a ImmutableNonEmptyFiniteIterable<Tuple2<A, B>>

cycle

default ImmutableNonEmptyIterable<A> cycle()

Returns an infinite ImmutableNonEmptyIterable that repeatedly cycles this ImmutableNonEmptyFiniteIterable's elements, in order.

Specified by:

cycle in interface FiniteIterable<A>

Specified by:

cycle in interface ImmutableFiniteIterable<A>

Specified by:

cycle in interface NonEmptyFiniteIterable<A>

Returns:

an ImmutableNonEmptyIterable<A>

distinct

default ImmutableNonEmptyFiniteIterable<A> distinct()

Returns a ImmutableNonEmptyFiniteIterable of the distinct values from this ImmutableNonEmptyFiniteIterable.

Specified by:

distinct in interface FiniteIterable<A>

Specified by:

distinct in interface ImmutableFiniteIterable<A>

Specified by:

distinct in interface NonEmptyFiniteIterable<A>

Returns:

a ImmutableNonEmptyFiniteIterable<A>

fmap

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

Returns a new ImmutableNonEmptyFiniteIterable by applying a function to all elements of this ImmutableNonEmptyFiniteIterable.

Specified by:

fmap in interface EnhancedIterable<A>

Specified by:

fmap in interface FiniteIterable<A>

Specified by:

fmap in interface com.jnape.palatable.lambda.functor.Functor<A,EnhancedIterable<?>>

Specified by:

fmap in interface ImmutableFiniteIterable<A>

Specified by:

fmap in interface ImmutableIterable<A>

Specified by:

fmap in interface ImmutableNonEmptyIterable<A>

Specified by:

fmap in interface NonEmptyFiniteIterable<A>

Specified by:

fmap in interface NonEmptyIterable<A>

Type Parameters:

B - the type returned by f

Parameters:

f - a function from A to B. This function should be referentially transparent and not perform side-effects. It may be called zero or more times for each element.

Returns:

an ImmutableNonEmptyFiniteIterable<B>

init

default ImmutableFiniteIterable<A> init()

Returns an ImmutableFiniteIterable containing all of elements of this one, except for the last element.

Specified by:

init in interface NonEmptyFiniteIterable<A>

Returns:

an ImmutableFiniteIterable<A>

intersperse

default ImmutableNonEmptyFiniteIterable<A> intersperse(A separator)

Returns a new ImmutableNonEmptyFiniteIterable with the provided separator value injected between each value of this ImmutableNonEmptyFiniteIterable.

If this ImmutableNonEmptyFiniteIterable contains only one element, it is left untouched.

Specified by:

intersperse in interface EnhancedIterable<A>

Specified by:

intersperse in interface FiniteIterable<A>

Specified by:

intersperse in interface ImmutableFiniteIterable<A>

Specified by:

intersperse in interface ImmutableIterable<A>

Specified by:

intersperse in interface ImmutableNonEmptyIterable<A>

Specified by:

intersperse in interface NonEmptyFiniteIterable<A>

Specified by:

intersperse in interface NonEmptyIterable<A>

Parameters:

separator - the separator value

Returns:

an ImmutableNonEmptyFiniteIterable<A>

magnetizeBy

default ImmutableNonEmptyFiniteIterable<? extends ImmutableNonEmptyFiniteIterable<A>> magnetizeBy(com.jnape.palatable.lambda.functions.Fn2<A,A,java.lang.Boolean> predicate)

Returns an Iterable of contiguous groups of elements in this ImmutableNonEmptyFiniteIterable that match a predicate pairwise.

Specified by:

magnetizeBy in interface EnhancedIterable<A>

Specified by:

magnetizeBy in interface FiniteIterable<A>

Specified by:

magnetizeBy in interface ImmutableFiniteIterable<A>

Specified by:

magnetizeBy in interface ImmutableIterable<A>

Specified by:

magnetizeBy in interface ImmutableNonEmptyIterable<A>

Specified by:

magnetizeBy in interface NonEmptyFiniteIterable<A>

Specified by:

magnetizeBy in interface NonEmptyIterable<A>

Parameters:

predicate - the predicate function. This function should be referentially transparent and not perform side-effects. It may be called zero or more times for each element.

Returns:

an ImmutableNonEmptyFiniteIterable<ImmutableNonEmptyFiniteIterable<A>> containing the contiguous groups

prepend

default ImmutableNonEmptyFiniteIterable<A> prepend(A element)

Lazily prepends an element to the front of this ImmutableNonEmptyFiniteIterable, yielding a new ImmutableNonEmptyFiniteIterable.

Specified by:

prepend in interface EnhancedIterable<A>

Specified by:

prepend in interface FiniteIterable<A>

Specified by:

prepend in interface ImmutableFiniteIterable<A>

Specified by:

prepend in interface ImmutableIterable<A>

Parameters:

element - the element to prepend

Returns:

a ImmutableNonEmptyFiniteIterable<A>

prependAll

default ImmutableNonEmptyFiniteIterable<A> prependAll(A separator)

Returns a new ImmutableNonEmptyFiniteIterable with the provided separator value injected before each value of this ImmutableNonEmptyFiniteIterable.

Specified by:

prependAll in interface EnhancedIterable<A>

Specified by:

prependAll in interface FiniteIterable<A>

Specified by:

prependAll in interface ImmutableFiniteIterable<A>

Specified by:

prependAll in interface ImmutableIterable<A>

Specified by:

prependAll in interface ImmutableNonEmptyIterable<A>

Specified by:

prependAll in interface NonEmptyFiniteIterable<A>

Specified by:

prependAll in interface NonEmptyIterable<A>

Parameters:

separator - the separator value

Returns:

an ImmutableNonEmptyFiniteIterable<A>

reverse

default ImmutableNonEmptyFiniteIterable<A> reverse()

Returns a reversed representation of this ImmutableNonEmptyFiniteIterable.

Note that reversing is deferred until the returned Iterable is iterated.

Specified by:

reverse in interface FiniteIterable<A>

Specified by:

reverse in interface ImmutableFiniteIterable<A>

Specified by:

reverse in interface NonEmptyFiniteIterable<A>

Returns:

an ImmutableNonEmptyFiniteIterable<A>

toFinite

default com.jnape.palatable.lambda.adt.Maybe<? extends ImmutableNonEmptyFiniteIterable<A>> toFinite()

Always succeeds because ImmutableNonEmptyFiniteIterables are always finite.

Specified by:

toFinite in interface EnhancedIterable<A>

Specified by:

toFinite in interface FiniteIterable<A>

Specified by:

toFinite in interface ImmutableFiniteIterable<A>

Specified by:

toFinite in interface ImmutableIterable<A>

Specified by:

toFinite in interface ImmutableNonEmptyIterable<A>

Specified by:

toFinite in interface NonEmptyFiniteIterable<A>

Specified by:

toFinite in interface NonEmptyIterable<A>

Returns:

this ImmutableNonEmptyFiniteIterable wrapped in a `just`

toNonEmpty

default com.jnape.palatable.lambda.adt.Maybe<? extends ImmutableNonEmptyFiniteIterable<A>> toNonEmpty()

Always succeeds because ImmutableNonEmptyFiniteIterables are always non-empty.

Specified by:

toNonEmpty in interface EnhancedIterable<A>

Specified by:

toNonEmpty in interface FiniteIterable<A>

Specified by:

toNonEmpty in interface ImmutableFiniteIterable<A>

Specified by:

toNonEmpty in interface ImmutableIterable<A>

Specified by:

toNonEmpty in interface ImmutableNonEmptyIterable<A>

Specified by:

toNonEmpty in interface NonEmptyFiniteIterable<A>

Specified by:

toNonEmpty in interface NonEmptyIterable<A>

Returns:

this ImmutableNonEmptyFiniteIterable wrapped in a `just`

zipWith

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

Zips together this ImmutableNonEmptyFiniteIterable with another ImmutableNonEmptyIterable by applying a zipping function.

Applies the function to the successive elements of each Iterable until one of them runs out of elements.

Specified by:

zipWith in interface ImmutableNonEmptyIterable<A>

Type Parameters:

B - the element type of the other Iterable

C - the element type of the result

Parameters:

fn - the zipping function. Not null. This function should be referentially transparent and not perform side-effects. It may be called zero or more times for each element.

other - the other Iterable

Returns:

an ImmutableNonEmptyFiniteIterable<C>

immutableNonEmptyFiniteIterable

static <A> ImmutableNonEmptyFiniteIterable<A> immutableNonEmptyFiniteIterable(A head,
                                                                              ImmutableFiniteIterable<A> tail)

Creates an ImmutableNonEmptyFiniteIterable.

Type Parameters:

A - the element type

Parameters:

head - the first element

tail - the remaining elements. May be empty.

Returns:

a ImmutableNonEmptyFiniteIterable<A>

of

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

Creates an ImmutableNonEmptyFiniteIterable containing the given elements.

Type Parameters:

A - the element type

Parameters:

first - the first element

more - the remaining elements

Returns:

an ImmutableNonEmptyFiniteIterable<A>