Module powerunit.exceptions

Package ch.powerunit.extensions.exceptions

Interface IntToLongFunctionWithException<E extends Exception>

Type Parameters:

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<F,F>, PrimitiveReturnExceptionHandlerSupport<IntToLongFunction>

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 IntToLongFunctionWithException<E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<IntToLongFunction>

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

General contract

• long applyAsLong(int value) throws E - The functional method.
• uncheck - Return a IntToLongFunction
• lift - Return a IntToLongFunction
• ignore - Return a IntToLongFunction

See Also:

IntToLongFunction

Method Summary

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

applyAsLong

long applyAsLong(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:

IntToLongFunction.applyAsLong(int)

uncheckOrIgnore

default IntToLongFunction 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> IntToLongFunctionWithException<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> IntToLongFunction unchecked(IntToLongFunctionWithException<E> function)

Converts a IntToLongFunctionWithException to a IntToLongFunction 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:

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

unchecked

static <E extends Exception> IntToLongFunction unchecked(IntToLongFunctionWithException<E> function,
                                                         Function<Exception,RuntimeException> exceptionMapper)

Converts a IntToLongFunctionWithException to a IntToLongFunction 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(IntToLongFunctionWithException)

lifted

static <E extends Exception> IntToLongFunction lifted(IntToLongFunctionWithException<E> function)

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

Converts a IntToLongFunctionWithException to a lifted IntToLongFunction 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()