com.landawn.abacus.util

Class Any<T>

java.lang.Object

com.landawn.abacus.util.Any<T>

Direct Known Subclasses:

Nullable

@Beta
public abstract class Any<T>
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static <T> Any<T>	empty() Returns an empty Any instance.
abstract <E extends java.lang.Exception> Any<T>	filter(Try.Predicate<? super T,E> predicate) If a value is present, and the value matches the given predicate, return an Any describing the value, otherwise return an empty Any.
abstract <E extends java.lang.Exception> Any<T>	filterIfNotNull(Try.Predicate<? super T,E> predicate) If a value is not null, and the value matches the given predicate, return an Any describing the value, otherwise return an empty Any.
abstract <U,E extends java.lang.Exception> Any<U>	flatMap(Try.Function<? super T,? extends Any<U>,E> mapper) If a value is present, apply the provided Any-bearing mapping function to it, return that result, otherwise return an empty Any.
abstract <U,E extends java.lang.Exception> Any<U>	flatMapIfNotNull(Try.Function<? super T,? extends Any<U>,E> mapper) If a value is not null, apply the provided Any-bearing mapping function to it, return that result, otherwise return an empty Any.
T	get() If a value is present in this Any, returns the value, otherwise throws NoSuchElementException.
<E extends java.lang.Exception> void	ifNotNull(Try.Consumer<? super T,E> consumer) If a value is not null, invoke the specified consumer with the value, otherwise do nothing.
<E extends java.lang.Exception,E2 extends java.lang.Exception> void	ifNotNullOrElse(Try.Consumer<? super T,E> action, Try.Runnable<E2> emptyAction) If a value is not null, performs the given action with the value, otherwise performs the given empty-based action.
<E extends java.lang.Exception> void	ifPresent(Try.Consumer<? super T,E> consumer) If a value is present, invoke the specified consumer with the value, otherwise do nothing.
<E extends java.lang.Exception,E2 extends java.lang.Exception> void	ifPresentOrElse(Try.Consumer<? super T,E> action, Try.Runnable<E2> emptyAction) If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
boolean	isNotNull() Return true if there is a value not null, otherwise false.
boolean	isPresent() Return true if there is a value present, otherwise false.
abstract <U,E extends java.lang.Exception> Any<U>	map(Try.Function<? super T,? extends U,E> mapper) If a value is present, apply the provided mapping function to it,
abstract <U,E extends java.lang.Exception> Any<U>	mapIfNotNull(Try.Function<? super T,? extends U,E> mapper) If a value is not null, apply the provided mapping function to it,
static <T> Any<T>	of(T value) Returns an Any with the specified present nullable value.
abstract <E extends java.lang.Exception> Any<T>	or(Try.Supplier<? extends Any<T>,E> supplier) If a value is present, returns an Optional describing the value, otherwise returns an Optional produced by the supplying function.
T	orElse(T other) Return the value if present, otherwise return other.
<E extends java.lang.Exception> T	orElseGet(Try.Supplier<? extends T,E> other) Return the value if present, otherwise invoke other and return the result of that invocation.
<X extends java.lang.Throwable> T	orElseThrow(Supplier<? extends X> exceptionSupplier) Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.
<E extends java.lang.Exception> T	orGetIfNull(Try.Supplier<? extends T,E> other) Return the value is not null, otherwise invoke other and return the result of that invocation.
T	orIfNull(T other) Return the value is not null, otherwise return other.
<X extends java.lang.Throwable> T	orThrowIfNull(Supplier<? extends X> exceptionSupplier) Return the value is not null, otherwise throw an exception to be created by the provided supplier.
Stream<T>	stream()
Stream<T>	streamIfNotNull()
java.util.Optional<T>	toJdkOptional()
java.util.List<T>	toList() Returns a List with the value if it presents, otherwise an empty List.
java.util.List<T>	toListIfNotNull() Returns a List with the value if the value is not null, otherwise an empty List.
Optional<T>	toOptional()
java.util.Set<T>	toSet() Returns a Set with the value if it presents, otherwise an empty Set.
java.util.Set<T>	toSetIfNotNull() Returns a Set with the value if the value is not null, otherwise an empty Set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

empty

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

Returns an empty Any instance. No value is present for this Optional.

Type Parameters:

T - Type of the non-existent value

Returns:

an empty Any

of

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

Returns an Any with the specified present nullable value.

Parameters:

value - the value to be present, which could be null

Returns:

an Any with the value present

get

public T get()

If a value is present in this Any, returns the value, otherwise throws NoSuchElementException.

Returns:

the nullable value held by this Any

Throws:

