Module com.github.robtimus.function.throwing

Package com.github.robtimus.function.throwing

Interface ThrowingConsumer<T,X extends Throwable>

Type Parameters:

T - The type of the input to the operation.

X - The type of checked exception that can be thrown.

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 ThrowingConsumer<T,X extends Throwable>

Represents an operation that accepts a single input argument and returns no result. This is a checked-exception throwing equivalent of Consumer.

Method Summary

Modifier and Type	Method	Description
void	accept(T t)	Performs this operation on the given argument.
default ThrowingConsumer<T,X>	andThen(ThrowingConsumer<? super T,? extends X> after)	Returns a composed ThrowingConsumer that performs, in sequence, this operation followed by the after operation.
static <T,X extends Throwable> ThrowingConsumer<T,X>	checked(Consumer<? super T> operation)	Returns an operation that performs the operation operation to its input.
static <T,X extends Throwable> ThrowingConsumer<T,X>	checked(Consumer<? super T> operation, Class<X> errorType)	Returns an operation that performs the operation operation to its input.
static <T,X extends Throwable> ThrowingConsumer<T,X>	of(ThrowingConsumer<T,X> operation)	Factory method for turning ThrowingConsumer-shaped lambdas into ThrowingConsumers.
default <E extends Throwable> ThrowingConsumer<T,E>	onErrorAcceptChecked(ThrowingConsumer<? super T,? extends E> fallback)	Returns an operation that performs this operation on its input.
default Consumer<T>	onErrorAcceptUnchecked(Consumer<? super T> fallback)	Returns an operation that performs this operation on its input.
default Consumer<T>	onErrorDiscard()	Returns an operation that performs this operation on its input.
default <E extends Throwable> ThrowingConsumer<T,E>	onErrorHandleChecked(ThrowingConsumer<? super X,? extends E> errorHandler)	Returns an operation that performs this operation on its input.
default Consumer<T>	onErrorHandleUnchecked(Consumer<? super X> errorHandler)	Returns an operation that performs this operation on its input.
default <E extends Throwable> ThrowingConsumer<T,E>	onErrorThrowAsChecked(Function<? super X,? extends E> errorMapper)	Returns an operation that performs this operation on its input.
default <E extends RuntimeException> Consumer<T>	onErrorThrowAsUnchecked(Function<? super X,? extends E> errorMapper)	Returns an operation that performs this operation on its input.
default Consumer<T>	unchecked()	Returns an operation that performs this operation on its input.
static <T> Consumer<T>	unchecked(ThrowingConsumer<? super T,?> operation)	Returns an operation that performs the operation operation to its input.

Method Detail

accept

void accept(T t)
     throws X extends Throwable

Performs this operation on the given argument.

Parameters:

t - The input argument.

Throws:

X - If an error occurs.

X extends Throwable

andThen

default ThrowingConsumer<T,X> andThen(ThrowingConsumer<? super T,? extends X> after)

Returns a composed ThrowingConsumer 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 ThrowingConsumer that performs in sequence this operation followed by the after operation.

Throws:

NullPointerException - If after is null.

onErrorThrowAsChecked

default <E extends Throwable> ThrowingConsumer<T,E> onErrorThrowAsChecked(Function<? super X,? extends E> errorMapper)

Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is transformed using the given error mapper, and the returned operation throws the transformation result.

Type Parameters:

E - The type of checked exception to transform to.

Parameters:

errorMapper - The function to use to transform any checked exception thrown by this operation.

Returns:

An operation that transforms any thrown checked exception.

Throws:

NullPointerException - If errorMapper is null.

onErrorThrowAsUnchecked

default <E extends RuntimeException> Consumer<T> onErrorThrowAsUnchecked(Function<? super X,? extends E> errorMapper)

Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is transformed using the given error mapper, and the returned operation throws the transformation result.

Type Parameters:

E - The type of unchecked exception to transform to.

Parameters:

errorMapper - The function to use to transform any checked exception thrown by this operation.

Returns:

An operation that transforms any thrown checked exception.

Throws:

NullPointerException - If errorMapper is null.

onErrorHandleChecked

default <E extends Throwable> ThrowingConsumer<T,E> onErrorHandleChecked(ThrowingConsumer<? super X,? extends E> errorHandler)

Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is handled by the given error handler.

