Package ch.powerunit.extensions.exceptions

Interface BiFunctionWithException<T,U,R,E extends Exception>

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of the function

E - the type of the potential exception of the function

All Superinterfaces:

ExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunctionWithException<T,U,R,E>>, ObjectReturnExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunction<T,U,CompletionStage<R>>,R,BiFunctionWithException<T,U,R,E>>

All Known Subinterfaces:

BinaryOperatorWithException<T,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 BiFunctionWithException<T,U,R,E extends Exception>
extends ObjectReturnExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunction<T,U,CompletionStage<R>>,R,BiFunctionWithException<T,U,R,E>>

Represents a function that accepts two arguments, may thrown exception and produces a result. This is the two-arity specialization of FunctionWithException.

General contract

• R apply(T t, U u) throws E - The functional method.
• uncheck - Return a BiFunction<T,U,R>
• lift - Return a BiFunction<T,U,<Optional<R>>
• ignore - Return a BiFunction<T,U,R>

See Also:

BiFunction

Method Summary

Modifier and Type	Method	Description
default <V> BiFunctionWithException<T,U,V,E>	andThen(FunctionWithException<? super R,? extends V,? extends E> after)	Returns a composed FunctionWithException that first applies this FunctionWithException to its input, and then applies the after FunctionWithException to the result.
R	apply(T t, U u)	Applies this function to the given arguments.
default BiConsumerWithException<T,U,E>	asBiConsumer()	Converts a BiFunctionWithException to a BiConsumerWithException.
static <T,U,R,E extends Exception> BiConsumerWithException<T,U,E>	asBiConsumer(BiFunctionWithException<T,U,R,E> function)	Converts a BiFunctionWithException to a BiConsumerWithException.
static <T,U,R,E extends Exception> FunctionWithException<T,R,E>	asFunction(BiFunctionWithException<T,U,R,E> function, U u)	Converts a BiFunctionWithException to a FunctionWithException.
default FunctionWithException<T,R,E>	asFunction(U u)	Converts a BiFunctionWithException to a FunctionWithException.
static <T,U,R,E extends Exception> BiFunctionWithException<T,U,R,E>	failing(Supplier<E> exceptionBuilder)	Returns a FunctionWithException that always throw exception.
default BiFunction<T,U,R>	ignore()	Converts this BiFunctionWithException to a lifted BiFunction returning null (or the value redefined by the method ObjectReturnExceptionHandlerSupport.defaultValue()) in case of exception.
static <T,U,R,E extends Exception> BiFunction<T,U,R>	ignored(BiFunctionWithException<T,U,R,E> function)	Converts a BiFunctionWithException to a lifted BiFunction returning null in case of exception.
static <T,U,R,E extends Exception> BiFunction<T,U,R>	ignored(BiFunctionWithException<T,U,R,E> function, R defaultValue)	Converts a BiFunctionWithException to a lifted BiFunction returning a default in case of exception.
default BiFunction<T,U,Optional<R>>	lift()	Converts this BiFunctionWithException to a lifted BiFunction using Optional as return value.
static <T,U,R,E extends Exception> BiFunction<T,U,Optional<R>>	lifted(BiFunctionWithException<T,U,R,E> function)	Converts a BiFunctionWithException to a lifted BiFunction using Optional as return value.
default BiFunction<T,U,CompletionStage<R>>	stage()	Convert this BiFunctionWithException to a lifted BiFunction that uses CompletionStage as return value.
static <T,U,R,E extends Exception> BiFunction<T,U,CompletionStage<R>>	staged(BiFunctionWithException<T,U,R,E> function)	Convert this BiFunctionWithException to a lifted BiFunction return CompletionStage as return value.
default BiFunction<T,U,R>	uncheck()	Converts this BiFunctionWithException to a BiFunction that wraps exception to RuntimeException.
static <T,U,R,E extends Exception> BiFunction<T,U,R>	unchecked(BiFunctionWithException<T,U,R,E> function)	Converts a BiFunctionWithException to a BiFunction that convert exception to RuntimeException.
static <T,U,R,E extends Exception> BiFunction<T,U,R>	unchecked(BiFunctionWithException<T,U,R,E> function, Function<Exception,RuntimeException> exceptionMapper)	Converts a BiFunctionWithException to a BiFunction that convert exception to RuntimeException by using the provided mapping function.

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

