Package panda.std

Class Option<T>

java.lang.Object

panda.std.Option<T>

All Implemented Interfaces:

Serializable, Iterable<T>

public class Option<T>
extends Object
implements Iterable<T>, Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected T	value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Option(T value)

Method Summary

Modifier and Type	Method	Description
<R> Option<Pair<T,R>>	associateWith(Function<T,Option<R>> supplier)
static <T, E extends Throwable> Option<T>	attempt(Class<E> throwableType, ThrowingSupplier<T,E> supplier)	Deprecated.
static Option<Blank>	blank()
boolean	contentEquals(@Nullable Object to)
boolean	equals(@Nullable Object to)
Option<T>	filter(Predicate<T> predicate)
Option<T>	filterNot(Predicate<T> predicate)
<R> Option<R>	flatMap(Function<T,Option<R>> function)
static <T> Option<T>	flatWhen(boolean condition, Supplier<Option<T>> supplier)
static <T> Option<T>	flatWhen(boolean condition, Option<T> value)
T	get()
T	getOrNull()	Deprecated.
int	hashCode()
<S> Option<S>	is(Class<S> type)
boolean	is(Predicate<T> predicate)
boolean	isDefined()
boolean	isEmpty()
Option<T>	isNot(Class<?> type)
boolean	isNot(Predicate<T> predicate)
boolean	isPresent()
Iterator<T>	iterator()
<R> Option<R>	map(Function<T,R> function)
<R> Option<R>	match(List<? extends Case<T,R>> cases)
final <R> Option<R>	match(Case<T,R>... cases)
static <T> Option<T>	none()
static <T> Option<@NotNull T>	of(T value)
static <T> Option<T>	ofOptional(Optional<T> optional)
Option<T>	onEmpty(Runnable runnable)
Option<T>	orElse(Supplier<Option<T>> supplier)
Option<T>	orElse(Option<T> value)
Option<T>	orElse(T value)
T	orElseGet(Supplier<T> supplier)
T	orElseGet(T elseValue)
Option<T>	orElseSupply(Supplier<T> supplier)
T	orNull()
<E extends Throwable> T	orThrow(Supplier<E> exceptionSupplier)
Option<T>	peek(Consumer<T> consumer)
Option<T>	peekIf(Predicate<T> predicate, Consumer<T> consumer)
Option<T>	peekIfNot(Predicate<T> predicate, Consumer<T> consumer)
static Option<Blank>	runThrowing(ThrowingRunnable<Exception> runnable)
static <T, E extends Throwable> Option<T>	supplyThrowing(Class<E> throwableType, ThrowingSupplier<T,E> supplier)
static <T> Option<T>	supplyThrowing(ThrowingSupplier<T,Exception> supplier)
Stream<T>	toJavaStream()
Optional<T>	toOptional()
<E> Result<T,E>	toResult(E orElse)
<E> Result<T,E>	toResult(Supplier<E> orElse)
PandaStream<T>	toStream()
<R> PandaStream<R>	toStream(Function<T,Stream<R>> function)
String	toString()
static <T> Option<T>	when(boolean condition, Supplier<@Nullable T> valueSupplier)
static <T> Option<T>	when(boolean condition, T value)
static <T> Option<Completable<T>>	withCompleted(T value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

value

@Nullable
protected T value

Constructor Details

Option

protected Option(@Nullable
 T value)

Method Details

none

public static <T> Option<T> none()

blank

public static Option<Blank> blank()

of

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

ofOptional

public static <T> Option<T> ofOptional(Optional<T> optional)

withCompleted

public static <T> Option<Completable<T>> withCompleted(T value)

when

public static <T> Option<T> when(boolean condition,
 @Nullable
 T value)

when

public static <T> Option<T> when(boolean condition,
 Supplier<@Nullable T> valueSupplier)

flatWhen

public static <T> Option<T> flatWhen(boolean condition,
 Option<T> value)

flatWhen

public static <T> Option<T> flatWhen(boolean condition,
 Supplier<Option<T>> supplier)

attempt

@Deprecated
public static <T,
E extends Throwable> Option<T> attempt(Class<E> throwableType,
 ThrowingSupplier<T,E> supplier)
                                                 throws AttemptFailedException

Deprecated.

Throws:

AttemptFailedException

runThrowing

public static Option<Blank> runThrowing(ThrowingRunnable<Exception> runnable)
                                 throws AttemptFailedException

Throws:

AttemptFailedException

supplyThrowing

public static <T> Option<T> supplyThrowing(ThrowingSupplier<T,Exception> supplier)
                                    throws AttemptFailedException

Throws:

AttemptFailedException

supplyThrowing

public static <T,
E extends Throwable> Option<T> supplyThrowing(Class<E> throwableType,
 ThrowingSupplier<T,E> supplier)
                                                        throws AttemptFailedException

Throws:

AttemptFailedException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 @Nullable Object to)

Overrides:

equals in class Object

contentEquals

public boolean contentEquals(@Nullable
 @Nullable Object to)

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

filter

public Option<T> filter(Predicate<T> predicate)

filterNot

public Option<T> filterNot(Predicate<T> predicate)

map

public <R> Option<R> map(Function<T,R> function)

flatMap

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

associateWith

public <R> Option<Pair<T,R>> associateWith(Function<T,Option<R>> supplier)

match

@SafeVarargs
public final <R> Option<R> match(Case<T,R>... cases)

match

public <R> Option<R> match(List<? extends Case<T,R>> cases)

is

public boolean is(Predicate<T> predicate)

isNot

public boolean isNot(Predicate<T> predicate)

is

public <S> Option<S> is(Class<S> type)

isNot

public Option<T> isNot(Class<?> type)

peek

public Option<T> peek(Consumer<T> consumer)

peekIf

public Option<T> peekIf(Predicate<T> predicate,
 Consumer<T> consumer)

peekIfNot

public Option<T> peekIfNot(Predicate<T> predicate,
 Consumer<T> consumer)

onEmpty

public Option<T> onEmpty(Runnable runnable)

orElse

public Option<T> orElse(T value)

orElse

public Option<T> orElse(Option<T> value)

orElse

public Option<T> orElse(Supplier<Option<T>> supplier)

orElseSupply

public Option<T> orElseSupply(Supplier<T> supplier)

orThrow

public <E extends Throwable> T orThrow(Supplier<E> exceptionSupplier)
                                throws E

Throws:

E extends Throwable

orElseGet

public T orElseGet(T elseValue)

orElseGet

public T orElseGet(Supplier<T> supplier)

getOrNull

@Deprecated
@Nullable
public T getOrNull()

Deprecated.

orNull

@Nullable
public T orNull()

get

public T get()
      throws NoSuchElementException

Throws:

NoSuchElementException

isPresent

public boolean isPresent()

isDefined

public boolean isDefined()

isEmpty

public boolean isEmpty()

toStream

public <R> PandaStream<R> toStream(Function<T,Stream<R>> function)

toStream

public PandaStream<T> toStream()

toJavaStream

public Stream<T> toJavaStream()

toResult

public <E> Result<T,E> toResult(E orElse)

toResult

public <E> Result<T,E> toResult(Supplier<E> orElse)

toOptional

public Optional<T> toOptional()