net.ninjacat.smooth.utils

Class Either<F,S>

java.lang.Object

net.ninjacat.smooth.utils.Either<F,S>

Type Parameters:

F - type of first value

S - type of second value

Direct Known Subclasses:

Either.First, Either.Second

public abstract class Either<F,S>
extends Object

Selection of two values. This container can contain either the first or the second value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Either.First<F,S> Container that only has the first value.
static class	Either.Second<F,S> Container that only has the second value.

Method Summary

Modifier and Type	Method and Description
static <F,S> Either<F,S>	first(F val) Creates an new Either instance with the first value.
abstract F	getFirst() Retrieve the first value.
abstract S	getSecond() Retrieve the second value.
abstract boolean	hasFirst() Checks if this container has the first value.
abstract boolean	hasSecond() Checks if this container has the second value.
static <F,S> Either<F,S>	second(S val) Creates an new Either instance with the second value.

Methods inherited from class java.lang.Object

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

Method Detail

first

public static <F,S> Either<F,S> first(F val)

Creates an new Either instance with the first value.

Type Parameters:

F - Type of the first value.

S - Type of the second value.

Parameters:

val - The first value.

Returns:

Either holding the first value.

second

public static <F,S> Either<F,S> second(S val)

Creates an new Either instance with the second value.

Type Parameters:

F - Type of the first value.

S - Type of the second value.

Parameters:

val - The second value.

Returns:

Either holding the second value.

hasFirst

public abstract boolean hasFirst()

Checks if this container has the first value.

Returns:

true if this is the first value.

hasSecond

public abstract boolean hasSecond()

Checks if this container has the second value.

Returns:

true if this is the second value.

getFirst

public abstract F getFirst()

Retrieve the first value. Will throw exception if in this instance has no first value.

Returns:

The first value.

Throws:

IllegalStateException - if this instance has no first value.

getSecond

public abstract S getSecond()

Retrieve the second value. Will throw exception if in this instance has no second value.

Returns:

The second value.

Throws:

IllegalStateException - if this instance has no second value.