OptionalBoolean (Lightweight-Stream-API 1.1.9 API)

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

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

Since:

1.1.8

See Also:

Optional

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`custom(Function<OptionalBoolean,R> function)` Applies custom operator on `OptionalBoolean`.
`static OptionalBoolean`	`empty()` Returns an empty `OptionalBoolean` instance.
`boolean`	`equals(Object obj)`
`OptionalBoolean`	`executeIfAbsent(Runnable action)` Invokes action function if value is absent.
`OptionalBoolean`	`executeIfPresent(BooleanConsumer consumer)` Invokes consumer function with the value if present.
`OptionalBoolean`	`filter(BooleanPredicate predicate)` Performs filtering on inner value if it is present.
`OptionalBoolean`	`filterNot(BooleanPredicate predicate)` Performs negated filtering on inner value if it is present.
`boolean`	`getAsBoolean()` 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, 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.
`OptionalBoolean`	`map(BooleanPredicate mapper)` Invokes the given mapping function on inner value if present.
`<U> Optional<U>`	`mapToObj(BooleanFunction<U> mapper)` Invokes the given mapping function on inner value if present.
`static OptionalBoolean`	`of(boolean value)` Returns an `OptionalBoolean` with the specified value present.
`OptionalBoolean`	`or(Supplier<OptionalBoolean> supplier)` Returns current `OptionalBoolean` if value is present, otherwise returns an `OptionalBoolean` produced by supplier function.
`boolean`	`orElse(boolean other)` Returns inner value if present, otherwise returns `other`.
`boolean`	`orElseGet(BooleanSupplier other)` Returns the value if present, otherwise returns value produced by supplier function.
`<X extends Throwable> boolean`	`orElseThrow(Supplier<X> exceptionSupplier)` Returns the value if present, otherwise throws an exception provided by supplier function.
`String`	`toString()`

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.
    
    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
  - getAsBoolean
```
public boolean getAsBoolean()
```
    Returns an inner value if present, otherwise throws NoSuchElementException.
    
    Returns:
    
    the inner value of this OptionalBoolean
    
    Throws:
    
    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:
    
    NullPointerException - if value is present and consumer is null
  - ifPresentOrElse
```
public void ifPresentOrElse(BooleanConsumer consumer,
                            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:
    
    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.
  - executeIfPresent
```
public OptionalBoolean executeIfPresent(BooleanConsumer consumer)
```
    Invokes consumer function with the value if present. This method same as ifPresent, but does not breaks chaining
    
    Parameters:
    
    consumer - consumer function
    
    Returns:
    
    this OptionalBoolean
    
    See Also:
    
    ifPresent(BooleanConsumer)
  - executeIfAbsent
```
public OptionalBoolean executeIfAbsent(Runnable action)
```
    Invokes action function if value is absent.
    
    Parameters:
    
    action - action that invokes if value absent
    
    Returns:
    
    this OptionalBoolean
  - custom
```
public <R> R custom(Function<OptionalBoolean,R> function)
```
    Applies custom operator on OptionalBoolean.
    
    Type Parameters:
    
    R - the type of the result
    
    Parameters:
    
    function - a transforming function
    
    Returns:
    
    a result of the transforming function
    
    Throws:
    
    NullPointerException - if function is null
    
    Since:
    
    1.1.9
  - filter
```
public OptionalBoolean filter(BooleanPredicate predicate)
```
    Performs filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalBoolean if the value is present and matches predicate, otherwise an empty OptionalBoolean
  - filterNot
```
public OptionalBoolean filterNot(BooleanPredicate predicate)
```
    Performs negated filtering on inner value if it is present.
    
    Parameters:
    
    predicate - a predicate function
    
    Returns:
    
    this OptionalBoolean if the value is present and doesn't matches predicate, otherwise an empty OptionalBoolean
    
    Since:
    
    1.1.9
  - map
```
public OptionalBoolean map(BooleanPredicate mapper)
```
    Invokes the given mapping function on inner value if present.
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an OptionalBoolean with transformed value if present, otherwise an empty OptionalBoolean
    
    Throws:
    
    NullPointerException - if value is present and mapper is null
  - mapToObj
```
public <U> Optional<U> mapToObj(BooleanFunction<U> mapper)
```
    Invokes the given mapping function on inner value if present.
    
    Type Parameters:
    
    U - the type of result value
    
    Parameters:
    
    mapper - mapping function
    
    Returns:
    
    an Optional with transformed value if present, otherwise an empty Optional
    
    Throws:
    
    NullPointerException - if value is present and mapper is null
  - or
```
public OptionalBoolean or(Supplier<OptionalBoolean> supplier)
```
    Returns current OptionalBoolean if value is present, otherwise returns an OptionalBoolean produced by supplier function.
    
    Parameters:
    
    supplier - supplier function that produces an OptionalBoolean to be returned
    
    Returns:
    
    this OptionalBoolean if value is present, otherwise an OptionalBoolean produced by supplier function
    
    Throws:
    
    NullPointerException - if value is not present and supplier or value produced by it is null
  - orElse
```
public boolean orElse(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
  - orElseGet
```
public boolean orElseGet(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:
    
    NullPointerException - if value is not present and other is null
  - orElseThrow
```
public <X extends Throwable> boolean orElseThrow(Supplier<X> exceptionSupplier)
                                          throws X extends 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 Throwable
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OptionalBoolean

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

getAsBoolean

isPresent

ifPresent

ifPresentOrElse

executeIfPresent

executeIfAbsent

custom

filter

filterNot

map

mapToObj

or

orElse

orElseGet

orElseThrow

equals

hashCode

toString