Module com.github.robtimus.function.throwing

Package com.github.robtimus.function.throwing

Interface ThrowingDoubleFunction<R,X extends Throwable>

Type Parameters:

R - The type of the result of the function.

X - The type of checked exception that can be thrown.

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 ThrowingDoubleFunction<R,X extends Throwable>

Represents a function that accepts a double-valued argument and produces a result. This is a checked-exception throwing equivalent of DoubleFunction.

Method Summary

Modifier and Type	Method	Description
R	apply(double value)	Applies this function to the given argument.
static <R,X extends Throwable> ThrowingDoubleFunction<R,X>	checked(DoubleFunction<? extends R> function)	Returns a function that applies the function function to its input.
static <R,X extends Throwable> ThrowingDoubleFunction<R,X>	checked(DoubleFunction<? extends R> function, Class<X> errorType)	Returns a function that applies the function function to its input.
static <R,X extends Throwable> ThrowingDoubleFunction<R,X>	of(ThrowingDoubleFunction<R,X> function)	Factory method for turning ThrowingDoubleFunction-shaped lambdas into ThrowingDoubleFunctions.
default <E extends Throwable> ThrowingDoubleFunction<R,E>	onErrorApplyChecked(ThrowingDoubleFunction<? extends R,? extends E> fallback)	Returns a function that applies this function to its input.
default DoubleFunction<R>	onErrorApplyUnchecked(DoubleFunction<? extends R> fallback)	Returns a function that applies this function to its input.
default <E extends Throwable> ThrowingDoubleFunction<R,E>	onErrorGetChecked(ThrowingSupplier<? extends R,? extends E> fallback)	Returns a function that applies this function to its input.
default DoubleFunction<R>	onErrorGetUnchecked(Supplier<? extends R> fallback)	Returns a function that applies this function to its input.
default <E extends Throwable> ThrowingDoubleFunction<R,E>	onErrorHandleChecked(ThrowingFunction<? super X,? extends R,? extends E> errorHandler)	Returns a function that applies this function to its input.
default DoubleFunction<R>	onErrorHandleUnchecked(Function<? super X,? extends R> errorHandler)	Returns a function that applies this function to its input.
default DoubleFunction<R>	onErrorReturn(R fallback)	Returns a function that applies this function to its input.
default <E extends Throwable> ThrowingDoubleFunction<R,E>	onErrorThrowAsChecked(Function<? super X,? extends E> errorMapper)	Returns a function that applies this function to its input.
default <E extends RuntimeException> DoubleFunction<R>	onErrorThrowAsUnchecked(Function<? super X,? extends E> errorMapper)	Returns a function that applies this function to its input.
default DoubleFunction<R>	unchecked()	Returns a function that applies this function to its input.
static <R> DoubleFunction<R>	unchecked(ThrowingDoubleFunction<? extends R,?> function)	Returns a function that applies the function function to its input.

Method Detail

apply

R apply(double value)
 throws X extends Throwable

Applies this function to the given argument.

Parameters:

value - The function argument.

Returns:

The function result.

Throws:

X - If an error occurs.

X extends Throwable

onErrorThrowAsChecked

default <E extends Throwable> ThrowingDoubleFunction<R,E> onErrorThrowAsChecked(Function<? super X,? extends E> errorMapper)

Returns a function that applies this function to its input. Any checked exception thrown by this function is transformed using the given error mapper, and the returned function throws the transformation result.

Type Parameters:

E - The type of checked exception to transform to.

Parameters:

errorMapper - The function to use to transform any checked exception thrown by this function.

Returns:

A function that transforms any thrown checked exception.

Throws:

NullPointerException - If errorMapper is null.

onErrorThrowAsUnchecked

default <E extends RuntimeException> DoubleFunction<R> onErrorThrowAsUnchecked(Function<? super X,? extends E> errorMapper)

Returns a function that applies this function to its input. Any checked exception thrown by this function is transformed using the given error mapper, and the returned function throws the transformation result.

Type Parameters:

E - The type of unchecked exception to transform to.

Parameters:

errorMapper - The function to use to transform any checked exception thrown by this function.

Returns:

A function that transforms any thrown checked exception.

Throws:

NullPointerException - If errorMapper is null.

onErrorHandleChecked

default <E extends Throwable> ThrowingDoubleFunction<R,E> onErrorHandleChecked(ThrowingFunction<? super X,? extends R,? extends E> errorHandler)

Returns a function that applies this function to its input. Any checked exception thrown by this function is transformed using the given error handler, and the returned function returns the transformation result.

Type Parameters:

E - The type of checked exception that can be thrown by the given error handler.

Parameters:

errorHandler - The function to use to transform any checked exception thrown by this function.

Returns:

A function that transforms any thrown checked exception.

Throws:

NullPointerException - If errorHandler is null.

onErrorHandleUnchecked

default DoubleFunction<R> onErrorHandleUnchecked(Function<? super X,? extends R> errorHandler)

Returns a function that applies this function to its input. Any checked exception thrown by this function is transformed using the given error handler, and the returned function returns the transformation result.

