Module powerunit.exceptions

Package ch.powerunit.extensions.exceptions

Interface ToLongFunctionWithException<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<ToLongFunction<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 ToLongFunctionWithException<T,E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<ToLongFunction<T>>

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

General contract

• long applyAsLong(T value) throws E - The functional method.
• uncheck - Return a ToLongFunction<T>
• lift - Return a ToLongFunction<T>
• ignore - Return a ToLongFunction<T>

See Also:

ToLongFunction

Method Summary

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

applyAsLong

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

ToLongFunction.applyAsLong(Object)

uncheckOrIgnore

default ToLongFunction<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> ToLongFunctionWithException<T,E> failing(Supplier<E> exceptionBuilder)

Returns a function that always throw exception.

Type Parameters:

T - the type of the input object 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> ToLongFunction<T> unchecked(ToLongFunctionWithException<T,E> function)

Converts a ToLongFunctionException to a ToLongFunction that wraps exception to RuntimeException.

Type Parameters:

T - the type of the input object 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(ToLongFunctionWithException, Function)

unchecked

static <T,E extends Exception> ToLongFunction<T> unchecked(ToLongFunctionWithException<T,E> function,
                                                           Function<Exception,RuntimeException> exceptionMapper)

Converts a ToLongFunctionWithException to a ToLongFunction that wraps exception to RuntimeException by using the provided mapping function.

Type Parameters:

T - the type of the input object 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(ToLongFunctionWithException)

lifted

static <T,E extends Exception> ToLongFunction<T> lifted(ToLongFunctionWithException<T,E> function)

Converts a ToLongFunctionWithException to a lifted ToLongFunction returning 0 in case of exception.

Type Parameters:

T - the type of the input object 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> ToLongFunction<T> ignored(ToLongFunctionWithException<T,E> function)

Converts a ToLongFunctionWithException to a lifted ToLongFunction returning 0 in case of exception.

Type Parameters:

T - the type of the input object 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()