Module powerunit.exceptions

Package ch.powerunit.extensions.exceptions

Interface LongToDoubleFunctionWithException<E extends Exception>

Type Parameters:

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<F,F>, PrimitiveReturnExceptionHandlerSupport<LongToDoubleFunction>

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 LongToDoubleFunctionWithException<E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<LongToDoubleFunction>

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

General contract

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

See Also:

LongToDoubleFunction

Method Summary

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

Method Detail

applyAsDouble

double applyAsDouble(long 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:

LongToDoubleFunction.applyAsDouble(long)

uncheckOrIgnore

default LongToDoubleFunction 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

uncheck

default LongToDoubleFunction uncheck()

Converts this LongToDoubleFunctionWithException to a LongToDoubleFunction that wraps exception to RuntimeException.

Specified by:

uncheck in interface ExceptionHandlerSupport<F,F>

Specified by:

uncheck in interface PrimitiveReturnExceptionHandlerSupport<E extends Exception>

Returns:

the unchecked function

See Also:

unchecked(LongToDoubleFunctionWithException), unchecked(LongToDoubleFunctionWithException, Function)

ignore

default LongToDoubleFunction ignore()

Converts this LongToDoubleFunctionWithException to a lifted LongToDoubleFunction returning 0 in case of exception.

Specified by:

ignore in interface ExceptionHandlerSupport<F,F>

Specified by:

ignore in interface PrimitiveReturnExceptionHandlerSupport<E extends Exception>

Returns:

the function that ignore error (return 0 in this case)

See Also:

ignored(LongToDoubleFunctionWithException)

failing

static <E extends Exception> LongToDoubleFunctionWithException<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> LongToDoubleFunction unchecked(LongToDoubleFunctionWithException<E> function)

Converts a LongToDoubleFunctionWithException to a LongToDoubleFunction that wraps exception to RuntimeException.

Type Parameters:

E - the type of the potential exception

Parameters:

function - to be unchecked

Returns:

the unchecked function

Throws:

NullPointerException - if function is null

See Also:

uncheck(), unchecked(LongToDoubleFunctionWithException, Function)

unchecked

static <E extends Exception> LongToDoubleFunction unchecked(LongToDoubleFunctionWithException<E> function,
                                                            Function<Exception,RuntimeException> exceptionMapper)

Converts a LongToDoubleFunctionWithException to a LongToDoubleFunction 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 is null

See Also:

uncheck(), unchecked(LongToDoubleFunctionWithException)

lifted

static <E extends Exception> LongToDoubleFunction lifted(LongToDoubleFunctionWithException<E> function)

Converts a LongToDoubleFunctionWithException to a lifted LongToDoubleFunction 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> LongToDoubleFunction ignored(LongToDoubleFunctionWithException<E> function)

Converts a LongToDoubleFunctionWithException to a lifted LongToDoubleFunction 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:

ignore()