javascalautils

Class Some<T>

java.lang.Object

javascalautils.Some<T>

Type Parameters:

T - The type of the value represented by this instance

All Implemented Interfaces:

Serializable, Iterable<T>, Option<T>

public final class Some<T>
extends Object
implements Option<T>, Serializable

Represents an Option holding a value.

Since:

1.0

Author:

Peter Nerg

See Also:

Serialized Form

Field Summary

Fields inherited from interface javascalautils.Option

DEFAULT_NONE

Constructor Summary

Constructors

Constructor and Description
Some(T value) Creates an instance for the provided value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Returns true if the other object is Some containing a value that equals the value of this Some, else false.
boolean	exists(java.util.function.Predicate<T> p) Returns true if the predicate matches the value.
<R> Option<R>	flatMap(java.util.function.Function<T,Option<R>> function) Returns an Option consisting of the result of applying the given function to the current value.
T	get() Always returns the value.
T	getOrElse(java.util.function.Supplier<T> s) Always returns the value.
int	hashCode() Returns the hashCode based on the value of this Some.
<R> Option<R>	map(java.util.function.Function<T,R> f) Returns an Option consisting of the result of applying the given function to the current value.
Option<T>	orElse(java.util.function.Supplier<Option<T>> s) Always returns this.
java.util.stream.Stream<T>	stream() Returns a stream of size one containing the value.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javascalautils.Option

apply, asOptional, contains, count, empty, filter, filterNot, forall, isDefined, isEmpty, iterator, None, ofOptional, orNull

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Some

public Some(T value)

Creates an instance for the provided value.
Null objects are not allowed and will render an exception.

Parameters:

value - The value represented by this Some

Method Detail

exists

public boolean exists(java.util.function.Predicate<T> p)

Returns true if the predicate matches the value.

Specified by:

exists in interface Option<T>

Parameters:

p - The predicate

Returns:

If the predicate matches

get

public T get()

Always returns the value.

Specified by:

get in interface Option<T>

Returns:

The value of the Option

getOrElse

public T getOrElse(java.util.function.Supplier<T> s)

Always returns the value.

Specified by:

getOrElse in interface Option<T>

Parameters:

s - The supplier to use in case this is a None

Returns:

The value of the Option or the value provided by the supplier

map

public <R> Option<R> map(java.util.function.Function<T,R> f)

Returns an Option consisting of the result of applying the given function to the current value.

Specified by:

map in interface Option<T>

Type Parameters:

R - The type for the return value from the function

Parameters:

f - The function to use

Returns:

The Option containing the mapped value

flatMap

public <R> Option<R> flatMap(java.util.function.Function<T,Option<R>> function)

Returns an Option consisting of the result of applying the given function to the current value.

Specified by:

flatMap in interface Option<T>

Type Parameters:

R - The type for the return value from the function

Parameters:

function - The function to use

Returns:

The Option containing the mapped value

orElse

public Option<T> orElse(java.util.function.Supplier<Option<T>> s)

Always returns this.

Specified by:

orElse in interface Option<T>

Parameters:

s - The supplier to use in case of None

Returns:

This Option or the one provided by the supplier

stream

public java.util.stream.Stream<T> stream()

Returns a stream of size one containing the value.

Specified by:

stream in interface Option<T>

Returns:

The stream for the Option

equals

public boolean equals(Object other)

Returns true if the other object is Some containing a value that equals the value of this Some, else false.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns the hashCode based on the value of this Some.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object