Module powerunit.exceptions

Package ch.powerunit.extensions.exceptions

Interface ToDoubleFunctionWithException<T,E extends Exception>

Type Parameters:

T - the type of the input to the function

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<T,E>, PrimitiveReturnExceptionHandlerSupport<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 ToDoubleFunctionWithException<T,E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<ToDoubleFunction<T>>

Represents a function that produces a double-valued result, may throw exception. This is the double-producing primitive specialization for FunctionWithException.

General contract

• double applyAsDouble(T value) throws E - The functional method.
• uncheck - Return a ToDoubleFunction<T>
• lift - Return a ToDoubleFunction<T>
• ignore - Return a ToDoubleFunction<T>

See Also:

ToDoubleFunction

Method Summary

Modifier and Type	Method	Description
double	applyAsDouble(T value)	Applies this function to the given argument.
static <T,E extends Exception> ToDoubleFunctionWithException<T,E>	failing(Supplier<E> exceptionBuilder)	Returns a function that always throw exception.
static <T,E extends Exception> ToDoubleFunction<T>	ignored(ToDoubleFunctionWithException<T,E> function)	Converts a ToDoubleFunctionWithException to a lifted ToDoubleFunction returning 0 in case of exception.
static <T,E extends Exception> ToDoubleFunction<T>	lifted(ToDoubleFunctionWithException<T,E> function)	Converts a ToDoubleFunctionWithException to a lifted ToDoubleFunction returning 0 in case of exception.
static <T,E extends Exception> ToDoubleFunction<T>	unchecked(ToDoubleFunctionWithException<T,E> function)	Converts a ToDoubleFunctionException to a ToDoubleFunction that convert exception to RuntimeException.
static <T,E extends Exception> ToDoubleFunction<T>	unchecked(ToDoubleFunctionWithException<T,E> function, Function<Exception,RuntimeException> exceptionMapper)	Converts a ToDoubleFunctionWithException to a ToDoubleFunction that convert exception to RuntimeException by using the provided mapping function.
default ToDoubleFunction<T>	uncheckOrIgnore(boolean uncheck)	Used internally to implements the ignore or uncheck operation.

Methods inherited from interface ch.powerunit.extensions.exceptions.ExceptionHandlerSupport

exceptionMapper, exceptionMapperFor

Methods inherited from interface ch.powerunit.extensions.exceptions.PrimitiveReturnExceptionHandlerSupport

handleException, ignore, lift, uncheck

Method Detail

applyAsDouble

double applyAsDouble(T value)
              throws E extends Exception

Applies this function to the given argument.

Parameters:

value - the function argument

Returns:

the function result

Throws:

E - any exception

E extends Exception

See Also:

ToDoubleFunction.applyAsDouble(Object)

uncheckOrIgnore

default ToDoubleFunction<T> uncheckOrIgnore(boolean uncheck)

Description copied from interface: PrimitiveReturnExceptionHandlerSupport

Used internally to implements the ignore or uncheck operation.

Specified by:

uncheckOrIgnore in interface PrimitiveReturnExceptionHandlerSupport<T>

Parameters:

uncheck - create unchecked version of the function when true, else ignored version.

Returns:

the function

failing

static <T,E extends Exception> ToDoubleFunctionWithException<T,E> failing(Supplier<E> exceptionBuilder)

Returns a function that always throw exception.

Type Parameters:

T - the type of the input to the function

E - the type of the exception

Parameters:

exceptionBuilder - the supplier to create the exception

Returns:

a function that always throw exception

unchecked

static <T,E extends Exception> ToDoubleFunction<T> unchecked(ToDoubleFunctionWithException<T,E> function)

Converts a ToDoubleFunctionException to a ToDoubleFunction that convert exception to RuntimeException.

Type Parameters:

T - the type of the input to the function

E - the type of the potential exception

Parameters:

function - to be unchecked

Returns:

the unchecked exception

Throws:

NullPointerException - if function is null

See Also:

PrimitiveReturnExceptionHandlerSupport.uncheck(), unchecked(ToDoubleFunctionWithException, Function)

unchecked

static <T,E extends Exception> ToDoubleFunction<T> unchecked(ToDoubleFunctionWithException<T,E> function,
                                                             Function<Exception,RuntimeException> exceptionMapper)

Converts a ToDoubleFunctionWithException to a ToDoubleFunction that convert exception to RuntimeException by using the provided mapping function.

Type Parameters:

T - the type of the input to the function

E - the type of the potential exception

Parameters:

function - the be unchecked

exceptionMapper - a function to convert the exception to the runtime exception.

Returns:

the unchecked function

Throws:

NullPointerException - if function or exceptionMapper is null

See Also:

PrimitiveReturnExceptionHandlerSupport.uncheck(), unchecked(ToDoubleFunctionWithException)

lifted

static <T,E extends Exception> ToDoubleFunction<T> lifted(ToDoubleFunctionWithException<T,E> function)

Converts a ToDoubleFunctionWithException to a lifted ToDoubleFunction returning 0 in case of exception.

Type Parameters:

T - the type of the input to the function

E - the type of the potential exception

Parameters:

function - to be lifted

Returns:

the lifted function

Throws:

NullPointerException - if function is null

See Also:

PrimitiveReturnExceptionHandlerSupport.lift()

ignored

static <T,E extends Exception> ToDoubleFunction<T> ignored(ToDoubleFunctionWithException<T,E> function)

Converts a ToDoubleFunctionWithException to a lifted ToDoubleFunction returning 0 in case of exception.

Type Parameters:

T - the type of the input to the function

E - the type of the potential exception

Parameters:

function - to be lifted

Returns:

the lifted function

Throws:

NullPointerException - if function is null

See Also:

PrimitiveReturnExceptionHandlerSupport.ignore()