Module powerunit.exceptions

Package ch.powerunit.extensions.exceptions

Interface LongToIntFunctionWithException<E extends Exception>

Type Parameters:

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<F,F>, PrimitiveReturnExceptionHandlerSupport<LongToIntFunction>

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 LongToIntFunctionWithException<E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<LongToIntFunction>

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

General contract

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

See Also:

LongToIntFunction

Method Summary

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

applyAsInt

int applyAsInt(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:

LongToIntFunction.applyAsInt(long)

uncheckOrIgnore

default LongToIntFunction 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 LongToIntFunction uncheck()

Converts this LongToIntFunctionWithException to a LongToIntFunction 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(LongToIntFunctionWithException), unchecked(LongToIntFunctionWithException, Function)

ignore

default LongToIntFunction ignore()

Converts this LongToIntFunctionWithException to a lifted LongToIntFunction 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 ignoring function

See Also:

ignored(LongToIntFunctionWithException)

failing

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

Converts a LongToIntFunctionWithException to a LongToIntFunction 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(LongToIntFunctionWithException, Function)

unchecked

static <E extends Exception> LongToIntFunction unchecked(LongToIntFunctionWithException<E> function,
                                                         Function<Exception,RuntimeException> exceptionMapper)

Converts a LongToIntFunctionWithException to a LongToIntFunction 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:

uncheck(), unchecked(LongToIntFunctionWithException)

lifted

static <E extends Exception> LongToIntFunction lifted(LongToIntFunctionWithException<E> function)

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

Converts a LongToIntFunctionWithException to a lifted LongToIntFunction 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()