documented, exceptionMapper

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

defaultValue, notThrowingHandler, throwingHandler

Method Detail

apply

R apply(T t,
        U u)
 throws E extends Exception

Applies this function to the given arguments.

Parameters:

t - the first function argument

u - the second function argument

Returns:

the function result

Throws:

E - any exception

E extends Exception

See Also:

BiFunction.apply(Object,Object)

uncheck

default BiFunction<T,U,R> uncheck()

Converts this BiFunctionWithException to a BiFunction that wraps exception to RuntimeException.

Specified by:

uncheck in interface ExceptionHandlerSupport<T,U,R>

Specified by:

uncheck in interface ObjectReturnExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunction<T,U,CompletionStage<R>>,R,BiFunctionWithException<T,U,R,E extends Exception>>

Returns:

the unchecked function

See Also:

unchecked(BiFunctionWithException), unchecked(BiFunctionWithException, Function), BiFunction

lift

default BiFunction<T,U,Optional<R>> lift()

Converts this BiFunctionWithException to a lifted BiFunction using Optional as return value.

Specified by:

lift in interface ExceptionHandlerSupport<T,U,R>

Specified by:

lift in interface ObjectReturnExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunction<T,U,CompletionStage<R>>,R,BiFunctionWithException<T,U,R,E extends Exception>>

Returns:

the lifted function

See Also:

lifted(BiFunctionWithException), BiFunction

ignore

default BiFunction<T,U,R> ignore()

Converts this BiFunctionWithException to a lifted BiFunction returning null (or the value redefined by the method ObjectReturnExceptionHandlerSupport.defaultValue()) in case of exception.

Specified by:

ignore in interface ExceptionHandlerSupport<T,U,R>

Specified by:

ignore in interface ObjectReturnExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunction<T,U,CompletionStage<R>>,R,BiFunctionWithException<T,U,R,E extends Exception>>

Returns:

the function that ignore error

See Also:

ignored(BiFunctionWithException), BiFunction

stage

default BiFunction<T,U,CompletionStage<R>> stage()

Convert this BiFunctionWithException to a lifted BiFunction that uses CompletionStage as return value.

Specified by:

stage in interface ObjectReturnExceptionHandlerSupport<BiFunction<T,U,R>,BiFunction<T,U,Optional<R>>,BiFunction<T,U,CompletionStage<R>>,R,BiFunctionWithException<T,U,R,E extends Exception>>

Returns:

the lifted function

See Also:

staged(BiFunctionWithException), BiFunction, CompletionStage

andThen

default <V> BiFunctionWithException<T,U,V,E> andThen(FunctionWithException<? super R,? extends V,? extends E> after)

Returns a composed FunctionWithException that first applies this FunctionWithException to its input, and then applies the after FunctionWithException to the result. If evaluation of either FunctionWithException throws an exception, it is relayed to the caller of the composed function.

Type Parameters:

V - the type of output of the after FunctionWithException, and of the composed FunctionWithException

Parameters:

after - the function to apply after this FunctionWithException is applied

Returns:

a composed function that first applies this function and then applies the after function

Throws:

NullPointerException - if after is null

See Also:

BiFunction.andThen(Function)

failing

static <T,U,R,E extends Exception> BiFunctionWithException<T,U,R,E> failing(Supplier<E> exceptionBuilder)

Returns a FunctionWithException that always throw exception.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of 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,U,R,E extends Exception> BiFunction<T,U,R> unchecked(BiFunctionWithException<T,U,R,E> function)