java.util.NoSuchElementException - if there is no value present

See Also:

isPresent()

isPresent

public boolean isPresent()

Return true if there is a value present, otherwise false.

Returns:

true if there is a value present, otherwise false

isNotNull

public boolean isNotNull()

Return true if there is a value not null, otherwise false.

Returns:

true if there is a value not null, otherwise false

ifPresent

public <E extends java.lang.Exception> void ifPresent(Try.Consumer<? super T,E> consumer)
                                               throws E extends java.lang.Exception

If a value is present, invoke the specified consumer with the value, otherwise do nothing.

Parameters:

consumer - block to be executed if a value is present

Throws:

java.lang.NullPointerException - if value is present and consumer is null

E extends java.lang.Exception

ifPresentOrElse

public <E extends java.lang.Exception,E2 extends java.lang.Exception> void ifPresentOrElse(Try.Consumer<? super T,E> action,
                                                                                           Try.Runnable<E2> emptyAction)
                                                                                    throws E extends java.lang.Exception,
                                                                                           E2 extends java.lang.Exception

If a value is present, performs the given action with the value, otherwise performs the given empty-based action.

Parameters:

action -

emptyAction -

Throws:

E extends java.lang.Exception

ifNotNull

public <E extends java.lang.Exception> void ifNotNull(Try.Consumer<? super T,E> consumer)
                                               throws E extends java.lang.Exception

If a value is not null, invoke the specified consumer with the value, otherwise do nothing.

Parameters:

consumer - block to be executed if a value is not null.

Throws:

java.lang.NullPointerException - if value is present and consumer is null

E extends java.lang.Exception

ifNotNullOrElse

public <E extends java.lang.Exception,E2 extends java.lang.Exception> void ifNotNullOrElse(Try.Consumer<? super T,E> action,
                                                                                           Try.Runnable<E2> emptyAction)
                                                                                    throws E extends java.lang.Exception,
                                                                                           E2 extends java.lang.Exception

If a value is not null, performs the given action with the value, otherwise performs the given empty-based action.

Parameters:

action -

emptyAction -

Throws:

E extends java.lang.Exception

filter

public abstract <E extends java.lang.Exception> Any<T> filter(Try.Predicate<? super T,E> predicate)
                                                       throws E extends java.lang.Exception

If a value is present, and the value matches the given predicate, return an Any describing the value, otherwise return an empty Any.

Parameters:

predicate - a predicate to apply to the value, if present

Returns:

an Any describing the value of this Any if a value is present and the value matches the given predicate, otherwise an empty Any

Throws:

java.lang.NullPointerException - if the predicate is null

E extends java.lang.Exception

map

public abstract <U,E extends java.lang.Exception> Any<U> map(Try.Function<? super T,? extends U,E> mapper)
                                                      throws E extends java.lang.Exception

If a value is present, apply the provided mapping function to it,

Type Parameters:

U - The type of the result of the mapping function

Parameters:

mapper - a mapping function to apply to the value, if present

Returns:

an Any describing the result of applying a mapping function to the value of this Any, if a value is present, otherwise an empty Any

Throws:

java.lang.NullPointerException - if the mapping function is null

E extends java.lang.Exception

flatMap

public abstract <U,E extends java.lang.Exception> Any<U> flatMap(Try.Function<? super T,? extends Any<U>,E> mapper)
                                                          throws E extends java.lang.Exception

If a value is present, apply the provided Any-bearing mapping function to it, return that result, otherwise return an empty Any. This method is similar to #map(Function), but the provided mapper is one whose result is already an Any, and if invoked, flatMap does not wrap it with an additional Any.

Type Parameters:

U - The type parameter to the Any returned by

Parameters:

mapper - a mapping function to apply to the value, if present the mapping function

Returns:

the result of applying an Any-bearing mapping function to the value of this Any, if a value is present, otherwise an empty Any

Throws:

java.lang.NullPointerException - if the mapping function is null or returns a null result

E extends java.lang.Exception

filterIfNotNull

public abstract <E extends java.lang.Exception> Any<T> filterIfNotNull(Try.Predicate<? super T,E> predicate)
                                                                throws E extends java.lang.Exception

If a value is not null, and the value matches the given predicate, return an Any describing the value, otherwise return an empty Any.

Parameters:

predicate - a predicate to apply to the value, if present

Returns:

an Any describing the value of this Any if a value is present and the value matches the given predicate, otherwise an empty Any

Throws:

java.lang.NullPointerException - if the predicate is null

E extends java.lang.Exception

mapIfNotNull

