Module powerunit.exceptions

Package ch.powerunit.extensions.exceptions

Interface IntToDoubleFunctionWithException<E extends Exception>

Type Parameters:

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<F,F>, PrimitiveReturnExceptionHandlerSupport<IntToDoubleFunction>

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 IntToDoubleFunctionWithException<E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<IntToDoubleFunction>

Represents a function that accepts an int-valued argument, may throw an exception and produces a double-valued result. This is the int-to-double primitive specialization for FunctionWithException.

General contract

• double applyAsDouble(int value) throws E - The functional method.
• uncheck - Return a IntToDoubleFunction
• lift - Return a IntToDoubleFunction
• ignore - Return a IntToDoubleFunction

See Also:

IntToDoubleFunction

Method Summary

Modifier and Type	Method	Description
double	applyAsDouble(int value)	Applies this function to the given argument.
static <E extends Exception> IntToDoubleFunctionWithException<E>	failing(Supplier<E> exceptionBuilder)	Returns a function that always throw exception.
static <E extends Exception> IntToDoubleFunction	ignored(IntToDoubleFunctionWithException<E> function)	Converts a IntToDoubleFunctionWithException to a lifted IntToDoubleFunction returning 0 in case of exception.
static <E extends Exception> IntToDoubleFunction	lifted(IntToDoubleFunctionWithException<E> function)	Converts a IntToDoubleFunctionWithException to a lifted IntToDoubleFunction returning 0 in case of exception.
static <E extends Exception> IntToDoubleFunction	unchecked(IntToDoubleFunctionWithException<E> function)	Converts a IntToDoubleFunctionWithException to a IntToDoubleFunction that wraps exception to RuntimeException.
static <E extends Exception> IntToDoubleFunction	unchecked(IntToDoubleFunctionWithException<E> function, Function<Exception,RuntimeException> exceptionMapper)	Converts a IntToDoubleFunctionWithException to a IntToDoubleFunction that wraps exception to RuntimeException by using the provided mapping function.
default IntToDoubleFunction	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(int 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:

IntToDoubleFunction.applyAsDouble(int)

uncheckOrIgnore

default IntToDoubleFunction uncheckOrIgnore(boolean uncheck)

Description copied from interface: PrimitiveReturnExceptionHandlerSupport

Used internally to implements the ignore or uncheck operation.

Specified by:

uncheckOrIgnore in interface PrimitiveReturnExceptionHandlerSupport<E extends Exception>

Parameters:

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

Returns:

the function

failing

static <E extends Exception> IntToDoubleFunctionWithException<E> failing(Supplier<E> exceptionBuilder)

Returns a function that always throw exception.

Type Parameters:

E - the type of the exception

Parameters:

exceptionBuilder - the supplier to create the exception

Returns:

a function that always throw exception

unchecked

static <E extends Exception> IntToDoubleFunction unchecked(IntToDoubleFunctionWithException<E> function)

Converts a IntToDoubleFunctionWithException to a IntToDoubleFunction that wraps exception to RuntimeException.

Type Parameters:

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(IntToDoubleFunctionWithException, Function)

unchecked

static <E extends Exception> IntToDoubleFunction unchecked(IntToDoubleFunctionWithException<E> function,
                                                           Function<Exception,RuntimeException> exceptionMapper)

Converts a IntToDoubleFunctionWithException to a IntToDoubleFunction that wraps exception to RuntimeException by using the provided mapping function.

Type Parameters:

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(IntToDoubleFunctionWithException)

lifted

static <E extends Exception> IntToDoubleFunction lifted(IntToDoubleFunctionWithException<E> function)

Converts a IntToDoubleFunctionWithException to a lifted IntToDoubleFunction returning 0 in case of exception.

Type Parameters:

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 <E extends Exception> IntToDoubleFunction ignored(IntToDoubleFunctionWithException<E> function)

Converts a IntToDoubleFunctionWithException to a lifted IntToDoubleFunction returning 0 in case of exception.

Type Parameters:

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()