no.finn.lambdacompanion

Class Either.LeftProjection<L,R>

java.lang.Object

no.finn.lambdacompanion.Either.LeftProjection<L,R>

Type Parameters:

L - the type of the left side of the resulting Right[L,R]

R - the type of the right side of the resulting Right[L,R]

Enclosing class:

Either<L,R>

public static final class Either.LeftProjection<L,R>
extends Object

Projects an Either into a Left.

Method Summary

Modifier and Type	Method and Description
Optional<Either<L,R>>	filter(Predicate<L> predicate)
void	forEach(Consumer<? super L> consumer) Executes the given side-effecting function if this is a Left
<X> Either<X,R>	map(Function<L,X> mapper) The given function is applied if this is a Left.
L	orElse(L other)
L	orElseGet(Supplier<L> supplier)
<X extends Exception> L	orElseThrow(Function<R,X> exceptionMapper)
Either<L,R>	peek(Consumer<? super L> consumer) Executes the given side-effecting function if this is a Left and returns this Either
Optional<L>	toOptional()

Methods inherited from class java.lang.Object

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

Method Detail

map

public <X> Either<X,R> map(Function<L,X> mapper)

The given function is applied if this is a Left.

Type Parameters:

X - the resulting type of applying the function

Parameters:

mapper - the function to apply if this is a Left

Returns:

the results of applying the function

filter

public Optional<Either<L,R>> filter(Predicate<L> predicate)

Parameters:

predicate - the predicate

Returns:

Optional.Absent if this is a Right or if the given predicate p does not hold for the left value, otherwise, returns a Left.

peek

public Either<L,R> peek(Consumer<? super L> consumer)

Executes the given side-effecting function if this is a Left and returns this Either

Parameters:

consumer - the consumer

Returns:

the Either within this projection

forEach

public void forEach(Consumer<? super L> consumer)

Executes the given side-effecting function if this is a Left

Parameters:

consumer - the consumer

toOptional

public Optional<L> toOptional()

Returns:

an Optional containing the Left value if it exists or an Optional.Absent if this is a Right.

orElse

public L orElse(L other)

Parameters:

other - other

Returns:

the value from this Left or the given argument if this is a Right.

orElseGet

public L orElseGet(Supplier<L> supplier)

Parameters:

supplier - supplier

Returns:

the value from this Left or the supplied argument if this is a Right.

orElseThrow

public <X extends Exception> L orElseThrow(Function<R,X> exceptionMapper)
                                    throws X extends Exception

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionMapper - The function which will return the exception to be thrown

Returns:

the value from this Left or throw an exception to be created by the provided function if this is a Right.

Throws:

X - if this is a Right

NullPointerException - if no value is present and exceptionSupplier is null

X extends Exception