public abstract <U,E extends java.lang.Exception> Any<U> mapIfNotNull(Try.Function<? super T,? extends U,E> mapper)
                                                               throws E extends java.lang.Exception

If a value is not null, apply the provided mapping function to it,

Type Parameters:

U - The type of the result of the mapping function

Parameters:

mapper - a mapping function to apply to the value, if not null

Returns:

an Any describing the result of applying a mapping function to the value of this Any, if a value is not null, otherwise an empty Any

Throws:

java.lang.NullPointerException - if the mapping function is null

E extends java.lang.Exception

flatMapIfNotNull

public abstract <U,E extends java.lang.Exception> Any<U> flatMapIfNotNull(Try.Function<? super T,? extends Any<U>,E> mapper)
                                                                   throws E extends java.lang.Exception

If a value is not null, apply the provided Any-bearing mapping function to it, return that result, otherwise return an empty Any. This method is similar to #map(Function), but the provided mapper is one whose result is already an Any, and if invoked, flatMap does not wrap it with an additional Any.

Type Parameters:

U - The type parameter to the Any returned by

Parameters:

mapper - a mapping function to apply to the value, if not null the mapping function

Returns:

the result of applying an Any-bearing mapping function to the value of this Any, if a value is not null, otherwise an empty Any

Throws:

java.lang.NullPointerException - if the mapping function is null or returns a null result

E extends java.lang.Exception

or

public abstract <E extends java.lang.Exception> Any<T> or(Try.Supplier<? extends Any<T>,E> supplier)
                                                   throws E extends java.lang.Exception

If a value is present, returns an Optional describing the value, otherwise returns an Optional produced by the supplying function.

Parameters:

supplier -

Returns:

Throws:

E

E extends java.lang.Exception

orElse

public T orElse(T other)

Return the value if present, otherwise return other.

Parameters:

other - the value to be returned if there is no value present, may be null

Returns:

the value, if present, otherwise other

orElseGet

public <E extends java.lang.Exception> T orElseGet(Try.Supplier<? extends T,E> other)
                                            throws E extends java.lang.Exception

Return the value if present, otherwise invoke other and return the result of that invocation.

Parameters:

other - a Supplier whose result is returned if no value is present

Returns:

the value if present otherwise the result of other.get()

Throws:

java.lang.NullPointerException - if value is not present and other is null

E extends java.lang.Exception

orElseThrow

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

Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionSupplier - The supplier which will return the exception to be thrown

Returns:

the present value

Throws:

X - if there is no value present

java.lang.NullPointerException - if no value is present and exceptionSupplier is null

X extends java.lang.Throwable

orIfNull

public T orIfNull(T other)

Return the value is not null, otherwise return other.

Parameters:

other - the value to be returned if not present or null, may be null

Returns:

the value, if not present or null, otherwise other

orGetIfNull

public <E extends java.lang.Exception> T orGetIfNull(Try.Supplier<? extends T,E> other)
                                              throws E extends java.lang.Exception

Return the value is not null, otherwise invoke other and return the result of that invocation.

Parameters:

other - a Supplier whose result is returned if not present or null

Returns:

the value if not present or null otherwise the result of other.get()

Throws:

java.lang.NullPointerException - if value is not present and other is null

E extends java.lang.Exception

orThrowIfNull

public <X extends java.lang.Throwable> T orThrowIfNull(Supplier<? extends X> exceptionSupplier)
                                                throws X extends java.lang.Throwable

Return the value is not null, otherwise throw an exception to be created by the provided supplier.

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionSupplier - The supplier which will return the exception to be thrown

Returns:

the present value

Throws:

X - if not present or null

java.lang.NullPointerException - if not present or null and exceptionSupplier is null

X extends java.lang.Throwable

stream

public Stream<T> stream()

Returns:

an empty stream if it's not present.

streamIfNotNull

public Stream<T> streamIfNotNull()

Returns:

an empty stream if it's null.

toList

public java.util.List<T> toList()

Returns a List with the value if it presents, otherwise an empty List.

Returns:

toListIfNotNull

public java.util.List<T> toListIfNotNull()

Returns a List with the value if the value is not null, otherwise an empty List.

Returns:

toSet

public java.util.Set<T> toSet()

Returns a Set with the value if it presents, otherwise an empty Set.

Returns:

toSetIfNotNull

public java.util.Set<T> toSetIfNotNull()

Returns a Set with the value if the value is not null, otherwise an empty Set.

Returns:

toOptional

public Optional<T> toOptional()

Returns:

Optional.empty() if the value is not present or null.

toJdkOptional

public java.util.Optional<T> toJdkOptional()

Returns:

java.util.Optional.empty() if the value is not present or null.