Package com.github.tonivade.purefun.type

Interface Option<T>

Type Parameters:

T - the wrapped value

All Superinterfaces:

Applicable<Option<?>,T>, Bindable<Option<?>,T>, Kind<Option<?>,T>, Mappable<Option<?>,T>, OptionOf<T>

All Known Implementing Classes:

Option.None, Option.Some

public sealed interface Option<T>
extends OptionOf<T>, Bindable<Option<?>,T>, Applicable<Option<?>,T>
permits Option.Some<T>, Option.None<T>

This type represents the presence or absence of a value, similar to Optional

There are two possible values:

• Option.none(): that represent the absence of a value
• Option.some(value): that represent the presence of a value

Note: it's serializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Option.None<T>
static final record	Option.Some<T>

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.core.Applicable

Applicable.Map2<F extends Applicable<F,?>,A,B>, Applicable.Map3<F extends Applicable<F,?>,A,B,C>, Applicable.Map4<F extends Applicable<F,?>,A,B,C,D>, Applicable.Map5<F extends Applicable<F,?>,A,B,C,D,E>

Method Summary

Modifier and Type	Method	Description
default <R> Option<R>	ap(Kind<Option<?>,? extends Function1<? super T,? extends R>> apply)
default Option<T>	filter(Matcher1<? super T> matcher)
default Option<T>	filterNot(Matcher1<? super T> matcher)
default <R> Option<R>	flatMap(Function1<? super T,? extends Kind<Option<?>,? extends R>> map)
default <U> U	fold(Producer<? extends U> orElse, Function1<? super T,? extends U> mapper)
static <T> Option<T>	from(Optional<T> optional)
default T	getOrElse(Producer<? extends T> producer)
default T	getOrElse(T value)
default T	getOrElseNull()
default T	getOrElseThrow()
default <X extends Throwable> T	getOrElseThrow(Producer<? extends X> producer)
default Option<T>	ifEmpty(Runnable run)
default Option<T>	ifPresent(Consumer1<? super T> consumer)
boolean	isEmpty()
boolean	isPresent()
default <R> Option<R>	map(Function1<? super T,? extends R> mapper)
static <A, B, Z> Option<Z>	map2(Option<A> optionA, Option<B> optionB, Function2<? super A,? super B,? extends Z> mapper)
static <T> Option<T>	none()
static <T> Option<T>	of(Producer<? extends T> producer)
static <T> Option<T>	of(T value)
default Option<T>	or(Producer<Kind<Option<?>,T>> orElse)
default Option<T>	orElse(Kind<Option<?>,T> orElse)
default Sequence<T>	sequence()
static <T> Option<T>	some(T value)
default Stream<T>	stream()
default Either<Throwable,T>	toEither()
default Optional<T>	toOptional()
default Try<T>	toTry()

Methods inherited from interface com.github.tonivade.purefun.core.Applicable

zip, zipLeft, zipRight, zipWith

Methods inherited from interface com.github.tonivade.purefun.core.Bindable

andThen

Methods inherited from interface com.github.tonivade.purefun.Kind

fix, kind

Method Details

some

static <T> Option<T> some(T value)

none

static <T> Option<T> none()

of

static <T> Option<T> of(@Nullable
 T value)

of

static <T> Option<T> of(Producer<? extends T> producer)

from

static <T> Option<T> from(Optional<T> optional)

map2

static <A,
B,
Z> Option<Z> map2(Option<A> optionA,
 Option<B> optionB,
 Function2<? super A,? super B,? extends Z> mapper)

isPresent

boolean isPresent()

isEmpty

boolean isEmpty()

map

default <R> Option<R> map(Function1<? super T,? extends R> mapper)

Specified by:

map in interface Applicable<Option<?>,T>

Specified by:

map in interface Bindable<Option<?>,T>

Specified by:

map in interface Mappable<Option<?>,T>

ap

default <R> Option<R> ap(Kind<Option<?>,? extends Function1<? super T,? extends R>> apply)

Specified by:

ap in interface Applicable<Option<?>,T>

flatMap

default <R> Option<R> flatMap(Function1<? super T,? extends Kind<Option<?>,? extends R>> map)

Specified by:

flatMap in interface Bindable<Option<?>,T>

ifPresent

default Option<T> ifPresent(Consumer1<? super T> consumer)

ifEmpty

default Option<T> ifEmpty(Runnable run)

filter

default Option<T> filter(Matcher1<? super T> matcher)

filterNot

default Option<T> filterNot(Matcher1<? super T> matcher)

or

default Option<T> or(Producer<Kind<Option<?>,T>> orElse)

orElse

default Option<T> orElse(Kind<Option<?>,T> orElse)

getOrElse

default T getOrElse(T value)

getOrElseNull

@Nullable
default T getOrElseNull()

getOrElse

default T getOrElse(Producer<? extends T> producer)

getOrElseThrow

default T getOrElseThrow()

getOrElseThrow

default <X extends Throwable> T getOrElseThrow(Producer<? extends X> producer)
                                        throws X

Throws:

X

fold

default <U> U fold(Producer<? extends U> orElse,
 Function1<? super T,? extends U> mapper)

stream

default Stream<T> stream()

sequence

default Sequence<T> sequence()

toOptional

default Optional<T> toOptional()

toEither

default Either<Throwable,T> toEither()

toTry

default Try<T> toTry()