Package com.identityworksllc.iiq.common

Class Either<L,R>

java.lang.Object

com.identityworksllc.iiq.common.Either<L,R>

Type Parameters:

L - The left object type

R - The right object type

public final class Either<L,R>
extends Object

A functional programming concept that will contain either the left object or the right object, but never both.

This can be used in a variety of functional data flows.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Either(L inputLeft, R inputRight)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
L	getLeft()	Returns the left object or throws a NoSuchElementException if this Either contains a right object
R	getRight()	Returns the right object or throws a NoSuchElementException if this Either contains a left object
int	hashCode()
boolean	hasLeft()
boolean	hasRight()
static <A> Either<A,?>	left(A l)	Creates an Either object containing the given object on the left.
static <B> Either<?,B>	right(B r)	Creates an Either object containing the given object on the right.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Either

protected Either(L inputLeft,
                 R inputRight)

Method Detail

left

public static <A> Either<A,?> left(A l)

Creates an Either object containing the given object on the left.

The type of the right object is undefined.

Type Parameters:

A - The left object type

Parameters:

l - The non-null left object

Returns:

The Either object

right

public static <B> Either<?,B> right(B r)

Creates an Either object containing the given object on the right.

The type of the left object is undefined.

Type Parameters:

B - The right object type

Parameters:

r - The non-null right object

Returns:

The Either object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

getLeft

public L getLeft()

Returns the left object or throws a NoSuchElementException if this Either contains a right object

Returns:

The left object

Throws:

NoSuchElementException - if this is a right Either

getRight

public R getRight()

Returns the right object or throws a NoSuchElementException if this Either contains a left object

Returns:

The right object

Throws:

NoSuchElementException - if this is a left Either

hasLeft

public boolean hasLeft()

Returns:

True if this Either has a left object

hasRight

public boolean hasRight()

Returns:

True if this Either has a right object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()