Parameters:

errorHandler - The function to use to transform any checked exception thrown by this function.

Returns:

A function that transforms any thrown checked exception.

Throws:

NullPointerException - If errorHandler is null.

onErrorApplyChecked

default <E extends Throwable> ThrowingDoubleFunction<R,E> onErrorApplyChecked(ThrowingDoubleFunction<? extends R,? extends E> fallback)

Returns a function that applies this function to its input. If this function throws any checked exception, it is discarded and the given fallback function is invoked.

Type Parameters:

E - The type of checked exception that can be thrown by the given fallback function.

Parameters:

fallback - The function to invoke if this function throws any checked exception.

Returns:

A function that invokes the fallback function if this function throws any checked exception.

Throws:

NullPointerException - If fallback is null.

onErrorApplyUnchecked

default DoubleFunction<R> onErrorApplyUnchecked(DoubleFunction<? extends R> fallback)

Returns a function that applies this function to its input. If this function throws any checked exception, it is discarded and the given fallback function is invoked.

Parameters:

fallback - The function to invoke if this function throws any checked exception.

Returns:

A function that invokes the fallback function if this function throws any checked exception.

Throws:

NullPointerException - If fallback is null.

onErrorGetChecked

default <E extends Throwable> ThrowingDoubleFunction<R,E> onErrorGetChecked(ThrowingSupplier<? extends R,? extends E> fallback)

Returns a function that applies this function to its input. If this function throws any checked exception, it is discarded and the given fallback supplier is invoked.

Type Parameters:

E - The type of checked exception that can be thrown by the given fallback supplier.

Parameters:

fallback - The supplier to produce the value to return if this function throws any checked exception.

Returns:

A function that invokes the fallback supplier if this function throws any checked exception.

Throws:

NullPointerException - If fallback is null.

onErrorGetUnchecked

default DoubleFunction<R> onErrorGetUnchecked(Supplier<? extends R> fallback)

Returns a function that applies this function to its input. If this function throws any checked exception, it is discarded and the given fallback supplier is invoked.

Parameters:

fallback - The supplier to produce the value to return if this function throws any checked exception.

Returns:

A function that invokes the fallback supplier if this function throws any checked exception.

Throws:

NullPointerException - If fallback is null.

onErrorReturn

default DoubleFunction<R> onErrorReturn(R fallback)

Returns a function that applies this function to its input. If this function throws any checked exception, it is discarded and the given fallback value is returned.

Parameters:

fallback - The value to return if this function throws any checked exception.

Returns:

A function that returns the fallback value if this function throws any checked exception.

unchecked

default DoubleFunction<R> unchecked()

Returns a function that applies this function to its input. Any checked exception thrown by this function is wrapped in an UncheckedException without a stack trace.

Returns:

A function that wraps any checked exception in an UncheckedException.

of

static <R,X extends Throwable> ThrowingDoubleFunction<R,X> of(ThrowingDoubleFunction<R,X> function)

Factory method for turning ThrowingDoubleFunction-shaped lambdas into ThrowingDoubleFunctions.

Type Parameters:

R - The type of the result of the function.

X - The type of checked exception that can be thrown.

Parameters:

function - The lambda to return as ThrowingDoubleFunction.

Returns:

The given lambda as a ThrowingDoubleFunction.

Throws:

NullPointerException - If function is null.

unchecked

static <R> DoubleFunction<R> unchecked(ThrowingDoubleFunction<? extends R,?> function)

Returns a function that applies the function function to its input. Any checked exception thrown by the function function is wrapped in an UncheckedException.

Type Parameters:

R - The type of the result of the function.

Parameters:

function - The function to apply when the returned function is applied.

Returns:

A function that wraps any checked exception in an UncheckedException.

Throws:

NullPointerException - If function is null.

checked

static <R,X extends Throwable> ThrowingDoubleFunction<R,X> checked(DoubleFunction<? extends R> function)

Returns a function that applies the function function to its input. Any unchecked exception thrown by the function function is relayed to the caller. This method allows existing DoubleFunction instances to be used where ThrowingDoubleFunction is expected.

Type Parameters:

R - The type of the result of the function.

X - The type of checked exception that can be thrown.

Parameters:

function - The function to apply when the returned function is applied.

Returns:

A function that wraps any checked exception in an UncheckedException.

Throws:

NullPointerException - If function is null.

checked

static <R,X extends Throwable> ThrowingDoubleFunction<R,X> checked(DoubleFunction<? extends R> function,
                                                                               Class<X> errorType)

Returns a function that applies the function function to its input. Any UncheckedException thrown by the function function is unwrapped if its cause is an instance of errorType, otherwise it is relayed to the caller.

Type Parameters:

R - The type of the result of the function.

X - The type of checked exception that can be thrown.

Parameters:

function - The function to apply when the returned function is applied.

errorType - The type of checked exception that can be thrown.

Returns:

A function that wraps any checked exception in an UncheckedException.

Throws:

NullPointerException - If function or errorType is null.