com.jnape.palatable.lambda.functions.builtin.fn1

Class Uncons<A>

java.lang.Object

com.jnape.palatable.lambda.functions.builtin.fn1.Uncons<A>

Type Parameters:

A - the Iterable element type

All Implemented Interfaces:

Fn1<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>>, Applicative<Maybe<Tuple2<A,Iterable<A>>>,Fn1<Iterable<A>,?>>, Cartesian<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>,Fn1<?,?>>, Cocartesian<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>,Fn1<?,?>>, Contravariant<Iterable<A>,Profunctor<?,Maybe<Tuple2<A,Iterable<A>>>,Fn1<?,?>>>, Functor<Maybe<Tuple2<A,Iterable<A>>>,Fn1<Iterable<A>,?>>, Profunctor<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>,Fn1<?,?>>, Monad<Maybe<Tuple2<A,Iterable<A>>>,Fn1<Iterable<A>,?>>, MonadReader<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>,Fn1<Iterable<A>,?>>, MonadRec<Maybe<Tuple2<A,Iterable<A>>>,Fn1<Iterable<A>,?>>, MonadWriter<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>,Fn1<Iterable<A>,?>>

public final class Uncons<A>
extends Object
implements Fn1<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>>

Destructure an Iterable into a Tuple2 of its head and tail, wrapped in an Maybe. If the Iterable is empty, returns Maybe.nothing().

Method Summary

Modifier and Type	Method and Description
Maybe<Tuple2<A,Iterable<A>>>	checkedApply(Iterable<A> as) Invoke this function with the given argument, potentially throwing any Throwable.
static <A> Uncons<A>	uncons()
static <A> Maybe<Tuple2<A,Iterable<A>>>	uncons(Iterable<A> as)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jnape.palatable.lambda.functions.Fn1

andThen, apply, carry, cartesian, censor, choose, cocartesian, compose, contraMap, diMap, diMapL, diMapR, discardL, discardR, flatMap, fmap, fn1, fromFunction, lazyZip, listens, local, pure, pureFn1, thunk, toFunction, trampolineM, widen, zip, zip

Methods inherited from interface com.jnape.palatable.lambda.monad.Monad

join

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

coerce

Method Detail

checkedApply

public Maybe<Tuple2<A,Iterable<A>>> checkedApply(Iterable<A> as)

Description copied from interface: Fn1

Invoke this function with the given argument, potentially throwing any Throwable.

Specified by:

checkedApply in interface Fn1<Iterable<A>,Maybe<Tuple2<A,Iterable<A>>>>

Parameters:

as - the argument

Returns:

the result of the function application

uncons

public static <A> Uncons<A> uncons()

uncons

public static <A> Maybe<Tuple2<A,Iterable<A>>> uncons(Iterable<A> as)