net.markenwerk.commons.datastructures

Class Right<Left,Payload>

java.lang.Object

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

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

Type Parameters:

Left - The type of a Left Either.

Payload - The type of a Right Either.

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

An Right 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
Right(Payload value) Creates a new Right.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
Left	getLeft() The value of this Either, if it is a Either.isLeft() Either.
Payload	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

Right

public Right(Payload value)

Creates a new Right.

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<Left,Payload>

Returns:

If this Either is a Left Either.

getLeft

public Left getLeft()
             throws IllegalStateException

Description copied from class: Either

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

Specified by:

getLeft in class Either<Left,Payload>

Returns:

The value of this Either.

Throws:

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

isRight

public boolean isRight()

Description copied from class: Either

Returns whether this Either is a Right Either.

Specified by:

isRight in class Either<Left,Payload>

Returns:

If this Either is a Right Either.

getRight

public Payload getRight()

Description copied from class: Either

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

Specified by:

getRight in class Either<Left,Payload>

Returns:

The value of this 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