Package com.jnape.palatable.lambda.monoid.builtin

Class LeftAll<L,R>

java.lang.Object

com.jnape.palatable.lambda.monoid.builtin.LeftAll<L,R>

Type Parameters:

L - The left parameter type

R - The right parameter type

All Implemented Interfaces:

Fn1<Monoid<L>,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>>, Fn2<Monoid<L>,Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>, Fn3<Monoid<L>,Either<L,R>,Either<L,R>,Either<L,R>>, MonoidFactory<Monoid<L>,Either<L,R>>, SemigroupFactory<Monoid<L>,Either<L,R>>, Applicative<Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<Monoid<L>,?>>, Cartesian<Monoid<L>,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<?,?>>, Cocartesian<Monoid<L>,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<?,?>>, Contravariant<Monoid<L>,Profunctor<?,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<?,?>>>, Functor<Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<Monoid<L>,?>>, Profunctor<Monoid<L>,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<?,?>>, Monad<Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<Monoid<L>,?>>, MonadReader<Monoid<L>,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<Monoid<L>,?>>, MonadRec<Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<Monoid<L>,?>>, MonadWriter<Monoid<L>,Fn1<Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>,Fn1<Monoid<L>,?>>

public final class LeftAll<L,R>
extends Object
implements MonoidFactory<Monoid<L>,Either<L,R>>

A Monoid instance formed by Either<L,R> and a monoid over L. The application to two Either values short-circuits on right values, such that for a given Either x and y:

• if x is a Right value, the result is x
• if y is a Right value, the result is y
• if both x and y are left values, the result is the application of the x and y values in terms of the provided monoid, wrapped in Either.left(L)

For the Semigroup, see LeftAll.

See Also:

• Monoid
• RightAll
• Either

Field Summary

Fields

Modifier and Type	Field	Description
private static final LeftAll<?,?>	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LeftAll()

Method Summary

Modifier and Type	Method	Description
Monoid<Either<L,R>>	checkedApply(Monoid<L> lMonoid)	Invoke this function with the given argument, potentially throwing any Throwable.
static <L, R> LeftAll<L,R>	leftAll()
static <L, R> Monoid<Either<L,R>>	leftAll(Monoid<L> lMonoid)
static <L, R> Fn1<Either<L,R>,Either<L,R>>	leftAll(Monoid<L> lMonoid, Either<L,R> x)
static <L, R> Either<L,R>	leftAll(Monoid<L> lMonoid, Either<L,R> x, Either<L,R> y)

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, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, zip, zip

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

toBiFunction

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

apply, checkedApply, compose, contraMap, diMapL, discardR, flip, uncurry, widen

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

coerce

Methods inherited from interface com.jnape.palatable.lambda.functions.specialized.MonoidFactory

apply, apply

Methods inherited from interface com.jnape.palatable.lambda.functions.specialized.SemigroupFactory

checkedApply

Field Details

INSTANCE

private static final LeftAll<?,?> INSTANCE

Constructor Details

LeftAll

private LeftAll()

Method Details

checkedApply

public Monoid<Either<L,R>> checkedApply(Monoid<L> lMonoid)

Description copied from interface: Fn2

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

Specified by:

checkedApply in interface Fn1<L,R>

Specified by:

checkedApply in interface Fn2<Monoid<L>,Either<L,R>,Fn1<Either<L,R>,Either<L,R>>>

Specified by:

checkedApply in interface MonoidFactory<L,R>

Specified by:

checkedApply in interface SemigroupFactory<L,R>

Parameters:

lMonoid - the argument

Returns:

the result of the function application

leftAll

public static <L,
R> LeftAll<L,R> leftAll()

leftAll

public static <L,
R> Monoid<Either<L,R>> leftAll(Monoid<L> lMonoid)

leftAll

public static <L,
R> Fn1<Either<L,R>,Either<L,R>> leftAll(Monoid<L> lMonoid,
 Either<L,R> x)

leftAll

public static <L,
R> Either<L,R> leftAll(Monoid<L> lMonoid,
 Either<L,R> x,
 Either<L,R> y)