OptionalBoolean (stream-lite API Documentation)

java.lang.Object
- com.annimon.stream.OptionalBoolean

```
public final class OptionalBoolean
extends java.lang.Object
```
A container object which may or may not contain a boolean value.

Since:

1.1.8

See Also:
Optional

Method Summary

Methods
Modifier and Type	Method and Description
`static OptionalBoolean`	`empty()` Returns an empty `OptionalBoolean` instance.
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`get()` Returns an inner value if present, otherwise throws `NoSuchElementException`.
`int`	`hashCode()`
`void`	`ifPresent(BooleanConsumer consumer)` Invokes consumer function with value if present, otherwise does nothing.
`void`	`ifPresentOrElse(BooleanConsumer consumer, java.lang.Runnable emptyAction)` If a value is present, performs the given action with the value, otherwise performs the empty-based action.
`boolean`	`isPresent()` Checks value present.
`static OptionalBoolean`	`of(boolean value)` Returns an `OptionalBoolean` with the specified value present.
`boolean`	`or(boolean other)` Returns inner value if present, otherwise returns `other`.
`boolean`	`orGet(BooleanSupplier other)` Returns the value if present, otherwise returns value produced by supplier function.
`<X extends java.lang.Throwable> boolean`	`orThrow(Supplier<X> exceptionSupplier)` Returns the value if present, otherwise throws an exception provided by supplier function.
`java.lang.String`	`toString()`

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.
    
    Returns:
    an empty OptionalBoolean
  - 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 value present
  - get
```
public boolean get()
```
    Returns an inner value if present, otherwise throws NoSuchElementException.
    
    Returns:
    the inner value of this OptionalBoolean
    
    Throws:
    
    java.util.NoSuchElementException - if there is no value present
    See Also:
    isPresent()
  - isPresent
```
public boolean isPresent()
```
    Checks value present.
    
    Returns:
    true if a value present, false otherwise
  - ifPresent
```
public void ifPresent(BooleanConsumer consumer)
```
    Invokes consumer function with value if present, otherwise does nothing.
    
    Parameters:
    consumer - the consumer function to be executed if a value is present
    
    Throws:
    
    java.lang.NullPointerException - if value is present and consumer is null
  - ifPresentOrElse
```
public void ifPresentOrElse(BooleanConsumer consumer,
                   java.lang.Runnable emptyAction)
```
    If a value is present, performs the given action with the value, otherwise performs the empty-based action.
    
    Parameters:
    consumer - the consumer function to be executed, if a value is present
    emptyAction - the empty-based action to be performed, if no value is present
    
    Throws:
    
    java.lang.NullPointerException - if a value is present and the given consumer function is null, or no value is present and the given empty-based action is null.
  - or
```
public boolean or(boolean other)
```
    Returns inner 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 other
  - orGet
```
public boolean orGet(BooleanSupplier other)
```
    Returns the value if present, otherwise returns value produced by supplier function.
    
    Parameters:
    other - supplier function that produces value if inner value is not 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
  - orThrow
```
public <X extends java.lang.Throwable> boolean orThrow(Supplier<X> exceptionSupplier)
                throws X extends java.lang.Throwable
```
    Returns the value if present, otherwise throws an exception provided by supplier function.
    
    Type Parameters:
    X - the type of exception to be thrown
    Parameters:
    exceptionSupplier - supplier function that produces an exception to be thrown
    
    Returns:
    inner value if present
    
    Throws:
    
    X - if inner value is not present
    
    X extends java.lang.Throwable
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class OptionalBoolean

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

get

isPresent

ifPresent

ifPresentOrElse

or

orGet

orThrow

equals

hashCode

toString