com.io7m.jfunctional

Class Some<T>

java.lang.Object

com.io7m.jfunctional.Some<T>

Type Parameters:

T - The type of values.

All Implemented Interfaces:

OptionType<T>, Serializable

@EqualityStructural
public final class Some<T>
extends Object
implements OptionType<T>

A value.

See Also:

OptionType, Serialized Form

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	equals(Object obj)
T	get()
int	hashCode()
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).
static <T> Some<T>	some(T x) Produce a new Some value.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

some

public static <T> Some<T> some(T x)

Produce a new Some value.

Type Parameters:

T - The type of values

Parameters:

x - The value

Returns:

A new Some value

Since:

1.3.0

map_

public void map_(ProcedureType<T> p)

Description copied from interface: OptionType

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

Specified by:

map_ in interface OptionType<T>

Parameters:

p - The procedure

mapPartial_

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

Description copied from interface: OptionType

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

Specified by:

mapPartial_ in interface OptionType<T>

Type Parameters:

E - The type of exceptions thrown by the procedure.

Parameters:

p - The procedure

Throws:

E - Propagated from p

E extends Throwable

accept

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

Description copied from interface: OptionType

Accept a visitor.

Specified by:

accept in interface OptionType<T>

Type Parameters:

U - The type of values returned by the visitor.

Parameters:

v - The visitor

Returns:

The value returned by the visitor.

acceptPartial

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

Description copied from interface: OptionType

Accept a partial visitor.

Specified by:

acceptPartial in interface OptionType<T>

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

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

get

public T get()

Returns:

The value contained within.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

map

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

Description copied from interface: OptionType

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

Specified by:

map in interface OptionType<T>

Type Parameters:

U - The type of returned values.

Parameters:

f - The map function.

Returns:

An optional value of type U.

mapPartial

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

Description copied from interface: OptionType

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

Specified by:

mapPartial in interface OptionType<T>

Type Parameters:

U - The type of returned values.

E - The type of exceptions raised.

Parameters:

f - The map function.

Returns:

An optional value of type U.

Throws:

E - If f throws E.

E extends Throwable

toString

public String toString()

Overrides:

toString in class Object

isNone

public boolean isNone()

Specified by:

isNone in interface OptionType<T>

Returns:

true if the current value is None.

isSome

public boolean isSome()

Specified by:

isSome in interface OptionType<T>

Returns:

true if the current value is Some.