Converts a BiFunctionWithException to a BiFunction that convert exception to RuntimeException.

For example :

 BiFunction<String, String, String> biFunctionThrowingRuntimeException = BiFunctionWithException
                .unchecked(biFouctionThrowingException);
 

Will generate a BiFunction throwing RuntimeException in case of error.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of 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:

uncheck(), unchecked(BiFunctionWithException, Function)

unchecked

static <T,U,R,E extends Exception> BiFunction<T,U,R> unchecked(BiFunctionWithException<T,U,R,E> function,
                                                               Function<Exception,RuntimeException> exceptionMapper)

Converts a BiFunctionWithException to a BiFunction that convert exception to RuntimeException by using the provided mapping function.

For example :

 BiFunction<String, String, String> functionThrowingRuntimeException = BiFunctionWithException
                .unchecked(fonctionThrowingException, IllegalArgumentException::new);
 

Will generate a BiFunction throwing IllegalArgumentException in case of error.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of 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 exception

Throws:

NullPointerException - if function or exceptionMapper is null

See Also:

uncheck(), unchecked(BiFunctionWithException)

lifted

static <T,U,R,E extends Exception> BiFunction<T,U,Optional<R>> lifted(BiFunctionWithException<T,U,R,E> function)

Converts a BiFunctionWithException to a lifted BiFunction using Optional as return value.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of 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:

lift()

ignored

static <T,U,R,E extends Exception> BiFunction<T,U,R> ignored(BiFunctionWithException<T,U,R,E> function)

Converts a BiFunctionWithException to a lifted BiFunction returning null in case of exception.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of 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:

ignore()

ignored

static <T,U,R,E extends Exception> BiFunction<T,U,R> ignored(BiFunctionWithException<T,U,R,E> function,
                                                             R defaultValue)

Converts a BiFunctionWithException to a lifted BiFunction returning a default in case of exception.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of the function

E - the type of the potential exception

Parameters:

function - to be lifted

defaultValue - the value to be returned in case of error

Returns:

the lifted function

Throws:

NullPointerException - if function is null

Since:

3.0.0

See Also:

ignore(), ignored(BiFunctionWithException)

staged

static <T,U,R,E extends Exception> BiFunction<T,U,CompletionStage<R>> staged(BiFunctionWithException<T,U,R,E> function)

Convert this BiFunctionWithException to a lifted BiFunction return CompletionStage as return value.

Type Parameters:

T - the type of the first argument to the function

U - the type of the second argument to the function

R - the type of the result of 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:

stage()

asBiConsumer

static <T,U,R,E extends Exception> BiConsumerWithException<T,U,E> asBiConsumer(BiFunctionWithException<T,U,R,E> function)

Converts a BiFunctionWithException to a BiConsumerWithException.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

R - the type of the return value of the function

E - the type of the potential exception of the operation

Parameters:

function - to be converter

Returns:

the consumer

Throws:

NullPointerException - if function is null

Since:

1.2.0

asBiConsumer

default BiConsumerWithException<T,U,E> asBiConsumer()

Converts a BiFunctionWithException to a BiConsumerWithException.

Returns:

the consumer

Since:

1.2.0

asFunction

static <T,U,R,E extends Exception> FunctionWithException<T,R,E> asFunction(BiFunctionWithException<T,U,R,E> function,
                                                                           U u)

Converts a BiFunctionWithException to a FunctionWithException.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

R - the type of the return value of the function

E - the type of the potential exception of the operation

Parameters:

function - to be converter

u - the second parameter of the BiFunctionWithException that will be used inside the new {code FunctionWithException}.

Returns:

the consumer

Throws:

NullPointerException - if function is null

Since:

1.2.0

asFunction

default FunctionWithException<T,R,E> asFunction(U u)

Converts a BiFunctionWithException to a FunctionWithException.

Parameters:

u - the second parameter of the BiFunctionWithException that will be used inside the new {code FunctionWithException}.

Returns:

the consumer

Since:

1.2.0