Type Parameters:

E - The type of checked exception that can be thrown by the given error handler.

Parameters:

errorHandler - The operation to perform on any checked exception thrown by this operation.

Returns:

An operation that handles any thrown checked exception.

Throws:

NullPointerException - If errorHandler is null.

onErrorHandleUnchecked

default Consumer<T> onErrorHandleUnchecked(Consumer<? super X> errorHandler)

Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is handled by the given error handler.

Parameters:

errorHandler - The operation to perform on any checked exception thrown by this operation.

Returns:

An operation that handles any thrown checked exception.

Throws:

NullPointerException - If errorHandler is null.

onErrorAcceptChecked

default <E extends Throwable> ThrowingConsumer<T,E> onErrorAcceptChecked(ThrowingConsumer<? super T,? extends E> fallback)

Returns an operation that performs this operation on its input. If this operation throws any checked exception, it is discarded and the given fallback operation is invoked.

Type Parameters:

E - The type of checked exception that can be thrown by the given fallback operation.

Parameters:

fallback - The operation to invoke if this operation throws any checked exception.

Returns:

An operation that invokes the fallback operation if this operation throws any checked exception.

Throws:

NullPointerException - If fallback is null.

onErrorAcceptUnchecked

default Consumer<T> onErrorAcceptUnchecked(Consumer<? super T> fallback)

Returns an operation that performs this operation on its input. If this operation throws any checked exception, it is discarded and the given fallback operation is invoked.

Parameters:

fallback - The operation to invoke if this operation throws any checked exception.

Returns:

An operation that invokes the fallback operation if this operation throws any checked exception.

Throws:

NullPointerException - If fallback is null.

onErrorDiscard

default Consumer<T> onErrorDiscard()

Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is discarded.

Returns:

An operation that discards any thrown checked exception.

unchecked

default Consumer<T> unchecked()

Returns an operation that performs this operation on its input. Any checked exception thrown by this operation is wrapped in an UncheckedException without a stack trace.

Returns:

An operation that wraps any checked exception in an UncheckedException.

of

static <T,X extends Throwable> ThrowingConsumer<T,X> of(ThrowingConsumer<T,X> operation)

Factory method for turning ThrowingConsumer-shaped lambdas into ThrowingConsumers.

Type Parameters:

T - The type of the input to the operation.

X - The type of checked exception that can be thrown.

Parameters:

operation - The lambda to return as ThrowingConsumer.

Returns:

The given lambda as a ThrowingConsumer.

Throws:

NullPointerException - If operation is null.

unchecked

static <T> Consumer<T> unchecked(ThrowingConsumer<? super T,?> operation)

Returns an operation that performs the operation operation to its input. Any checked exception thrown by the operation operation is wrapped in an UncheckedException.

Type Parameters:

T - The type of the input to the operation.

Parameters:

operation - The operation to perform when the returned operation is performed.

Returns:

An operation that wraps any checked exception in an UncheckedException.

Throws:

NullPointerException - If operation is null.

checked

static <T,X extends Throwable> ThrowingConsumer<T,X> checked(Consumer<? super T> operation)

Returns an operation that performs the operation operation to its input. Any checked exception thrown by the operation operation is relayed to the caller. This method allows existing Consumer instances to be used where ThrowingConsumer is expected.

Type Parameters:

T - The type of the input to the operation.

X - The type of checked exception that can be thrown.

Parameters:

operation - The operation to perform when the returned operation is performed.

Returns:

An operation that wraps any checked exception in an UncheckedException.

Throws:

NullPointerException - If operation is null.

checked

static <T,X extends Throwable> ThrowingConsumer<T,X> checked(Consumer<? super T> operation,
                                                                         Class<X> errorType)

Returns an operation that performs the operation operation to its input. Any UncheckedException thrown by the operation operation is unwrapped if its cause is an instance of errorType, otherwise it is relayed to the caller.

Type Parameters:

T - The type of the input to the operation.

X - The type of checked exception that can be thrown.

Parameters:

operation - The operation to perform when the returned operation is performed.

errorType - The type of checked exception that can be thrown.

Returns:

An operation that wraps any checked exception in an UncheckedException.

Throws:

NullPointerException - If operation or errorType is null.