net.digitalid.utility.functional.interfaces

Interface Producer<OUTPUT>

All Superinterfaces:

FailableProducer<OUTPUT,RuntimeException>

@Mutable
 @Functional
public interface Producer<OUTPUT>
extends FailableProducer<OUTPUT,RuntimeException>

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

Method Summary

Modifier and Type	Method and Description
default @Nonnull UnaryFunction<Object,OUTPUT>	asFunction() Returns this producer as a unary function that ignores its input.
default <FINAL_OUTPUT> @Nonnull Producer<FINAL_OUTPUT>	before(@Nonnull UnaryFunction<? super OUTPUT,? extends FINAL_OUTPUT> function) Returns the composition of this producer followed by the given function.
static <OUTPUT> @Nonnull Producer<OUTPUT>	constant(OUTPUT output) Returns a producer that always produces the given output.
default @Nonnull Producer<OUTPUT>	memoize(long duration) Returns a producer that caches each object produced by this producer for the given duration in milliseconds.
default @Nonnull Producer<OUTPUT>	synchronize() Returns a producer that synchronizes on this producer.

Methods inherited from interface net.digitalid.utility.functional.failable.FailableProducer

before, compose, produce, suppressExceptions, suppressExceptions, suppressExceptions, suppressExceptions

Method Detail

before

@Pure
 @Nonnull
default <FINAL_OUTPUT> @Nonnull Producer<FINAL_OUTPUT> before(@Nonnull
                                                                              @Nonnull UnaryFunction<? super OUTPUT,? extends FINAL_OUTPUT> function)

Returns the composition of this producer followed by the given function.

asFunction

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

Description copied from interface: FailableProducer

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

Specified by:

asFunction in interface FailableProducer<OUTPUT,RuntimeException>

synchronize

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

Description copied from interface: FailableProducer

Returns a producer that synchronizes on this producer.

Specified by:

synchronize in interface FailableProducer<OUTPUT,RuntimeException>

memoize

@Pure
 @Nonnull
default @Nonnull Producer<OUTPUT> memoize(long duration)

Description copied from interface: FailableProducer

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

Specified by:

memoize in interface FailableProducer<OUTPUT,RuntimeException>

constant

@Pure
 @Nonnull
static <OUTPUT> @Nonnull Producer<OUTPUT> constant(@Captured
                                                                   OUTPUT output)

Returns a producer that always produces the given output.