org.slieb.throwables

Interface ToDoubleBiFunctionWithThrowable<T,U,E extends Throwable>

Type Parameters:

T - some generic flag

U - some generic flag

E - The extension

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 ToDoubleBiFunctionWithThrowable<T,U,E extends Throwable>
extends ToDoubleBiFunction<T,U>

Generated from ToDoubleBiFunction Extends java.util.function.ToDoubleBiFunction to allow for a checked exception.

Method Summary

Modifier and Type	Method and Description
default double	applyAsDouble(T v1, U v2) Overridden method of ToDoubleBiFunctionWithThrowable that will call applyAsDoubleWithThrowable, but catching any exceptions.
double	applyAsDoubleWithThrowable(T v1, U v2) Functional method that will throw exceptions.
static <T,U,E extends Throwable> ToDoubleBiFunctionWithThrowable<T,U,E>	asToDoubleBiFunctionWithThrowable(ToDoubleBiFunction<T,U> todoublebifunction) Utility method to convert ToDoubleBiFunctionWithThrowable
static <T,U,E extends Throwable> ToDoubleBiFunction<T,U>	aToDoubleBiFunctionThatUnsafelyThrowsUnchecked(ToDoubleBiFunctionWithThrowable<T,U,E> todoublebifunctionwiththrowable) Utility method to unwrap lambdas of type ToDoubleBiFunction and withUncheckedThrowable any Exception
static <T,U,E extends Throwable> ToDoubleBiFunctionWithThrowable<T,U,E>	castToDoubleBiFunctionWithThrowable(ToDoubleBiFunctionWithThrowable<T,U,E> todoublebifunctionwiththrowable) Utility method to mark lambdas of type ToDoubleBiFunctionWithThrowable
default ToDoubleBiFunctionWithThrowable<T,U,E>	onException(BiConsumer<Throwable,Object[]> consumer)
default ToDoubleBiFunctionWithThrowable<T,U,E>	onException(Consumer<Throwable> consumer)
default ToDoubleBiFunction<T,U>	thatReturnsOnCatch(double defaultReturnValue)
default BiFunction<T,U,OptionalDouble>	thatReturnsOptional()
default ToDoubleBiFunction<T,U>	thatUnsafelyThrowsUnchecked()
default ToDoubleBiFunctionWithThrowable<T,U,E>	withLogging() Will log WARNING level exceptions on logger if they occur within the interface
default ToDoubleBiFunctionWithThrowable<T,U,E>	withLogging(org.slf4j.Logger logger) Will log WARNING level exceptions on logger if they occur within the interface
default ToDoubleBiFunctionWithThrowable<T,U,E>	withLogging(org.slf4j.Logger logger, String message)

Method Detail

castToDoubleBiFunctionWithThrowable

static <T,U,E extends Throwable> ToDoubleBiFunctionWithThrowable<T,U,E> castToDoubleBiFunctionWithThrowable(ToDoubleBiFunctionWithThrowable<T,U,E> todoublebifunctionwiththrowable)

Utility method to mark lambdas of type ToDoubleBiFunctionWithThrowable

Type Parameters:

T - Generic that corresponds to the same generic on ToDoubleBiFunction

U - Generic that corresponds to the same generic on ToDoubleBiFunction

E - The type this interface is allowed to throw

Parameters:

todoublebifunctionwiththrowable - The interface instance

Returns:

the cast interface

aToDoubleBiFunctionThatUnsafelyThrowsUnchecked

static <T,U,E extends Throwable> ToDoubleBiFunction<T,U> aToDoubleBiFunctionThatUnsafelyThrowsUnchecked(ToDoubleBiFunctionWithThrowable<T,U,E> todoublebifunctionwiththrowable)
                                                                                                 throws E extends Throwable

Utility method to unwrap lambdas of type ToDoubleBiFunction and withUncheckedThrowable any Exception

Type Parameters:

T - Generic that corresponds to the same generic on ToDoubleBiFunction

U - Generic that corresponds to the same generic on ToDoubleBiFunction

E - The type this interface is allowed to throw

Parameters:

todoublebifunctionwiththrowable - The interface instance

Returns:

the cast interface

Throws:

E - the original Exception from todoublebifunctionwiththrowable

E extends Throwable

asToDoubleBiFunctionWithThrowable

static <T,U,E extends Throwable> ToDoubleBiFunctionWithThrowable<T,U,E> asToDoubleBiFunctionWithThrowable(ToDoubleBiFunction<T,U> todoublebifunction)

Utility method to convert ToDoubleBiFunctionWithThrowable

Type Parameters:

T - Generic that corresponds to the same generic on ToDoubleBiFunction

U - Generic that corresponds to the same generic on ToDoubleBiFunction

E - The type this interface is allowed to throw

Parameters:

todoublebifunction - The interface instance

Returns:

the cast interface

applyAsDouble

default double applyAsDouble(T v1,
                             U v2)

Overridden method of ToDoubleBiFunctionWithThrowable that will call applyAsDoubleWithThrowable, but catching any exceptions.

Specified by:

applyAsDouble in interface ToDoubleBiFunction<T,U>

Parameters:

v1 - parameter to overridden method

v2 - parameter to overridden method

Returns:

the value

applyAsDoubleWithThrowable

double applyAsDoubleWithThrowable(T v1,
                                  U v2)
                           throws E extends Throwable

Functional method that will throw exceptions.

Parameters:

v1 - parameter to overridden method

v2 - parameter to overridden method

Returns:

the value

Throws:

E - some exception

E extends Throwable

thatReturnsOptional

default BiFunction<T,U,OptionalDouble> thatReturnsOptional()

Returns:

An interface that will wrap the result in an optional, and return an empty optional when an exception occurs.

thatReturnsOnCatch

default ToDoubleBiFunction<T,U> thatReturnsOnCatch(double defaultReturnValue)

Parameters:

defaultReturnValue - A value to return if any throwable is caught.

Returns:

An interface that returns a default value if any exception occurs.

thatUnsafelyThrowsUnchecked

default ToDoubleBiFunction<T,U> thatUnsafelyThrowsUnchecked()
                                                     throws E extends Throwable

Returns:

An interface that is only returned if no exception has been thrown.

Throws:

E - if an exception E has been thrown, it is rethrown by this method

E extends Throwable

withLogging

default ToDoubleBiFunctionWithThrowable<T,U,E> withLogging(org.slf4j.Logger logger,
                                                           String message)

Parameters:

logger - The logger to log exceptions on

message - A message to use for logging exceptions

Returns:

An interface that will log all exceptions to given logger

withLogging

default ToDoubleBiFunctionWithThrowable<T,U,E> withLogging(org.slf4j.Logger logger)

Will log WARNING level exceptions on logger if they occur within the interface

Parameters:

logger - The logger instance to log exceptions on

Returns:

An interface that will log exceptions on given logger

withLogging

default ToDoubleBiFunctionWithThrowable<T,U,E> withLogging()

Will log WARNING level exceptions on logger if they occur within the interface

Returns:

An interface that will log exceptions on global logger

onException

default ToDoubleBiFunctionWithThrowable<T,U,E> onException(Consumer<Throwable> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger

onException

default ToDoubleBiFunctionWithThrowable<T,U,E> onException(BiConsumer<Throwable,Object[]> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger