org.slieb.throwables

Interface ToDoubleFunctionWithThrowable<T,E extends Throwable>

Type Parameters:

T - some generic flag

E - The extension

All Superinterfaces:

ToDoubleFunction<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 ToDoubleFunctionWithThrowable<T,E extends Throwable>
extends ToDoubleFunction<T>

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

Method Summary

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

Method Detail

castToDoubleFunctionWithThrowable

static <T,E extends Throwable> ToDoubleFunctionWithThrowable<T,E> castToDoubleFunctionWithThrowable(ToDoubleFunctionWithThrowable<T,E> todoublefunctionwiththrowable)

Utility method to mark lambdas of type ToDoubleFunctionWithThrowable

Type Parameters:

T - Generic that corresponds to the same generic on ToDoubleFunction

E - The type this interface is allowed to throw

Parameters:

todoublefunctionwiththrowable - The interface instance

Returns:

the cast interface

aToDoubleFunctionThatUnsafelyThrowsUnchecked

static <T,E extends Throwable> ToDoubleFunction<T> aToDoubleFunctionThatUnsafelyThrowsUnchecked(ToDoubleFunctionWithThrowable<T,E> todoublefunctionwiththrowable)
                                                                                         throws E extends Throwable

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

Type Parameters:

T - Generic that corresponds to the same generic on ToDoubleFunction

E - The type this interface is allowed to throw

Parameters:

todoublefunctionwiththrowable - The interface instance

Returns:

the cast interface

Throws:

E - the original Exception from todoublefunctionwiththrowable

E extends Throwable

asToDoubleFunctionWithThrowable

static <T,E extends Throwable> ToDoubleFunctionWithThrowable<T,E> asToDoubleFunctionWithThrowable(ToDoubleFunction<T> todoublefunction)

Utility method to convert ToDoubleFunctionWithThrowable

Type Parameters:

T - Generic that corresponds to the same generic on ToDoubleFunction

E - The type this interface is allowed to throw

Parameters:

todoublefunction - The interface instance

Returns:

the cast interface

applyAsDouble

default double applyAsDouble(T v1)

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

Specified by:

applyAsDouble in interface ToDoubleFunction<T>

Parameters:

v1 - parameter to overridden method

Returns:

the value

applyAsDoubleWithThrowable

double applyAsDoubleWithThrowable(T v1)
                           throws E extends Throwable

Functional method that will throw exceptions.

Parameters:

v1 - parameter to overridden method

Returns:

the value

Throws:

E - some exception

E extends Throwable

thatReturnsOptional

default Function<T,OptionalDouble> thatReturnsOptional()

Returns:

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

thatReturnsOnCatch

default ToDoubleFunction<T> 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 ToDoubleFunction<T> 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 ToDoubleFunctionWithThrowable<T,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 ToDoubleFunctionWithThrowable<T,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 ToDoubleFunctionWithThrowable<T,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 ToDoubleFunctionWithThrowable<T,E> onException(Consumer<Throwable> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger

onException

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

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger