de.scravy.either

Class Either<L,R>

java.lang.Object

de.scravy.either.Either<L,R>

Type Parameters:

L - The left type.

R - The right type.

Direct Known Subclasses:

Either.Left, Either.Right

public abstract class Either<L,R>
extends Object

The Either type (an explicit sum type for Java).

Since:

1.0.0

Author:

Julian Fleischer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Either.Left<L,R> The Left type.
static class	Either.Right<L,R> The Right type.

Method Summary

Methods

Modifier and Type	Method and Description
L	getLeft() Returns the left value (if this is a left value).
R	getRight() Returns the right value (if this is a right value).
boolean	isLeft() Checks whether this Either is a left value.
boolean	isRight() Checks whether this Either is a right value.
static <L,R> Either<L,R>	left(L value) Creates a left value.
static <L,R> Either<L,R>	left(L value, Class<R> rightType) Creates a left value.
static <L,R> Either<L,R>	right(R value) Creates a right value.
static <L,R> Either<L,R>	right(R value, Class<L> leftType) Creates a right value.

Methods inherited from class java.lang.Object

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

Method Detail

left

public static <L,R> Either<L,R> left(L value)

Creates a left value.

Type Parameters:

L - The left type.

R - The right type.

Parameters:

value - The value to encapsulate as left.

Returns:

An either value!

Since:

1.0.0

left

public static <L,R> Either<L,R> left(L value,
                     Class<R> rightType)

Creates a left value.

Parameters:

value - The value to encapsulate as left.

rightType - The right type (to aid in type inference)

Returns:

An either value!

Since:

1.1.0

right

public static <L,R> Either<L,R> right(R value)

Creates a right value.

Type Parameters:

L - The left type.

R - The right type.

Parameters:

value - The value to encapsulate as left.

Returns:

An either value!

Since:

1.0.0

right

public static <L,R> Either<L,R> right(R value,
                      Class<L> leftType)

Creates a right value.

Parameters:

value - The value to encapsulate as right.

rightType - The right type (to aid in type inference)

Returns:

An either value!

Since:

1.1.0

isLeft

public boolean isLeft()

Checks whether this Either is a left value.

Returns:

Whether this is a Left value or not.

Since:

1.0.0

isRight

public boolean isRight()

Checks whether this Either is a right value.

Returns:

Whether this is a Right value or not.

Since:

1.0.0

getLeft

public L getLeft()

Returns the left value (if this is a left value).

Returns:

The unwrapped left value.

Throws:

UnsupportedOperationException - if this is not actually a Either.Left.

Since:

1.0.0

getRight

public R getRight()

Returns the right value (if this is a right value).

Returns:

The unwrapped right value.

Throws:

UnsupportedOperationException - if this is not actually a Either.Right.

Since:

1.0.0