net.markenwerk.commons.datastructures

Class Left<Payload,Right>

java.lang.Object

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

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

Type Parameters:

Payload - The type of a Left Either.

Right - The type of a Right Either.

public final class Left<Payload,Right>
extends Either<Payload,Right>

An Left 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)

Constructor Summary

Constructors

Constructor and Description
Left(Payload value) Creates a new Left.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
Payload	getLeft() The value of this Either, if it is a Either.isLeft() Either.
Right	getRight() The value of this Either, if it is a Either.isRight() Either.
int	hashCode()
boolean	isLeft() Returns whether this Either is a Left Either.
boolean	isRight() Returns whether this Either is a Right Either.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Left

public Left(Payload value)

Creates a new Left.

Parameters:

value - The Value to be used.

Method Detail

isLeft

public boolean isLeft()

Description copied from class: Either

Returns whether this Either is a Left Either.

Specified by:

isLeft in class Either<Payload,Right>

Returns:

If this Either is a Left Either.

getLeft

public Payload getLeft()

Description copied from class: Either

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

Specified by:

getLeft in class Either<Payload,Right>

Returns:

The value of this Either.

isRight

public boolean isRight()

Description copied from class: Either

Returns whether this Either is a Right Either.

Specified by:

isRight in class Either<Payload,Right>

Returns:

If this Either is a Right Either.

getRight

public Right getRight()
               throws IllegalStateException

Description copied from class: Either

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

Specified by:

getRight in class Either<Payload,Right>

Returns:

The value of this Either.

Throws:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object