Class Option.Some<T>

java.lang.Object

io.vavr.control.Option.Some<T>

Type Parameters:

T - The type of the optional value.

All Implemented Interfaces:

Option<T>, Value<T>, Serializable, Iterable<T>

Enclosing interface:

Option<T>

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

Some represents a defined Option. It contains a value which may be null. However, to create an Option containing null, new Some(null) has to be called. In all other cases Option.of(Object) is sufficient.

Author:

Daniel Dietrich

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Option

Option.None<T>, Option.Some<T>

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Clarifies that values have a proper equals() method implemented.
T	get()	Gets the value if this is a Some or throws if this is a None.
int	hashCode()	Clarifies that values have a proper hashCode() method implemented.
boolean	isEmpty()	Returns true, if this is None, otherwise false, if this is Some.
String	stringPrefix()	Returns the name of this Value type, which is used by toString().
String	toString()	Clarifies that values have a proper toString() method implemented.

Methods inherited from class Object

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

Methods inherited from interface Option

collect, filter, flatMap, fold, getOrElse, getOrElse, getOrElseThrow, isAsync, isDefined, isLazy, isSingleValued, iterator, map, onEmpty, orElse, orElse, peek, transform

Methods inherited from interface Value

collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElseTry, getOrNull, out, out, spliterator, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector

Method Details

get

public T get()

Description copied from interface: Option

Gets the value if this is a Some or throws if this is a None.

Specified by:

get in interface Option<T>

Specified by:

get in interface Value<T>

Returns:

the value

isEmpty

public boolean isEmpty()

Description copied from interface: Option

Returns true, if this is None, otherwise false, if this is Some.

Specified by:

isEmpty in interface Option<T>

Specified by:

isEmpty in interface Value<T>

Returns:

true, if this Option is empty, false otherwise

equals

public boolean equals(Object obj)

Description copied from interface: Value

Clarifies that values have a proper equals() method implemented.

See Object.equals(Object).

Specified by:

equals in interface Option<T>

Specified by:

equals in interface Value<T>

Overrides:

equals in class Object

Parameters:

obj - An object

Returns:

true, if this equals o, false otherwise

hashCode

public int hashCode()

Description copied from interface: Value

Clarifies that values have a proper hashCode() method implemented.

See Object.hashCode().

Specified by:

hashCode in interface Option<T>

Specified by:

hashCode in interface Value<T>

Overrides:

hashCode in class Object

Returns:

The hashcode of this object

stringPrefix

public String stringPrefix()

Description copied from interface: Value

Returns the name of this Value type, which is used by toString().

Specified by:

stringPrefix in interface Value<T>

Returns:

This type name.

toString

public String toString()

Description copied from interface: Value

Clarifies that values have a proper toString() method implemented.

See Object.toString().

Specified by:

toString in interface Option<T>

Specified by:

toString in interface Value<T>

Overrides:

toString in class Object

Returns:

A String representation of this object