org.sellcom.core.util.function

Interface ThrowingToDoubleBiFunction<T,U>

All Superinterfaces:

ToDoubleBiFunction<T,U>

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 ThrowingToDoubleBiFunction<T,U>
extends ToDoubleBiFunction<T,U>

Represents a function that accepts two arguments and produces a double-valued result, possibly throwing an exception.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default double	applyAsDouble(T former, U latter) Applies this function to the given arguments.
double	applyAsDoubleThrowing(T former, U latter) Applies this function to the given arguments.
default ToDoubleBiFunction<T,U>	fallbackTo(ToDoubleBiFunction<T,U> fallback) Returns a ToDoubleBiFunction applying the given function to the arguments if this function throws an exception.
default ToDoubleBiFunction<T,U>	fallbackTo(ToDoubleBiFunction<T,U> fallback, Consumer<Exception> exceptionConsumer) Returns a ToDoubleBiFunction applying the given function to the arguments if this function throws an exception.
default ToDoubleBiFunction<T,U>	orReturn(double value) Returns a ToDoubleBiFunction returning the given value if this function throws an exception.
default ToDoubleBiFunction<T,U>	orReturn(double value, Consumer<Exception> exceptionConsumer) Returns a ToDoubleBiFunction returning the given value if this function throws an exception.
default ThrowingToDoubleBiFunction<T,U>	orThrow(Class<? extends RuntimeException> exceptionClass) Returns a ThrowingToDoubleBiFunction throwing an exception of the given type if this function throws an exception.
default ThrowingToDoubleBiFunction<T,U>	orThrow(Class<? extends RuntimeException> exceptionClass, String message) Returns a ThrowingToDoubleBiFunction throwing an exception of the given type if this function throws an exception.
default ThrowingToDoubleBiFunction<T,U>	orTryWith(ThrowingToDoubleBiFunction<? super T,? super U> other) Returns a ThrowingToDoubleBiFunction applying the given function to the argument if this function throws an exception.
default ThrowingToDoubleBiFunction<T,U>	orTryWith(ThrowingToDoubleBiFunction<? super T,? super U> other, Consumer<Exception> exceptionConsumer) Returns a ThrowingToDoubleBiFunction applying the given function to the argument if this function throws an exception.

Method Detail

applyAsDouble

default double applyAsDouble(T former,
                             U latter)

Applies this function to the given arguments. Wraps any thrown checked exceptions with UncheckedException.

Specified by:

applyAsDouble in interface ToDoubleBiFunction<T,U>

Since:

1.0

applyAsDoubleThrowing

double applyAsDoubleThrowing(T former,
                             U latter)
                      throws Exception

Applies this function to the given arguments.

Throws:

Exception

Since:

1.0

fallbackTo

default ToDoubleBiFunction<T,U> fallbackTo(ToDoubleBiFunction<T,U> fallback)

Returns a ToDoubleBiFunction applying the given function to the arguments if this function throws an exception.

Throws:

IllegalArgumentException - if fallback is null

Since:

1.0

fallbackTo

default ToDoubleBiFunction<T,U> fallbackTo(ToDoubleBiFunction<T,U> fallback,
                                           Consumer<Exception> exceptionConsumer)

Returns a ToDoubleBiFunction applying the given function to the arguments if this function throws an exception.

Throws:

IllegalArgumentException - if fallback is null

Since:

1.0

orReturn

default ToDoubleBiFunction<T,U> orReturn(double value)

Returns a ToDoubleBiFunction returning the given value if this function throws an exception.

Since:

1.0

orReturn

default ToDoubleBiFunction<T,U> orReturn(double value,
                                         Consumer<Exception> exceptionConsumer)

Returns a ToDoubleBiFunction returning the given value if this function throws an exception.

Since:

1.0

orThrow

default ThrowingToDoubleBiFunction<T,U> orThrow(Class<? extends RuntimeException> exceptionClass)

Returns a ThrowingToDoubleBiFunction throwing an exception of the given type if this function throws an exception. The original exception thrown by this function is the cause of the thrown exception.

The exception class must have a constructor accepting a single Throwable as an argument.

Throws:

IllegalArgumentException - if exceptionClass is null

Since:

1.0

orThrow

default ThrowingToDoubleBiFunction<T,U> orThrow(Class<? extends RuntimeException> exceptionClass,
                                                String message)

Returns a ThrowingToDoubleBiFunction throwing an exception of the given type if this function throws an exception. The original exception thrown by this function is the cause of the thrown exception.

The exception class must have a constructor accepting String and Throwable as arguments.

Throws:

IllegalArgumentException - if exceptionClass is null

Since:

1.0

orTryWith

default ThrowingToDoubleBiFunction<T,U> orTryWith(ThrowingToDoubleBiFunction<? super T,? super U> other)

Returns a ThrowingToDoubleBiFunction applying the given function to the argument if this function throws an exception.

Throws:

IllegalArgumentException - if other is null

Since:

1.0

orTryWith

default ThrowingToDoubleBiFunction<T,U> orTryWith(ThrowingToDoubleBiFunction<? super T,? super U> other,
                                                  Consumer<Exception> exceptionConsumer)

Returns a ThrowingToDoubleBiFunction applying the given function to the argument if this function throws an exception.

Throws:

IllegalArgumentException - if other is null

Since:

1.0