org.macroing.cit.java.util

Class OptionalBoolean

java.lang.Object

org.macroing.cit.java.util.OptionalBoolean

public final class OptionalBoolean
extends java.lang.Object

A container object which may or may not contain a boolean value.

If a value is present, isPresent() will return true and getAsBoolean() will return the value.

Additional methods that depend on the presence or absence of a contained value are provided, such as orElse(boolean) (return a default value if value not present) and ifPresent(BooleanConsumer) (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.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static OptionalBoolean	empty() Returns an empty OptionalBoolean instance.
boolean	equals(java.lang.Object object) Indicates whether some other Object is "equal to" this OptionalBoolean.
boolean	getAsBoolean() 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.
void	ifPresent(BooleanConsumer consumer) Have the specified consumer accept the value if a value is present, otherwise do nothing.
boolean	isPresent() Returns true if there is a value present, otherwise false.
static OptionalBoolean	of(boolean value) Returns an OptionalBoolean with the specified value present.
boolean	orElse(boolean other) Returns the value if present, otherwise returns other.
boolean	orElseGet(java.util.function.BooleanSupplier other) Returns the value if present, otherwise invokes other and returns the result of that invocation.
<X extends java.lang.Throwable> boolean	orElseThrow(java.util.function.Supplier<X> exceptionSupplier) Returns the contained value, if present, otherwise throws a Throwable to be created by the provided Supplier.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object object)

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.

Overrides:

equals in class java.lang.Object

Parameters:

object - an Object to be tested for equality

Returns:

true if the other Object is "equal to" this OptionalBoolean otherwise false

getAsBoolean

public boolean getAsBoolean()

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

isPresent

public boolean isPresent()

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

Returns:

true if there is a value present, otherwise false

orElse

public boolean orElse(boolean other)

Returns the value if present, otherwise returns other.

Parameters:

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

Returns:

the value if present, otherwise returns other

orElseGet

public boolean orElseGet(java.util.function.BooleanSupplier other)

Returns the value if present, otherwise invokes other and returns the result of that invocation.

Parameters:

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

Returns:

the value if present, otherwise invokes other and returns the result of that invocation

Throws:

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

orElseThrow

public <X extends java.lang.Throwable> boolean orElseThrow(java.util.function.Supplier<X> exceptionSupplier)
                                                    throws X extends java.lang.Throwable

Returns the contained value, if present, otherwise throws a Throwable to be created by the provided Supplier.

Type Parameters:

X - the type of the Throwable to be thrown

Parameters:

exceptionSupplier - the Supplier which will return the Throwable to be thrown

Returns:

the contained value, if present

Throws:

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

X - if there is no value present

X extends java.lang.Throwable

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:

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

ifPresent

public void ifPresent(BooleanConsumer consumer)

Have the specified consumer accept the value if a value is present, 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

empty

public static OptionalBoolean empty()

Returns an empty OptionalBoolean instance.

No value is present for this OptionalBoolean.

Returns:

an empty OptionalBoolean instance

of

public static OptionalBoolean of(boolean value)

Returns an OptionalBoolean with the specified value present.

Parameters:

value - the value to be present

Returns:

an OptionalBoolean with the specified value present