Package ch.powerunit.extensions.exceptions

Interface BiConsumerWithException<T,U,E extends Exception>

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception of the operation

All Superinterfaces:

ExceptionHandlerSupport<BiConsumer<T,U>,BiConsumer<T,U>,BiConsumerWithException<T,U,E>>, NoReturnExceptionHandlerSupport<BiConsumer<T,U>,BiFunction<T,U,CompletionStage<Void>>,BiConsumerWithException<T,U,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 BiConsumerWithException<T,U,E extends Exception>
extends NoReturnExceptionHandlerSupport<BiConsumer<T,U>,BiFunction<T,U,CompletionStage<Void>>,BiConsumerWithException<T,U,E>>

Represents an operation that accepts two input arguments and returns no result and may throw exception. Unlike most other functional interfaces, BiConsumerWithException is expected to operate via side-effects.

General contract

• void accept(T t,U u) throws E - The functional method.
• uncheck - Return a Biconsumer<T,U>
• lift - Return a Biconsumer<T,U>
• ignore - Return a Biconsumer<T,U>

See Also:

BiConsumer

Method Summary

Modifier and Type	Method	Description
void	accept(T t, U u)	Performs this operation on the given arguments.
default BiConsumerWithException<T,U,E>	andThen(BiConsumerWithException<? super T,? super U,? extends E> after)	Returns a composed BiConsumerWithException that performs, in sequence, this operation followed by the after operation.
default <R> BiFunctionWithException<T,U,R,E>	asBiFunction()	Converts a BiConsumerWithException to a BiFunctionWithException returning null.
static <T,U,R,E extends Exception> BiFunctionWithException<T,U,R,E>	asBiFunction(BiConsumerWithException<T,U,E> consumer)	Converts a BiConsumerWithException to a BiFunctionWithException returning null.
static <T,U,E extends Exception> BiConsumerWithException<T,U,E>	failing(Supplier<E> exceptionBuilder)	Returns a BiConsumerWithException that always throw exception.
default BiConsumer<T,U>	ignore()	Converts this BiConsumerWithException to a lifted BiConsumer that ignore exception.
static <T,U,E extends Exception> BiConsumer<T,U>	ignored(BiConsumerWithException<T,U,E> consumer)	Converts a BiConsumerWithException to a lifted BiConsumer ignoring exception.
static <T,U,E extends Exception> BiConsumer<T,U>	lifted(BiConsumerWithException<T,U,E> consumer)	Converts a BiConsumerWithException to a lifted BiConsumer ignoring exception.
default BiFunction<T,U,CompletionStage<Void>>	stage()	Converts this BiConsumerWithException to a staged BiFunction that return a CompletionStage.
static <T,U,E extends Exception> BiFunction<T,U,CompletionStage<Void>>	staged(BiConsumerWithException<T,U,E> consumer)	Converts a BiConsumerWithException to a staged BiFunction.
default BiConsumer<T,U>	uncheck()	Converts this BiConsumerWithException to a BiConsumer that wraps exception into RuntimeException.
static <T,U,E extends Exception> BiConsumer<T,U>	unchecked(BiConsumerWithException<T,U,E> consumer)	Converts a BiConsumerWithException to a BiConsumer that wraps exception to RuntimeException.
static <T,U,E extends Exception> BiConsumer<T,U>	unchecked(BiConsumerWithException<T,U,E> consumer, Function<Exception,RuntimeException> exceptionMapper)	Converts a BiConsumerWithException to a BiConsumer that wraps 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.NoReturnExceptionHandlerSupport

lift, notThrowingHandler, throwingHandler

Method Detail

accept

void accept(T t,
            U u)
     throws E extends Exception

Performs this operation on the given arguments.

Parameters:

t - the first input argument

u - the second input argument

Throws:

E - any exception

E extends Exception

See Also:

BiConsumer.accept(Object,Object)

uncheck

default BiConsumer<T,U> uncheck()

Converts this BiConsumerWithException to a BiConsumer that wraps exception into RuntimeException.

Specified by:

uncheck in interface ExceptionHandlerSupport<T,U,E extends Exception>

Specified by:

uncheck in interface NoReturnExceptionHandlerSupport<T,U,E extends Exception>

Returns:

the unchecked operation

See Also:

unchecked(BiConsumerWithException), unchecked(BiConsumerWithException, Function), BiConsumer

ignore

default BiConsumer<T,U> ignore()

Converts this BiConsumerWithException to a lifted BiConsumer that ignore exception.

Specified by:

ignore in interface ExceptionHandlerSupport<T,U,E extends Exception>

Specified by:

ignore in interface NoReturnExceptionHandlerSupport<T,U,E extends Exception>

Returns:

the operation that ignore error

See Also:

ignored(BiConsumerWithException), BiConsumer

stage

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

Converts this BiConsumerWithException to a staged BiFunction that return a CompletionStage.

Specified by:

stage in interface NoReturnExceptionHandlerSupport<T,U,E extends Exception>

Returns:

the staged operation.

Since:

1.1.0

andThen

default BiConsumerWithException<T,U,E> andThen(BiConsumerWithException<? super T,? super U,? extends E> after)

