com.landawn.abacus.util

Class OptionalBoolean

java.lang.Object

com.landawn.abacus.util.OptionalBoolean

All Implemented Interfaces:

java.lang.Comparable<OptionalBoolean>

public final class OptionalBoolean
extends java.lang.Object
implements java.lang.Comparable<OptionalBoolean>

Note: It's copied from OpenJDK at: http://hg.openjdk.java.net/jdk8u/hs-dev/jdk
A container object which may or may not contain a boolean value. If a value is present, isPresent() will return true and get() will return the value.

Additional methods that depend on the presence or absence of a contained value are provided, such as orElse() (return a default value if value not present) and ifPresent() (execute a block of code if the value is present).

This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of OptionalBoolean may have unpredictable results and should be avoided.

Since:

1.8

Method Summary

Modifier and Type	Method and Description
Optional<java.lang.Boolean>	boxed()
int	compareTo(OptionalBoolean optional)
static OptionalBoolean	empty() Returns an empty OptionalBoolean instance.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this OptionalBoolean.
boolean	get() If a value is present in this OptionalBoolean, returns the value, otherwise throws NoSuchElementException.
int	hashCode() Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.
<E extends java.lang.Exception> void	ifPresent(Try.BooleanConsumer<E> action) Have the specified consumer accept the value if a value is present, otherwise do nothing.
<E extends java.lang.Exception,E2 extends java.lang.Exception> void	ifPresentOrElse(Try.BooleanConsumer<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	isPresent() Return true if there is a value present, otherwise false.
static OptionalBoolean	of(boolean value) Return an OptionalBoolean with the specified value present.
static OptionalBoolean	ofNullable(java.lang.Boolean val) Returns an empty OptionalBoolean if the specified Boolean is null.
boolean	orElse(boolean other) Return the value if present, otherwise return other.
<E extends java.lang.Exception> boolean	orElseGet(Try.BooleanSupplier<E> other) Return the value if present, otherwise invoke other and return the result of that invocation.
<X extends java.lang.Throwable> boolean	orElseThrow(Supplier<? extends X> exceptionSupplier) Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.
Stream<java.lang.Boolean>	stream()
java.lang.String	toString() Returns a non-empty string representation of this object suitable for debugging.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

empty

public static OptionalBoolean empty()

Returns an empty OptionalBoolean instance. No value is present for this OptionalBoolean.

Returns:

an empty OptionalBoolean

ofNullable

public static OptionalBoolean ofNullable(java.lang.Boolean val)

Returns an empty OptionalBoolean if the specified Boolean is null.

Parameters:

val -

Returns:

of

public static OptionalBoolean of(boolean value)

Return an OptionalBoolean with the specified value present.

Parameters:

value - the value to be present

Returns:

an OptionalBoolean with the value present

get

public boolean get()

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

Returns:

the value held by this OptionalBoolean

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

ifPresent

public <E extends java.lang.Exception> void ifPresent(Try.BooleanConsumer<E> action)
                                               throws E extends java.lang.Exception

Have the specified consumer accept the value if a value is present, otherwise do nothing.

Parameters:

action - block to be executed if a value is present

Throws:

NullPobooleanerException - 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.BooleanConsumer<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

orElse

public boolean orElse(boolean other)

Return the value if present, otherwise return other.

Parameters:

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

Returns:

the value, if present, otherwise other

orElseGet

public <E extends java.lang.Exception> boolean orElseGet(Try.BooleanSupplier<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 BooleanSupplier whose result is returned if no value is present

Returns:

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

Throws:

NullPobooleanerException - if value is not present and other is null

E extends java.lang.Exception

orElseThrow

public <X extends java.lang.Throwable> boolean 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

NullPobooleanerException - if no value is present and exceptionSupplier is null

X extends java.lang.Throwable

compareTo

public int compareTo(OptionalBoolean optional)

Specified by:

compareTo in interface java.lang.Comparable<OptionalBoolean>

stream

public Stream<java.lang.Boolean> stream()

boxed

public Optional<java.lang.Boolean> boxed()

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this OptionalBoolean. The other object is considered equal if:

• it is also an OptionalBoolean and;
• both instances have no value present or;
• the present values are "equal to" each other via ==.

Overrides:

equals in class java.lang.Object

Parameters:

obj - an object to be tested for equality

Returns:

{code true} if the other object is "equal to" this object otherwise false

hashCode

public int hashCode()

Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code value of the present value or 0 if no value is present

toString

public java.lang.String toString()

Returns a non-empty string representation of this object suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this instance