OptionalBoolean (common 3.0.0.Beta2-SNAPSHOT API)

java.lang.Object
- org.cloudburstmc.protocol.common.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() (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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`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(it.unimi.dsi.fastutil.booleans.BooleanConsumer consumer)` Have the specified consumer accept the value if a value is present, otherwise do nothing.
`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.
`boolean`	`orElse(boolean other)` Return the value if present, otherwise return `other`.
`boolean`	`orElseGet(java.util.function.BooleanSupplier other)` Return the value if present, otherwise invoke `other` and return the result of that invocation.
`<X extends java.lang.Throwable> boolean`	`orElseThrow(java.util.function.Supplier<X> exceptionSupplier)` Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.
`java.lang.String`	`toString()` Returns a non-empty string representation of this object suitable for debugging.

Methods inherited from class java.lang.Object
clone, finalize, 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. Though it may be tempting to do so, avoid testing if an object is empty by comparing with == against instances returned by Option.empty(). There is no guarantee that it is a singleton. Instead, use isPresent().
    
    Returns:
    
    an empty OptionalBoolean.
  - 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
  - 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
    
    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 void ifPresent(it.unimi.dsi.fastutil.booleans.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
  - 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 boolean orElseGet(java.util.function.BooleanSupplier other)
```
    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.getAsBoolean()
    
    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
```
    Return the contained value, if present, otherwise throw an exception to be created by the provided supplier. A method reference to the exception constructor with an empty argument list can be used as the supplier. For example, IllegalStateException::new
    
    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
  - 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 Boolean.compare() == 0.
    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. If a value is present the result must include its string representation in the result. Empty and present instances must be unambiguously differentiable.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation of this instance

Class OptionalBoolean

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

getAsBoolean

isPresent

ifPresent

orElse

orElseGet

orElseThrow

equals

hashCode

toString