net.digitalid.utility.functional.failable

Interface FailableProducer<OUTPUT,EXCEPTION extends Exception>

All Known Subinterfaces:

Producer<OUTPUT>

@Mutable
 @Functional
public interface FailableProducer<OUTPUT,EXCEPTION extends Exception>

This functional interface models a failable method that produces objects of type OUTPUT without requiring a parameter.

Method Summary

Modifier and Type	Method and Description
default @Nonnull FailableUnaryFunction<Object,OUTPUT,EXCEPTION>	asFunction() Returns this producer as a unary function that ignores its input.
default <FINAL_OUTPUT> @Nonnull FailableProducer<FINAL_OUTPUT,EXCEPTION>	before(@Nonnull FailableUnaryFunction<? super OUTPUT,? extends FINAL_OUTPUT,? extends EXCEPTION> function) Returns the composition of this producer followed by the given function.
static <INTERMEDIATE,OUTPUT,EXCEPTION extends Exception> @Nonnull FailableProducer<OUTPUT,EXCEPTION>	compose(@Nonnull FailableProducer<? extends INTERMEDIATE,? extends EXCEPTION> producer, @Nonnull FailableUnaryFunction<? super INTERMEDIATE,? extends OUTPUT,? extends EXCEPTION> function) Returns the composition of the given producer and function with a flexible exception type.
default @Nonnull FailableProducer<OUTPUT,EXCEPTION>	memoize(long duration) Returns a producer that caches each object produced by this producer for the given duration in milliseconds.
OUTPUT	produce() Produces a result.
default @Nonnull Producer<OUTPUT>	suppressExceptions() Returns a producer that suppresses the exceptions of this producer and returns null instead.
default @Nonnull Producer<OUTPUT>	suppressExceptions(@Nonnull Consumer<? super Exception> handler) Returns a producer that catches the exceptions of this producer, passes them to the given exception handler and returns null instead.
default @Nonnull Producer<OUTPUT>	suppressExceptions(@Nonnull Consumer<? super Exception> handler, OUTPUT defaultOutput) Returns a producer that catches the exceptions of this producer, passes them to the given exception handler and returns the given default output instead.
default @Nonnull Producer<OUTPUT>	suppressExceptions(OUTPUT defaultOutput) Returns a producer that suppresses the exceptions of this producer and returns the given default output instead.
default @Nonnull FailableProducer<OUTPUT,EXCEPTION>	synchronize() Returns a producer that synchronizes on this producer.

Method Detail

produce

@Impure
 @Capturable
OUTPUT produce()
                             throws EXCEPTION extends Exception

Produces a result.

Throws:

EXCEPTION extends Exception

suppressExceptions

@Pure
 @Nonnull
default @Nonnull Producer<OUTPUT> suppressExceptions(@Captured @Nonnull
                                                                     @Nonnull Consumer<? super Exception> handler,
                                                                     @Captured
                                                                     OUTPUT defaultOutput)

Returns a producer that catches the exceptions of this producer, passes them to the given exception handler and returns the given default output instead.

suppressExceptions

@Pure
 @Nonnull
default @Nonnull Producer<OUTPUT> suppressExceptions(@Captured @Nonnull
                                                                     @Nonnull Consumer<? super Exception> handler)

Returns a producer that catches the exceptions of this producer, passes them to the given exception handler and returns null instead.

suppressExceptions

@Pure
 @Nonnull
default @Nonnull Producer<OUTPUT> suppressExceptions(@Captured
                                                                     OUTPUT defaultOutput)

Returns a producer that suppresses the exceptions of this producer and returns the given default output instead.

suppressExceptions

@Pure
 @Nonnull
default @Nonnull Producer<OUTPUT> suppressExceptions()

Returns a producer that suppresses the exceptions of this producer and returns null instead.

compose

@Pure
 @Capturable
 @Nonnull
static <INTERMEDIATE,OUTPUT,EXCEPTION extends Exception> @Nonnull FailableProducer<OUTPUT,EXCEPTION> compose(@Captured @Nonnull
                                                                                                                                          @Nonnull FailableProducer<? extends INTERMEDIATE,? extends EXCEPTION> producer,
                                                                                                                                          @Nonnull
                                                                                                                                          @Nonnull FailableUnaryFunction<? super INTERMEDIATE,? extends OUTPUT,? extends EXCEPTION> function)

Returns the composition of the given producer and function with a flexible exception type.

before

@Pure
 @Nonnull
default <FINAL_OUTPUT> @Nonnull FailableProducer<FINAL_OUTPUT,EXCEPTION> before(@Nonnull
                                                                                                @Nonnull FailableUnaryFunction<? super OUTPUT,? extends FINAL_OUTPUT,? extends EXCEPTION> function)

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

See Also:

compose(net.digitalid.utility.functional.failable.FailableProducer, net.digitalid.utility.functional.failable.FailableUnaryFunction)

asFunction

@Pure
 @Nonnull
default @Nonnull FailableUnaryFunction<Object,OUTPUT,EXCEPTION> asFunction()

Returns this producer as a unary function that ignores its input. This method may only be called if this producer is side-effect-free.

synchronize

@Pure
 @Nonnull
default @Nonnull FailableProducer<OUTPUT,EXCEPTION> synchronize()

Returns a producer that synchronizes on this producer.

memoize

@Pure
 @Nonnull
default @Nonnull FailableProducer<OUTPUT,EXCEPTION> memoize(long duration)

Returns a producer that caches each object produced by this producer for the given duration in milliseconds.