Returns a composed BiConsumerWithException that performs, in sequence, this operation followed by the after operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation. If performing this operation throws an exception, the after operation will not be performed.

Parameters:

after - the operation to perform after this operation

Returns:

a composed BiConsumerWithException that performs in sequence this operation followed by the after operation

Throws:

NullPointerException - if after is null

See Also:

BiConsumer.andThen(BiConsumer)

failing

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

Returns a BiConsumerWithException that always throw exception.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception of the operation

Parameters:

exceptionBuilder - the supplier to create the exception

Returns:

an operation that always throw exception

unchecked

static <T,U,E extends Exception> BiConsumer<T,U> unchecked(BiConsumerWithException<T,U,E> consumer)

Converts a BiConsumerWithException to a BiConsumer that wraps exception to RuntimeException.

For example :

 BiConsumerWithException<String, String, IOException> consumerThrowingException = ...;

 BiConsumer<String, String> consumerThrowingRuntimeException =
   ConsumerWithException.unchecked(consumerThrowingException);

 myMap.forEach(consumerThrowingRuntimeException);
 

In case of exception inside consumerThrowingRuntimeException an instance of WrappedException with the original exception as cause will be thrown.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception of the operation

Parameters:

consumer - to be unchecked

Returns:

the unchecked exception

Throws:

NullPointerException - if consumer is null

See Also:

uncheck(), unchecked(BiConsumerWithException, Function)

unchecked

static <T,U,E extends Exception> BiConsumer<T,U> unchecked(BiConsumerWithException<T,U,E> consumer,
                                                           Function<Exception,RuntimeException> exceptionMapper)

Converts a BiConsumerWithException to a BiConsumer that wraps exception to RuntimeException by using the provided mapping function.

For example :

 BiConsumerWithException<String, String, IOException> consumerThrowingException = ...;

 BiConsumer<String, String> consumerThrowingRuntimeException =
   ConsumerWithException.unchecked(
     consumerThrowingException,
     IllegalArgumentException::new);

 myMap.forEach(consumerThrowingRuntimeException)
 

In case of exception inside consumerThrowingRuntimeException an instance of IllegalArgumentException with the original exception as cause will be thrown.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception of the operation

Parameters:

consumer - the be unchecked

exceptionMapper - a function to convert the exception to the runtime exception.

Returns:

the unchecked exception

Throws:

NullPointerException - if consumer or exceptionMapper is null

See Also:

uncheck(), unchecked(BiConsumerWithException)

lifted

static <T,U,E extends Exception> BiConsumer<T,U> lifted(BiConsumerWithException<T,U,E> consumer)

Converts a BiConsumerWithException to a lifted BiConsumer ignoring exception.

For example :

 BiConsumerWithException<String, String, IOException> consumerThrowingException = ...;

 BiConsumer<String, String> consumerThrowingRuntimeException =
   ConsumerWithException.lifted(consumerThrowingException);

 myMap.forEach(consumerThrowingRuntimeException);
 

In case of exception inside consumerThrowingRuntimeException the exception will be ignored.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception of the operation

Parameters:

consumer - to be lifted

Returns:

the lifted operation

Throws:

NullPointerException - if consumer is null

See Also:

NoReturnExceptionHandlerSupport.lift()

ignored

static <T,U,E extends Exception> BiConsumer<T,U> ignored(BiConsumerWithException<T,U,E> consumer)

Converts a BiConsumerWithException to a lifted BiConsumer ignoring exception.

For example :

 BiConsumerWithException<String, String, IOException> consumerThrowingException = ...;

 BiConsumer<String, String> consumerThrowingRuntimeException =
   ConsumerWithException.ignored(consumerThrowingException);

 myMap.forEach(consumerThrowingRuntimeException);
 

In case of exception inside consumerThrowingRuntimeException the exception will be ignored.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception of the operation

Parameters:

consumer - to be lifted

Returns:

the lifted operation

Throws:

NullPointerException - if consumer is null

See Also:

ignore()

staged

static <T,U,E extends Exception> BiFunction<T,U,CompletionStage<Void>> staged(BiConsumerWithException<T,U,E> consumer)

Converts a BiConsumerWithException to a staged BiFunction.

Type Parameters:

T - the type of the first argument to the operation

U - the type of the second argument to the operation

E - the type of the potential exception

Parameters:

consumer - to be staged

Returns:

the staged operation

Throws:

NullPointerException - if consumer is null

Since:

1.1.0

asBiFunction

static <T,U,R,E extends Exception> BiFunctionWithException<T,U,R,E> asBiFunction(BiConsumerWithException<T,U,E> consumer)

Converts a BiConsumerWithException to a BiFunctionWithException returning null.

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:

consumer - to be converter

Returns:

the function

Throws:

NullPointerException - if consumer is null

asBiFunction

default <R> BiFunctionWithException<T,U,R,E> asBiFunction()

Converts a BiConsumerWithException to a BiFunctionWithException returning null.

Type Parameters:

R - the type of the return value of the function

Returns:

the function

Since:

1.2.0