OptionalBiFunction (NoException 1.5.1 API)

Type Parameters:

T - see BiFunction

U - see BiFunction

R - see BiFunction

All Superinterfaces:

BiFunction<T,U,Optional<R>>

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 OptionalBiFunction<T,U,R>
extends BiFunction<T,U,Optional<R>>
```
Variation of BiFunction that returns Optional instead of the raw value. OptionalBiFunction is typically obtained from ExceptionHandler.fromBiFunction(BiFunction), in which case its return value is empty when the underlying BiFunction throws an exception. See noexception tutorial.

See Also:

ExceptionHandler.fromBiFunction(BiFunction), BiFunction

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Optional<R>`	`apply(T t, U u)` Variation of `BiFunction.apply(Object, Object)` that returns `Optional`.
`default BiFunction<T,U,R>`	`orElse(R result)` Converts this `OptionalBiFunction` to plain `BiFunction` using default value.
`default BiFunction<T,U,R>`	`orElseGet(Supplier<R> source)` Converts this `OptionalBiFunction` to plain `BiFunction` using fallback `Supplier`.

Methods inherited from interface java.util.function.BiFunction
andThen

- Method Detail
  - apply
```
Optional<R> apply(T t,
                  U u)
```
    Variation of BiFunction.apply(Object, Object) that returns Optional. If this OptionalBiFunction is obtained from ExceptionHandler.fromBiFunction(BiFunction), the Optional will be empty only if the underlying BiFunction throws. Otherwise the returned Optional just wraps the return value of underlying BiFunction (possibly null).
    
    Specified by:
    
    apply in interface BiFunction<T,U,Optional<R>>
    
    Parameters:
    
    t - see BiFunction.apply(Object, Object)
    
    u - see BiFunction.apply(Object, Object)
    
    Returns:
    
    Optional typically wrapping return value of BiFunction.apply(Object, Object), or an empty Optional (typically signifying an exception)
    
    See Also:
    
    ExceptionHandler.fromBiFunction(BiFunction), BiFunction.apply(Object, Object)
  - orElse
```
default BiFunction<T,U,R> orElse(R result)
```
    Converts this OptionalBiFunction to plain BiFunction using default value. The returned BiFunction will unwrap present value from the Optional if possible, or return result if the Optional is empty.
    
    Parameters:
    
    result - default value to return instead of an empty Optional
    
    Returns:
    
    plain BiFunction that either unwraps Optional or returns default value
    
    See Also:
    
    orElseGet(Supplier), Optional.orElse(Object)
  - orElseGet
```
default BiFunction<T,U,R> orElseGet(Supplier<R> source)
```
    Converts this OptionalBiFunction to plain BiFunction using fallback Supplier. The returned BiFunction will unwrap present value from the Optional if possible, or fall back to calling source if the Optional is empty.
    
    Parameters:
    
    source - Supplier to query for fallback value when Optional is empty
    
    Returns:
    
    plain BiFunction that either unwraps Optional or falls back to source
    
    See Also:
    
    orElse(Object), Optional.orElseGet(Supplier)

Interface OptionalBiFunction<T,U,R>

Method Summary

Methods inherited from interface java.util.function.BiFunction

Method Detail

apply

orElse

orElseGet