dev.marksman.enhancediterables

Interface NonEmptyIterable<A>

Type Parameters:

A - the element type

All Superinterfaces:

EnhancedIterable<A>, Iterable<A>

All Known Subinterfaces:

ImmutableNonEmptyFiniteIterable<A>, ImmutableNonEmptyIterable<A>, NonEmptyFiniteIterable<A>

public interface NonEmptyIterable<A>
extends EnhancedIterable<A>

An EnhancedIterable that is guaranteed to contain at least one element.

May be infinite or finite.

Method Summary

Modifier and Type	Method and Description
default NonEmptyIterable<A>	concat(Iterable<A> other)
default <B> NonEmptyIterable<B>	fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)
A	head() Returns the first element.
default NonEmptyIterable<A>	intersperse(A a)
default Iterator<A>	iterator()
static <A> NonEmptyIterable<A>	nonEmptyIterable(A head, Iterable<A> tail) Creates a NonEmptyIterable.
default NonEmptyIterable<A>	prependAll(A a)
EnhancedIterable<A>	tail() Returns an EnhancedIterable containing all subsequent elements beyond the first.
default <B,C> NonEmptyIterable<C>	zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn, NonEmptyIterable<B> other)

Methods inherited from interface dev.marksman.enhancediterables.EnhancedIterable

append, drop, dropWhile, enhance, filter, find, isEmpty, of, partition, prepend, slide, span, tails, take, takeWhile, toArray, toCollection, zipWith

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

head

A head()

Returns the first element.

Returns:

an element of type A

tail

EnhancedIterable<A> tail()

Returns an EnhancedIterable containing all subsequent elements beyond the first.

Returns:

an EnhancedIterable<A>. May be empty.

concat

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

Specified by:

concat in interface EnhancedIterable<A>

fmap

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

Specified by:

fmap in interface EnhancedIterable<A>

intersperse

default NonEmptyIterable<A> intersperse(A a)

Specified by:

intersperse in interface EnhancedIterable<A>

iterator

default Iterator<A> iterator()

Specified by:

iterator in interface Iterable<A>

prependAll

default NonEmptyIterable<A> prependAll(A a)

Specified by:

prependAll in interface EnhancedIterable<A>

zipWith

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

nonEmptyIterable

static <A> NonEmptyIterable<A> nonEmptyIterable(A head,
                                                Iterable<A> tail)

Creates a NonEmptyIterable.

Type Parameters:

A - the element type

Parameters:

head - the first element

tail - the remaining elements. May be empty.

Returns:

a NonEmptyIterable<A>