com.io7m.jfunctional

Interface OptionType<T>

Type Parameters:

T - The type of values.

All Superinterfaces:

Serializable

All Known Implementing Classes:

None, Some

@EqualityStructural
public interface OptionType<T>
extends Serializable

The type of optional values.

Method Summary

Modifier and Type	Method and Description
<U> U	accept(OptionVisitorType<T,U> v) Accept a visitor.
<U,E extends Throwable> U	acceptPartial(OptionPartialVisitorType<T,U,E> v) Accept a partial visitor.
boolean	isNone()
boolean	isSome()
void	map_(ProcedureType<T> p) If this value is Some(x), evaluate p(x).
<U> OptionType<U>	map(FunctionType<T,U> f) If this value is Some(x), return Option.of(Object) with f(x).
<E extends Throwable> void	mapPartial_(PartialProcedureType<T,E> p) If this value is Some(x), evaluate p(x).
<U,E extends Throwable> OptionType<U>	mapPartial(PartialFunctionType<T,U,E> f) If this value is Some(x), return Option.of(Object) with f(x).

Method Detail

map_

void map_(ProcedureType<T> p)

If this value is Some(x), evaluate p(x). Otherwise, do nothing.

Parameters:

p - The procedure

Since:

1.1.0

mapPartial_

<E extends Throwable> void mapPartial_(PartialProcedureType<T,E> p)
                                throws E extends Throwable

If this value is Some(x), evaluate p(x). Otherwise, do nothing.

Type Parameters:

E - The type of exceptions thrown by the procedure.

Parameters:

p - The procedure

Throws:

E - Propagated from p

E extends Throwable

Since:

1.1.0

accept

<U> U accept(OptionVisitorType<T,U> v)

Accept a visitor.

Type Parameters:

U - The type of values returned by the visitor.

Parameters:

v - The visitor

Returns:

The value returned by the visitor.

acceptPartial

<U,E extends Throwable> U acceptPartial(OptionPartialVisitorType<T,U,E> v)
                                 throws E extends Throwable

Accept a partial visitor.

Type Parameters:

U - The type of values returned by the visitor.

E - The type of exceptions thrown by the visitor.

Parameters:

v - The visitor

Returns:

The value returned by the visitor.

Throws:

E - If the visitor throws E.

E extends Throwable

isNone

boolean isNone()

Returns:

true if the current value is None.

isSome

boolean isSome()

Returns:

true if the current value is Some.

map

<U> OptionType<U> map(FunctionType<T,U> f)

If this value is Some(x), return Option.of(Object) with f(x). Otherwise, return None.

Type Parameters:

U - The type of returned values.

Parameters:

f - The map function.

Returns:

An optional value of type U.

mapPartial

<U,E extends Throwable> OptionType<U> mapPartial(PartialFunctionType<T,U,E> f)
                                          throws E extends Throwable

If this value is Some(x), return Option.of(Object) with f(x). Otherwise, return None.

Type Parameters:

E - The type of exceptions raised.

U - The type of returned values.

Parameters:

f - The map function.

Returns:

An optional value of type U.

Throws:

E - If f throws E.

E extends Throwable