com.github.tonivade.purefun.type

Interface Option<T>

All Superinterfaces:

Filterable<T>, FlatMap1<Option.µ,T>, Higher1<Option.µ,T>, Holder<T>, Kind, Mappable<Option.µ,T>

All Known Implementing Classes:

Option.None, Option.Some

public interface Option<T>
extends FlatMap1<Option.µ,T>, Filterable<T>, Holder<T>

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
default Option<T>	filter(Matcher1<T> matcher)
default <R> Option<R>	flatMap(Function1<T,? extends Higher1<Option.µ,R>> map)
default <V> Option<V>	flatten()
default <U> U	fold(Producer<U> orElse, Function1<T,U> mapper)
static <T> Option<T>	from(java.util.Optional<T> optional)
default Option<T>	ifEmpty(java.lang.Runnable run)
default Option<T>	ifPresent(Consumer1<T> consumer)
boolean	isEmpty()
boolean	isPresent()
default <R> Option<R>	map(Function1<T,R> mapper)
com.github.tonivade.purefun.type.OptionModule	module()
static Monad<Option.µ>	monad()
static <T> Option<T>	narrowK(Higher1<Option.µ,T> hkt)
static <T> Option<T>	none()
static <T> Option<T>	of(Producer<T> producer)
default T	orElse(Producer<T> producer)
default T	orElse(T value)
default <X extends java.lang.Throwable> T	orElseThrow(Producer<X> producer)
default Sequence<T>	sequence()
static <T> Option<T>	some(T value)
default java.util.stream.Stream<T>	stream()
default java.util.Optional<T>	toOptional()

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

get

Method Detail

some

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

none

static <T> Option<T> none()

narrowK

static <T> Option<T> narrowK(Higher1<Option.µ,T> hkt)

of

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

from

static <T> Option<T> from(java.util.Optional<T> optional)

isPresent

boolean isPresent()

isEmpty

boolean isEmpty()

map

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

Specified by:

map in interface Mappable<Option.µ,T>

flatMap

default <R> Option<R> flatMap(Function1<T,? extends Higher1<Option.µ,R>> map)

Specified by:

flatMap in interface FlatMap1<Option.µ,T>

ifPresent

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

ifEmpty

default Option<T> ifEmpty(java.lang.Runnable run)

filter

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

Specified by:

filter in interface Filterable<T>

orElse

default T orElse(T value)

orElse

default T orElse(Producer<T> producer)

orElseThrow

default <X extends java.lang.Throwable> T orElseThrow(Producer<X> producer)
                                               throws X extends java.lang.Throwable

Throws:

X extends java.lang.Throwable

fold

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

stream

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

sequence

default Sequence<T> sequence()

toOptional

default java.util.Optional<T> toOptional()

flatten

default <V> Option<V> flatten()

Specified by:

flatten in interface Holder<T>

monad

static Monad<Option.µ> monad()

module

com.github.tonivade.purefun.type.OptionModule module()