no.finn.lambdacompanion

Class Either.RightProjection<L,R>

java.lang.Object

no.finn.lambdacompanion.Either.RightProjection<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.RightProjection<L,R>
extends Object

Projects an Either into a Right.

Method Summary

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

The given function is applied if this is a Right.

Type Parameters:

X - the resulting type of applying the function

Parameters:

mapper - the function to apply if this is a Right

Returns:

the results of applying the function

filter

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

Parameters:

predicate - predicate

Returns:

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

peek

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

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

Parameters:

consumer - consumer

Returns:

the Either within this projection

forEach

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

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

Parameters:

consumer - consumer

toOptional

public Optional<R> toOptional()

Returns:

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

orElse

public R orElse(R other)

Parameters:

other - other

Returns:

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

orElseGet

public R orElseGet(Supplier<R> supplier)

Parameters:

supplier - supplier

Returns:

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

orElseThrow

public <X extends Exception> R orElseThrow(Function<L,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 Right or throw an exception to be created by the provided function if this is a Left.

Throws:

X - if this is a left

NullPointerException - if no value is present and exceptionSupplier is null

X extends Exception