OptionalIntToDoubleFunction (NoException 1.5.1 API)

All Superinterfaces:

IntFunction<OptionalDouble>

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 OptionalIntToDoubleFunction
extends IntFunction<OptionalDouble>
```
Variation of IntToDoubleFunction that returns OptionalDouble instead of the raw value. OptionalIntToDoubleFunction is typically obtained from ExceptionHandler.fromIntToDoubleFunction(IntToDoubleFunction), in which case its return value is empty when the underlying IntToDoubleFunction throws an exception. See noexception tutorial.

See Also:

ExceptionHandler.fromIntToDoubleFunction(IntToDoubleFunction), IntToDoubleFunction

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`OptionalDouble`	`apply(int value)` Variation of `IntToDoubleFunction.applyAsDouble(int)` that returns `OptionalDouble`.
`default IntToDoubleFunction`	`orElse(double result)` Converts this `OptionalIntToDoubleFunction` to plain `IntToDoubleFunction` using default value.
`default IntToDoubleFunction`	`orElseGet(DoubleSupplier source)` Converts this `OptionalIntToDoubleFunction` to plain `IntToDoubleFunction` using fallback `DoubleSupplier`.

- Method Detail
  - apply
```
OptionalDouble apply(int value)
```
    Variation of IntToDoubleFunction.applyAsDouble(int) that returns OptionalDouble. If this OptionalIntToDoubleFunction is obtained from ExceptionHandler.fromIntToDoubleFunction(IntToDoubleFunction), the OptionalDouble will be empty only if the underlying IntToDoubleFunction throws. Otherwise the returned OptionalDouble just wraps the return value of underlying IntToDoubleFunction.
    
    Specified by:
    
    apply in interface IntFunction<OptionalDouble>
    
    Parameters:
    
    value - see IntToDoubleFunction.applyAsDouble(int)
    
    Returns:
    
    OptionalDouble typically wrapping return value of IntToDoubleFunction.applyAsDouble(int), or an empty OptionalDouble (typically signifying an exception)
    
    See Also:
    
    ExceptionHandler.fromIntToDoubleFunction(IntToDoubleFunction), IntToDoubleFunction.applyAsDouble(int)
  - orElse
```
default IntToDoubleFunction orElse(double result)
```
    Converts this OptionalIntToDoubleFunction to plain IntToDoubleFunction using default value. The returned IntToDoubleFunction will unwrap present value from the OptionalDouble if possible, or return result if the OptionalDouble is empty.
    
    Parameters:
    
    result - default value to return instead of an empty OptionalDouble
    
    Returns:
    
    plain IntToDoubleFunction that either unwraps OptionalDouble or returns default value
    
    See Also:
    
    orElseGet(DoubleSupplier), OptionalDouble.orElse(double)
  - orElseGet
```
default IntToDoubleFunction orElseGet(DoubleSupplier source)
```
    Converts this OptionalIntToDoubleFunction to plain IntToDoubleFunction using fallback DoubleSupplier. The returned IntToDoubleFunction will unwrap present value from the OptionalDouble if possible, or fall back to calling source if the OptionalDouble is empty.
    
    Parameters:
    
    source - DoubleSupplier to query for fallback value when OptionalDouble is empty
    
    Returns:
    
    plain IntToDoubleFunction that either unwraps OptionalDouble or falls back to source
    
    See Also:
    
    orElse(double), OptionalDouble.orElseGet(DoubleSupplier)

Interface OptionalIntToDoubleFunction

Method Summary

Method Detail

apply

orElse

orElseGet