org.magicwerk.brownies.collections.helper

Class Option<T>

java.lang.Object

org.magicwerk.brownies.collections.helper.Option<T>

Type Parameters:

T - element type

public class Option<T>
extends java.lang.Object

Class Option stores a single value which may also be null. This is different from Optional which does not support null values.

Constructor Summary

Constructors

Constructor and Description
Option(T value) Construct option with specified value.

Method Summary

Modifier and Type	Method and Description
static <EE> Option<EE>	EMPTY()
boolean	equals(java.lang.Object obj)
T	getValue() Returns stored value.
T	getValueOrNull() Returns stored value of null if no value is stored.
int	hashCode()
boolean	hasValue() Returns true if a value is stored, false otherwise
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Option

public Option(T value)

Construct option with specified value.

Parameters:

value - value

Method Detail

EMPTY

public static <EE> Option<EE> EMPTY()

Returns:

unmodifiable empty instance

hasValue

public boolean hasValue()

Returns true if a value is stored, false otherwise

getValueOrNull

public T getValueOrNull()

Returns stored value of null if no value is stored. It is therefore not possible to distinguish between a null value stored or no value stored.

getValue

public T getValue()

Returns stored value. If no value is stored, an exception is thrown.

Returns:

stored value

Throws:

java.lang.IllegalArgumentException - if no value is stored

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object