org.slieb.throwables

Interface DoubleFunctionWithThrowable<R,E extends Throwable>

Type Parameters:

R - some generic flag

E - The extension

All Superinterfaces:

DoubleFunction<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 DoubleFunctionWithThrowable<R,E extends Throwable>
extends DoubleFunction<R>

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

Method Summary

Modifier and Type	Method and Description
static <R,E extends Throwable> DoubleFunction<R>	aDoubleFunctionThatUnsafelyThrowsUnchecked(DoubleFunctionWithThrowable<R,E> doublefunctionwiththrowable) Utility method to unwrap lambdas of type DoubleFunction and withUncheckedThrowable any Exception
default R	apply(double v1) Overridden method of DoubleFunctionWithThrowable that will call applyWithThrowable, but catching any exceptions.
R	applyWithThrowable(double v1) Functional method that will throw exceptions.
static <R,E extends Throwable> DoubleFunctionWithThrowable<R,E>	asDoubleFunctionWithThrowable(DoubleFunction<R> doublefunction) Utility method to convert DoubleFunctionWithThrowable
static <R,E extends Throwable> DoubleFunctionWithThrowable<R,E>	castDoubleFunctionWithThrowable(DoubleFunctionWithThrowable<R,E> doublefunctionwiththrowable) Utility method to mark lambdas of type DoubleFunctionWithThrowable
default DoubleFunctionWithThrowable<R,E>	onException(BiConsumer<Throwable,Object[]> consumer)
default DoubleFunctionWithThrowable<R,E>	onException(Consumer<Throwable> consumer)
default DoubleFunction<R>	thatReturnsOnCatch(R defaultReturnValue)
default DoubleFunction<Optional<R>>	thatReturnsOptional()
default DoubleFunction<R>	thatUnsafelyThrowsUnchecked()
default DoubleFunctionWithThrowable<R,E>	withLogging() Will log WARNING level exceptions on logger if they occur within the interface
default DoubleFunctionWithThrowable<R,E>	withLogging(org.slf4j.Logger logger) Will log WARNING level exceptions on logger if they occur within the interface
default DoubleFunctionWithThrowable<R,E>	withLogging(org.slf4j.Logger logger, String message)

Method Detail

castDoubleFunctionWithThrowable

static <R,E extends Throwable> DoubleFunctionWithThrowable<R,E> castDoubleFunctionWithThrowable(DoubleFunctionWithThrowable<R,E> doublefunctionwiththrowable)

Utility method to mark lambdas of type DoubleFunctionWithThrowable

Type Parameters:

R - Generic that corresponds to the same generic on DoubleFunction

E - The type this interface is allowed to throw

Parameters:

doublefunctionwiththrowable - The interface instance

Returns:

the cast interface

aDoubleFunctionThatUnsafelyThrowsUnchecked

static <R,E extends Throwable> DoubleFunction<R> aDoubleFunctionThatUnsafelyThrowsUnchecked(DoubleFunctionWithThrowable<R,E> doublefunctionwiththrowable)
                                                                                     throws E extends Throwable

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

Type Parameters:

R - Generic that corresponds to the same generic on DoubleFunction

E - The type this interface is allowed to throw

Parameters:

doublefunctionwiththrowable - The interface instance

Returns:

the cast interface

Throws:

E - the original Exception from doublefunctionwiththrowable

E extends Throwable

asDoubleFunctionWithThrowable

static <R,E extends Throwable> DoubleFunctionWithThrowable<R,E> asDoubleFunctionWithThrowable(DoubleFunction<R> doublefunction)

Utility method to convert DoubleFunctionWithThrowable

Type Parameters:

R - Generic that corresponds to the same generic on DoubleFunction

E - The type this interface is allowed to throw

Parameters:

doublefunction - The interface instance

Returns:

the cast interface

apply

default R apply(double v1)

Overridden method of DoubleFunctionWithThrowable that will call applyWithThrowable, but catching any exceptions.

Specified by:

apply in interface DoubleFunction<R>

Parameters:

v1 - parameter to overridden method

Returns:

the value

applyWithThrowable

R applyWithThrowable(double 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 DoubleFunction<Optional<R>> thatReturnsOptional()

Returns:

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

thatReturnsOnCatch

default DoubleFunction<R> thatReturnsOnCatch(R 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 DoubleFunction<R> 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 DoubleFunctionWithThrowable<R,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 DoubleFunctionWithThrowable<R,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 DoubleFunctionWithThrowable<R,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 DoubleFunctionWithThrowable<R,E> onException(Consumer<Throwable> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger

onException

default DoubleFunctionWithThrowable<R,E> onException(BiConsumer<Throwable,Object[]> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger