net.digitalid.utility.functional.failable

Interface FailableConsumer<INPUT,EXCEPTION extends Exception>

All Known Subinterfaces:

Collector<INPUT,RESULT>, Consumer<INPUT>, FailableCollector<INPUT,RESULT,COLLECT_EXCEPTION,RESULT_EXCEPTION>

@Mutable
 @Functional
public interface FailableConsumer<INPUT,EXCEPTION extends Exception>

This functional interface models a failable method that consumes objects of type INPUT without returning a result.

Method Summary

Modifier and Type	Method and Description
default <SUBTYPE extends INPUT> @Nonnull FailableConsumer<SUBTYPE,EXCEPTION>	after(@Nonnull FailableConsumer<? super SUBTYPE,? extends EXCEPTION> consumer) Returns the composition of the given consumer followed by this consumer.
default <INITIAL_INPUT> @Nonnull FailableConsumer<INITIAL_INPUT,EXCEPTION>	after(@Nonnull FailableUnaryFunction<? super INITIAL_INPUT,? extends INPUT,? extends EXCEPTION> function) Returns the composition of the given function followed by this consumer.
default @Nonnull FailableUnaryFunction<INPUT,Void,EXCEPTION>	asFunction() Returns this consumer as a unary function that always returns null.
default <SUBTYPE extends INPUT> @Nonnull FailableConsumer<SUBTYPE,EXCEPTION>	before(@Nonnull FailableConsumer<? super SUBTYPE,? extends EXCEPTION> consumer) Returns the composition of this consumer followed by the given consumer.
static <INPUT,EXCEPTION extends Exception> @Nonnull FailableConsumer<INPUT,EXCEPTION>	compose(@Nonnull FailableConsumer<? super INPUT,? extends EXCEPTION> consumer0, @Nonnull FailableConsumer<? super INPUT,? extends EXCEPTION> consumer1) Returns the composition of the given consumers with a flexible exception type.
void	consume(INPUT input) Consumes the given input.
default @Nonnull Consumer<INPUT>	suppressExceptions() Returns a consumer that suppresses the exceptions of this consumer.
default @Nonnull Consumer<INPUT>	suppressExceptions(@Nonnull Consumer<? super Exception> handler) Returns a consumer that suppresses the exceptions of this consumer and passes them to the given exception handler instead.
default @Nonnull FailableConsumer<INPUT,EXCEPTION>	synchronize() Returns a consumer that synchronizes on this consumer.

Method Detail

consume

@Impure
void consume(@Captured
                     INPUT input)
              throws EXCEPTION extends Exception

Consumes the given input.

Throws:

EXCEPTION extends Exception

suppressExceptions

@Pure
 @Capturable
 @Nonnull
default @Nonnull Consumer<INPUT> suppressExceptions(@Captured @Nonnull
                                                                                 @Nonnull Consumer<? super Exception> handler)

Returns a consumer that suppresses the exceptions of this consumer and passes them to the given exception handler instead.

suppressExceptions

@Pure
 @Capturable
 @Nonnull
default @Nonnull Consumer<INPUT> suppressExceptions()

Returns a consumer that suppresses the exceptions of this consumer.

compose

@Pure
 @Capturable
 @Nonnull
static <INPUT,EXCEPTION extends Exception> @Nonnull FailableConsumer<INPUT,EXCEPTION> compose(@Captured @Nonnull
                                                                                                                           @Nonnull FailableConsumer<? super INPUT,? extends EXCEPTION> consumer0,
                                                                                                                           @Captured @Nonnull
                                                                                                                           @Nonnull FailableConsumer<? super INPUT,? extends EXCEPTION> consumer1)

Returns the composition of the given consumers with a flexible exception type.

before

@Pure
 @Capturable
 @Nonnull
default <SUBTYPE extends INPUT> @Nonnull FailableConsumer<SUBTYPE,EXCEPTION> before(@Captured @Nonnull
                                                                                                                 @Nonnull FailableConsumer<? super SUBTYPE,? extends EXCEPTION> consumer)

Returns the composition of this consumer followed by the given consumer. Unfortunately, it is not possible to make the exception type flexible as well.

See Also:

compose(net.digitalid.utility.functional.failable.FailableConsumer, net.digitalid.utility.functional.failable.FailableConsumer)

after

@Pure
 @Capturable
 @Nonnull
default <SUBTYPE extends INPUT> @Nonnull FailableConsumer<SUBTYPE,EXCEPTION> after(@Captured @Nonnull
                                                                                                                @Nonnull FailableConsumer<? super SUBTYPE,? extends EXCEPTION> consumer)

Returns the composition of the given consumer followed by this consumer. Unfortunately, it is not possible to make the exception type flexible as well.

See Also:

compose(net.digitalid.utility.functional.failable.FailableConsumer, net.digitalid.utility.functional.failable.FailableConsumer)

after

@Pure
 @Capturable
 @Nonnull
default <INITIAL_INPUT> @Nonnull FailableConsumer<INITIAL_INPUT,EXCEPTION> after(@Nonnull
                                                                                                              @Nonnull FailableUnaryFunction<? super INITIAL_INPUT,? extends INPUT,? extends EXCEPTION> function)

Returns the composition of the given function followed by this consumer. Unfortunately, it is not possible to make the exception type flexible as well.

asFunction

@Pure
 @Nonnull
default @Nonnull FailableUnaryFunction<INPUT,Void,EXCEPTION> asFunction()

Returns this consumer as a unary function that always returns null. This method may only be called if this consumer is side-effect-free.

synchronize

@Pure
 @Nonnull
default @Nonnull FailableConsumer<INPUT,EXCEPTION> synchronize()

Returns a consumer that synchronizes on this consumer.