Package ch.powerunit.extensions.exceptions

Interface LongBinaryOperatorWithException<E extends Exception>

Type Parameters:

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<LongBinaryOperator,LongBinaryOperator,LongBinaryOperatorWithException<E>>, PrimitiveReturnExceptionHandlerSupport<LongBinaryOperator,LongBinaryOperatorWithException<E>>

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 LongBinaryOperatorWithException<E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<LongBinaryOperator,LongBinaryOperatorWithException<E>>

Represents an operation upon two long-valued operands and producing a long-valued result which may throw exception. This is the primitive type specialization of BinaryOperatorWithException for long.

General contract

• long applyAsLong(long left, long right) throws E - The functional method.
• uncheck - Return a LongBinaryOperator
• lift - Return a LongBinaryOperator
• ignore - Return a LongBinaryOperator

See Also:

LongBinaryOperator

Method Summary

Modifier and Type	Method	Description
long	applyAsLong(long left, long right)	Applies this operator to the given operands.
default long	defaultValue()	Defines the default value returned by the ignore and ignored method.
static <E extends Exception> LongBinaryOperatorWithException<E>	failing(Supplier<E> exceptionBuilder)	Returns a function that always throw exception.
static <E extends Exception> LongBinaryOperator	ignored(LongBinaryOperatorWithException<E> function)	Converts a LongBinaryOperatorWithException to a lifted LongBinaryOperator with 0 as return value in case of exception.
static <E extends Exception> LongBinaryOperator	ignored(LongBinaryOperatorWithException<E> function, long defaultValue)	Converts a LongBinaryOperatorWithException to a lifted LongBinaryOperator with a default value as return value in case of exception.
static <E extends Exception> LongBinaryOperator	lifted(LongBinaryOperatorWithException<E> function)	Converts a LongBinaryOperatorWithException to a lifted LongBinaryOperator with 0 as return value in case of exception.
static <E extends Exception> LongBinaryOperator	unchecked(LongBinaryOperatorWithException<E> function)	Converts a LongBinaryOperatorWithException to a LongBinaryOperator that convert exception to RuntimeException.
static <E extends Exception> LongBinaryOperator	unchecked(LongBinaryOperatorWithException<E> function, Function<Exception,RuntimeException> exceptionMapper)	Converts a LongBinaryOperatorWithException to a LongBinaryOperator that convert exception to RuntimeException by using the provided mapping function.
default LongBinaryOperator	uncheckOrIgnore(boolean uncheck)	Used internally to implements the ignore or uncheck operation.

Methods inherited from interface ch.powerunit.extensions.exceptions.ExceptionHandlerSupport

documented, exceptionMapper

Methods inherited from interface ch.powerunit.extensions.exceptions.PrimitiveReturnExceptionHandlerSupport

ignore, lift, uncheck

Method Detail

applyAsLong

long applyAsLong(long left,
                 long right)
          throws E extends Exception

Applies this operator to the given operands.

Parameters:

left - the first operand

right - the second operand

Returns:

the operator result

Throws:

E - any exception

E extends Exception

See Also:

LongBinaryOperator.applyAsLong(long, long)

uncheckOrIgnore

default LongBinaryOperator uncheckOrIgnore(boolean uncheck)

Description copied from interface: PrimitiveReturnExceptionHandlerSupport

Used internally to implements the ignore or uncheck operation.

Specified by:

uncheckOrIgnore in interface PrimitiveReturnExceptionHandlerSupport<LongBinaryOperator,LongBinaryOperatorWithException<E extends Exception>>

Parameters:

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

Returns:

the function

failing

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

Converts a LongBinaryOperatorWithException to a LongBinaryOperator that convert 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(LongBinaryOperatorWithException, Function)

unchecked

static <E extends Exception> LongBinaryOperator unchecked(LongBinaryOperatorWithException<E> function,
                                                          Function<Exception,RuntimeException> exceptionMapper)

Converts a LongBinaryOperatorWithException to a LongBinaryOperator that convert 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(LongBinaryOperatorWithException)

lifted

static <E extends Exception> LongBinaryOperator lifted(LongBinaryOperatorWithException<E> function)

Converts a LongBinaryOperatorWithException to a lifted LongBinaryOperator with 0 as return value 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> LongBinaryOperator ignored(LongBinaryOperatorWithException<E> function)

Converts a LongBinaryOperatorWithException to a lifted LongBinaryOperator with 0 as return value 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()

ignored

static <E extends Exception> LongBinaryOperator ignored(LongBinaryOperatorWithException<E> function,
                                                        long defaultValue)

Converts a LongBinaryOperatorWithException to a lifted LongBinaryOperator with a default value as return value in case of exception.

Type Parameters:

E - the type of the potential exception

Parameters:

function - to be lifted

defaultValue - value in case of exception

Returns:

the lifted function

Throws:

NullPointerException - if function is null

Since:

3.0.0

See Also:

PrimitiveReturnExceptionHandlerSupport.ignore(), ignored(LongBinaryOperatorWithException)

defaultValue

default long defaultValue()

Defines the default value returned by the ignore and ignored method.

Returns:

the default value for the ignore/ignored method.

Since:

3.0.0