com.diffplug.common.base

Class Either<L,R>

java.lang.Object

com.diffplug.common.base.Either<L,R>

public abstract class Either<L,R>
extends Object

A minimal implementation of Either.

Method Summary

Modifier and Type	Method and Description
void	accept(Consumer<? super L> left, Consumer<? super R> right) Accepts either the left or the right consumer as appropriate.
void	acceptBoth(Consumer<? super L> left, Consumer<? super R> right, L defaultLeft, R defaultRight) Accepts both the left and right consumers, using the default values to set the empty side.
Optional<L>	asOptionalLeft() Returns the left side as an Optional.
Optional<R>	asOptionalRight() Returns the right side as an Optional.
static <L,R> Either<L,R>	create(L l, R r) Creates a left or right, depending on which element is non-null.
static <L,R> Either<L,R>	createLeft(L l) Creates an instance of Left.
static <L,R> Either<L,R>	createRight(R r) Creates an instance of Right.
<T> T	fold(Function<? super L,? extends T> left, Function<? super R,? extends T> right) Applies either the left or the right function as appropriate.
abstract L	getLeft() Returns the left side.
abstract R	getRight() Returns the right side.
void	ifLeft(Consumer<? super L> consumer) Performs the given action if this is a Left.
void	ifRight(Consumer<? super R> consumer) Performs the given action if this is a Right.
abstract boolean	isLeft() True if it’s left.
boolean	isRight() True if it’s right.
<T> Either<T,R>	mapLeft(Function<? super L,? extends T> mapper)
<T> Either<L,T>	mapRight(Function<? super R,? extends T> mapper)

Methods inherited from class java.lang.Object

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

Method Detail

isLeft

public abstract boolean isLeft()

True if it’s left.

isRight

public final boolean isRight()

True if it’s right.

getLeft

public abstract L getLeft()

Returns the left side. Throws an exception if it’s really a Right.

getRight

public abstract R getRight()

Returns the right side. Throws an exception if it’s really a Left.

ifLeft

public final void ifLeft(Consumer<? super L> consumer)

Performs the given action if this is a Left.

ifRight

public final void ifRight(Consumer<? super R> consumer)

Performs the given action if this is a Right.

asOptionalLeft

public final Optional<L> asOptionalLeft()

Returns the left side as an Optional.

asOptionalRight

public final Optional<R> asOptionalRight()

Returns the right side as an Optional.

fold

public final <T> T fold(Function<? super L,? extends T> left,
                        Function<? super R,? extends T> right)

Applies either the left or the right function as appropriate.

accept

public final void accept(Consumer<? super L> left,
                         Consumer<? super R> right)

Accepts either the left or the right consumer as appropriate.

mapLeft

public final <T> Either<T,R> mapLeft(Function<? super L,? extends T> mapper)

mapRight

public final <T> Either<L,T> mapRight(Function<? super R,? extends T> mapper)

acceptBoth

public final void acceptBoth(Consumer<? super L> left,
                             Consumer<? super R> right,
                             @Nullable
                             L defaultLeft,
                             @Nullable
                             R defaultRight)

Accepts both the left and right consumers, using the default values to set the empty side.

create

public static <L,R> Either<L,R> create(@Nullable
                                       L l,
                                       @Nullable
                                       R r)

Creates a left or right, depending on which element is non-null. Precisely one element should be non-null.

createLeft

public static <L,R> Either<L,R> createLeft(L l)

Creates an instance of Left.

createRight

public static <L,R> Either<L,R> createRight(R r)

Creates an instance of Right.