OptionalBinaryOperator (NoException 1.5.1 API)

Type Parameters:

T - see BinaryOperator

All Superinterfaces:

BiFunction<T,T,Optional<T>>

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

See Also:

ExceptionHandler.fromBinaryOperator(BinaryOperator), BinaryOperator

Method Summary

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

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

- Method Detail
  - apply
```
Optional<T> apply(T left,
                  T right)
```
    Variation of BiFunction.apply(Object, Object) that returns Optional. If this OptionalBinaryOperator is obtained from ExceptionHandler.fromBinaryOperator(BinaryOperator), the Optional will be empty only if the underlying BinaryOperator throws. Otherwise the returned Optional just wraps the return value of underlying BinaryOperator (possibly null).
    
    Specified by:
    
    apply in interface BiFunction<T,T,Optional<T>>
    
    Parameters:
    
    left - see BiFunction.apply(Object, Object)
    
    right - 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.fromBinaryOperator(BinaryOperator), BiFunction.apply(Object, Object)
  - orElse
```
default BinaryOperator<T> orElse(T result)
```
    Converts this OptionalBinaryOperator to plain BinaryOperator using default value. The returned BinaryOperator 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 BinaryOperator that either unwraps Optional or returns default value
    
    See Also:
    
    orElseGet(Supplier), Optional.orElse(Object)
  - orElseGet
```
default BinaryOperator<T> orElseGet(Supplier<T> source)
```
    Converts this OptionalBinaryOperator to plain BinaryOperator using fallback Supplier. The returned BinaryOperator 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 BinaryOperator that either unwraps Optional or falls back to source
    
    See Also:
    
    orElse(Object), Optional.orElseGet(Supplier)

Interface OptionalBinaryOperator<T>

Method Summary

Methods inherited from interface java.util.function.BiFunction

Method Detail

apply

orElse

orElseGet