net.markenwerk.commons.datastructures

Class Either<Left,Right>

java.lang.Object

net.markenwerk.commons.datastructures.Either<Left,Right>

Type Parameters:

Left - The type of a Left Either.

Right - The type of a Right Either.

Direct Known Subclasses:

Left, Right

public abstract class Either<Left,Right>
extends Object

An Either is one of two distinct simple immutable container class that holds a single value.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

See Also:

Left, Right

Method Summary

Modifier and Type	Method and Description
abstract Left	getLeft() The value of this Either, if it is a isLeft() Either.
abstract Right	getRight() The value of this Either, if it is a isRight() Either.
abstract boolean	isLeft() Returns whether this Either is a Left Either.
abstract boolean	isRight() Returns whether this Either is a Right Either.

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()

Returns whether this Either is a Left Either.

Returns:

If this Either is a Left Either.

getLeft

public abstract Left getLeft()
                      throws IllegalStateException

The value of this Either, if it is a isLeft() Either.

Returns:

The value of this Either.

Throws:

IllegalStateException - If this Either is not a isLeft() Either.

isRight

public abstract boolean isRight()

Returns whether this Either is a Right Either.

Returns:

If this Either is a Right Either.

getRight

public abstract Right getRight()
                        throws IllegalStateException

The value of this Either, if it is a isRight() Either.

Returns:

The value of this Either.

Throws:

IllegalStateException - If this Either is not a isRight() Either.