OptionalBoolean (stream 1.2.2 API)

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

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(java.lang.Object obj)`
`OptionalBoolean`	`executeIfAbsent(java.lang.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, java.lang.Runnable emptyAction)` If a value is present, performs the given action with the value, otherwise performs the empty-based action.
`boolean`	`isEmpty()` Checks the value is not present.
`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.
`static OptionalBoolean`	`ofNullable(java.lang.Boolean value)` Returns an `OptionalBoolean` with the specified value, or empty `OptionalBoolean` if value is null.
`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.
`boolean`	`orElseThrow()` Returns inner value if present, otherwise throws `NoSuchElementException`.
`<X extends java.lang.Throwable> boolean`	`orElseThrow(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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - empty
```
@NotNull
public static OptionalBoolean empty()
```
    Returns an empty OptionalBoolean instance.
    
    Returns:
    
    an empty OptionalBoolean
  - of
```
@NotNull
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
  - ofNullable
```
@NotNull
public static OptionalBoolean ofNullable(@Nullable
                                                  java.lang.Boolean value)
```
    Returns an OptionalBoolean with the specified value, or empty OptionalBoolean if value is null.
    
    Parameters:
    
    value - the value which can be null
    
    Returns:
    
    an OptionalBoolean
    
    Since:
    
    1.2.1
  - getAsBoolean
```
public boolean getAsBoolean()
```
    Returns an inner value if present, otherwise throws NoSuchElementException. Since 1.2.0 prefer orElseThrow() method as it has readable name.
    
    Returns:
    
    the inner value of this OptionalBoolean
    
    Throws:
    
    java.util.NoSuchElementException - if there is no value present
    
    See Also:
    
    isPresent(), orElseThrow()
  - isPresent
```
public boolean isPresent()
```
    Checks value present.
    
    Returns:
    
    true if a value present, false otherwise
  - isEmpty
```
public boolean isEmpty()
```
    Checks the value is not present.
    
    Returns:
    
    true if a value is not present, false otherwise
    
    Since:
    
    1.2.1
  - ifPresent
```
public void ifPresent(@NotNull
                      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(@NotNull
                            BooleanConsumer consumer,
                            @NotNull
                            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.
  - executeIfPresent
```
@NotNull
public OptionalBoolean executeIfPresent(@NotNull
                                                 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
```
@NotNull
public OptionalBoolean executeIfAbsent(@NotNull
                                                java.lang.Runnable action)
```
    Invokes action function if value is absent.
    
    Parameters:
    
    action - action that invokes if value absent
    
    Returns:
    
    this OptionalBoolean
  - custom
```
@Nullable
public <R> R custom(@NotNull
                              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:
    
    java.lang.NullPointerException - if function is null
    
    Since:
    
    1.1.9
  - filter
```
@NotNull
public OptionalBoolean filter(@NotNull
                                       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
```
@NotNull
public OptionalBoolean filterNot(@NotNull
                                          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
```
@NotNull
public OptionalBoolean map(@NotNull
                                    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:
    
    java.lang.NullPointerException - if value is present and mapper is null
  - mapToObj
```
@NotNull
public <U> Optional<U> mapToObj(@NotNull
                                         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:
    
    java.lang.NullPointerException - if value is present and mapper is null
  - or
```
@NotNull
public OptionalBoolean or(@NotNull
                                   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:
    
    java.lang.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(@NotNull
                         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
  - orElseThrow
```
public boolean orElseThrow()
```
    Returns inner value if present, otherwise throws NoSuchElementException.
    
    Returns:
    
    inner value if present
    
    Throws:
    
    java.util.NoSuchElementException - if inner value is not present
    
    Since:
    
    1.2.0
  - orElseThrow
```
public <X extends java.lang.Throwable> boolean orElseThrow(@NotNull
                                                           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
```
@NotNull
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

ofNullable

getAsBoolean

isPresent

isEmpty

ifPresent

ifPresentOrElse

executeIfPresent

executeIfAbsent

custom

filter

filterNot

map

mapToObj

or

orElse

orElseGet

orElseThrow

orElseThrow

equals

hashCode

toString