Module com.aoapps.lang

Package com.aoapps.lang.util

Class OptionalE<T>

java.lang.Object

com.aoapps.lang.util.OptionalE<T>

public final class OptionalE<T>
extends Object

An optional that is allowed to throw a checked exception. This should not be used as a return type, use standard Optional instead. This is useful for specific scenarios where the methods of standard Optional do not play well with checked exceptions.

See Also:

• Optional

Method Summary

Modifier and Type	Method	Description
static <T> OptionalE<T>	empty()
boolean	equals(Object obj)
<Ex extends Throwable> OptionalE<T>	filter(PredicateE<? super T,Ex> predicate)
<U, Ex extends Throwable> OptionalE<U>	flatMap(FunctionE<? super T,? extends Optional<? extends U>,Ex> mapper)
static <T> OptionalE<T>	fromOptional(Optional<? extends T> value)	Convert from standard Optional.
T	get()
int	hashCode()
<Ex extends Throwable> void	ifPresent(ConsumerE<? super T,Ex> action)
<Ex extends Throwable> void	ifPresentOrElse(ConsumerE<? super T,Ex> action, Runnable emptyAction)
boolean	isEmpty()
boolean	isPresent()
<U, Ex extends Throwable> OptionalE<U>	map(FunctionE<? super T,? extends U,Ex> mapper)
static <T> OptionalE<T>	of(T value)
static <T> OptionalE<T>	ofNullable(T value)
<Ex extends Throwable> OptionalE<T>	or(SupplierE<? extends Optional<? extends T>,Ex> supplier)
T	orElse(T other)
<Ex extends Throwable> T	orElseGet(SupplierE<? extends T,Ex> supplier)
T	orElseThrow()
<X extends Throwable> T	orElseThrow(Supplier<? extends X> exceptionSupplier)
Stream<T>	stream()
Optional<T>	toOptional()	Convert to standard Optional.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

empty

public static <T> OptionalE<T> empty()

See Also:

• Optional.empty()

of

public static <T> OptionalE<T> of(T value)

See Also:

• Optional.of(java.lang.Object)

ofNullable

public static <T> OptionalE<T> ofNullable(T value)

See Also:

• Optional.ofNullable(java.lang.Object)

fromOptional

public static <T> OptionalE<T> fromOptional(Optional<? extends T> value)

Convert from standard Optional.

toOptional

public Optional<T> toOptional()

Convert to standard Optional.

get

public T get()

See Also:

• Optional.get()

isPresent

public boolean isPresent()

See Also:

• Optional.isPresent()

isEmpty

public boolean isEmpty()

See Also:

• Optional.isEmpty()

ifPresent

public <Ex extends Throwable> void ifPresent(ConsumerE<? super T,Ex> action)
                                      throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.ifPresent(java.util.function.Consumer)

ifPresentOrElse

public <Ex extends Throwable> void ifPresentOrElse(ConsumerE<? super T,Ex> action,
 Runnable emptyAction)
                                            throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.ifPresentOrElse(java.util.function.Consumer, java.lang.Runnable)

filter

public <Ex extends Throwable> OptionalE<T> filter(PredicateE<? super T,Ex> predicate)
                                           throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.filter(java.util.function.Predicate)

map

public <U,
Ex extends Throwable> OptionalE<U> map(FunctionE<? super T,? extends U,Ex> mapper)
                                           throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.map(java.util.function.Function)

flatMap

public <U,
Ex extends Throwable> OptionalE<U> flatMap(FunctionE<? super T,? extends Optional<? extends U>,Ex> mapper)
                                               throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.flatMap(java.util.function.Function)

or

public <Ex extends Throwable> OptionalE<T> or(SupplierE<? extends Optional<? extends T>,Ex> supplier)
                                       throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.or(java.util.function.Supplier)

stream

public Stream<T> stream()

See Also:

• Optional.stream()

orElse

public T orElse(T other)

See Also:

• Optional.orElse(java.lang.Object)

orElseGet

public <Ex extends Throwable> T orElseGet(SupplierE<? extends T,Ex> supplier)
                                   throws Ex

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

See Also:

• Optional.orElseGet(java.util.function.Supplier)

orElseThrow

public T orElseThrow()

See Also:

• Optional.orElseThrow()

orElseThrow

public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)
                                    throws X

Throws:

X

See Also:

• Optional.orElseThrow(java.util.function.Supplier)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Optional.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Optional.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Optional.toString()