org.organicdesign.fp

Interface Option<T>

Type Parameters:

T -

All Superinterfaces:

Serializable

All Known Implementing Classes:

Option.None, Option.Some

public interface Option<T>
extends Serializable

Indicates presence or absence of a value (null is a valid, present value) or end-of-stream. This is NOT a type-safe null.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Option.None<T> Represents the absence of a value
static class	Option.Some<T> Represents the presence of a value, even if that value is null.

Field Summary

Fields

Modifier and Type	Field and Description
static Option	NONE None is a singleton and this is its only instance.

Method Summary

Modifier and Type	Method and Description
T	get() Return the value wrapped in this Option.
T	getOrElse(T t) If this is Some, return the value wrapped in this Option.
boolean	isSome() Is this Some?
static <T> Option<T>	none() Calling this instead of referring to NONE directly can make the type infrencer happy.
static <T> Option<T>	of(T t) Public static factory method for contructing Options.
<U> U	patMat(Function1<T,U> has, Function0<U> hasNot) Pass in a function to execute if its Some and another to execute if its None.
static <T> Option<T>	someOrNullNoneOf(T t) Construct an option, but if t is null, make it None instead of Some.
<U> Option<U>	then(Function1<T,Option<U>> f) If this is Some, Apply the given function, else return None.

Field Detail

NONE

static final Option NONE

None is a singleton and this is its only instance.

Method Detail

get

T get()

Return the value wrapped in this Option. Only safe to call this on Some.

getOrElse

T getOrElse(T t)

If this is Some, return the value wrapped in this Option. Otherwise, return the given value.

then

<U> Option<U> then(Function1<T,Option<U>> f)

If this is Some, Apply the given function, else return None. Use this to chain options together, failing fast at the first none() or continuing through as many operations that return some as possible.

isSome

boolean isSome()

Is this Some?

patMat

<U> U patMat(Function1<T,U> has,
             Function0<U> hasNot)

Pass in a function to execute if its Some and another to execute if its None.

none

static <T> Option<T> none()

Calling this instead of referring to NONE directly can make the type infrencer happy.

of

static <T> Option<T> of(T t)

Public static factory method for contructing Options.

someOrNullNoneOf

static <T> Option<T> someOrNullNoneOf(T t)

Construct an option, but if t is null, make it None instead of Some.