OptionalBooleanSupplier (NoException 1.5.1 API)

All Superinterfaces:

Supplier<OptionalBoolean>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface OptionalBooleanSupplier
extends Supplier<OptionalBoolean>
```
Variation of BooleanSupplier that returns OptionalBoolean instead of the raw value. OptionalBooleanSupplier is typically obtained from ExceptionHandler.fromBooleanSupplier(BooleanSupplier), in which case its return value is empty when the underlying BooleanSupplier throws an exception. See noexception tutorial.

See Also:

ExceptionHandler.fromBooleanSupplier(BooleanSupplier), BooleanSupplier

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`OptionalBoolean`	`get()` Variation of `BooleanSupplier.getAsBoolean()` that returns `OptionalBoolean`.
`default BooleanSupplier`	`orElse(boolean result)` Converts this `OptionalBooleanSupplier` to plain `BooleanSupplier` using default value.
`default BooleanSupplier`	`orElseGet(BooleanSupplier source)` Converts this `OptionalBooleanSupplier` to plain `BooleanSupplier` using fallback `BooleanSupplier`.

- Method Detail
  - get
```
OptionalBoolean get()
```
    Variation of BooleanSupplier.getAsBoolean() that returns OptionalBoolean. If this OptionalBooleanSupplier is obtained from ExceptionHandler.fromBooleanSupplier(BooleanSupplier), the OptionalBoolean will be empty only if the underlying BooleanSupplier throws. Otherwise the returned OptionalBoolean just wraps the return value of underlying BooleanSupplier.
    
    Specified by:
    
    get in interface Supplier<OptionalBoolean>
    
    Returns:
    
    OptionalBoolean typically wrapping return value of BooleanSupplier.getAsBoolean(), or an empty OptionalBoolean (typically signifying an exception)
    
    See Also:
    
    ExceptionHandler.fromBooleanSupplier(BooleanSupplier), BooleanSupplier.getAsBoolean()
  - orElse
```
default BooleanSupplier orElse(boolean result)
```
    Converts this OptionalBooleanSupplier to plain BooleanSupplier using default value. The returned BooleanSupplier will unwrap present value from the OptionalBoolean if possible, or return result if the OptionalBoolean is empty.
    
    Parameters:
    
    result - default value to return instead of an empty OptionalBoolean
    
    Returns:
    
    plain BooleanSupplier that either unwraps OptionalBoolean or returns default value
    
    See Also:
    
    orElseGet(BooleanSupplier), OptionalBoolean.orElse(boolean)
  - orElseGet
```
default BooleanSupplier orElseGet(BooleanSupplier source)
```
    Converts this OptionalBooleanSupplier to plain BooleanSupplier using fallback BooleanSupplier. The returned BooleanSupplier will unwrap present value from the OptionalBoolean if possible, or fall back to calling source if the OptionalBoolean is empty.
    
    Parameters:
    
    source - BooleanSupplier to query for fallback value when OptionalBoolean is empty
    
    Returns:
    
    plain BooleanSupplier that either unwraps OptionalBoolean or falls back to source
    
    See Also:
    
    orElse(boolean), OptionalBoolean.orElseGet(BooleanSupplier)

Interface OptionalBooleanSupplier

Method Summary

Method Detail

get

orElse

orElseGet