net.digitalid.utility.functional.interfaces

Interface UnaryFunction<INPUT,OUTPUT>

All Superinterfaces:

FailableUnaryFunction<INPUT,OUTPUT,RuntimeException>

All Known Subinterfaces:

UnaryOperator<TYPE>

@Immutable
 @Functional
public interface UnaryFunction<INPUT,OUTPUT>
extends FailableUnaryFunction<INPUT,OUTPUT,RuntimeException>

This functional interface models a unary function that maps an object of type INPUT to an object of type OUTPUT.

Method Summary

Modifier and Type	Method and Description
default <INITIAL_INPUT> @Nonnull UnaryFunction<INITIAL_INPUT,OUTPUT>	after(@Nonnull UnaryFunction<? super INITIAL_INPUT,? extends INPUT> function) Returns the composition of the given function followed by this function.
default <FINAL_OUTPUT> @Nonnull UnaryFunction<INPUT,FINAL_OUTPUT>	before(@Nonnull UnaryFunction<? super OUTPUT,? extends FINAL_OUTPUT> function) Returns the composition of this function followed by the given function.
static <OUTPUT> @Nonnull UnaryFunction<Object,OUTPUT>	constant(OUTPUT output) Returns a function that always returns the given output.
default @Nonnull UnaryFunction<INPUT,OUTPUT>	propagateNull() Returns a new function based on this function that propagates null instead of evaluating it.
default @Nonnull UnaryFunction<INPUT,OUTPUT>	replaceNull(OUTPUT defaultValue) Returns a new function based on this function that returns the given default output for null.
static <KEY,VALUE> @Nonnull UnaryFunction<KEY,VALUE>	with(@Nonnull Map<? super KEY,? extends VALUE> map) Returns a function that looks up the result in the given map or returns null if the input is not found in the map.
static <KEY,VALUE> @Nonnull UnaryFunction<KEY,VALUE>	with(@Nonnull Map<? super KEY,? extends VALUE> map, VALUE defaultValue) Returns a function that looks up the result in the given map or returns the given default value if the input is not found in the map.

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

after, before, compose, evaluate, suppressExceptions, suppressExceptions, suppressExceptions, suppressExceptions

Method Detail

before

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

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

after

@Pure
 @Nonnull
default <INITIAL_INPUT> @Nonnull UnaryFunction<INITIAL_INPUT,OUTPUT> after(@Nonnull
                                                                                           @Nonnull UnaryFunction<? super INITIAL_INPUT,? extends INPUT> function)

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

replaceNull

@Pure
 @Nonnull
default @Nonnull UnaryFunction<INPUT,OUTPUT> replaceNull(@Captured
                                                                         OUTPUT defaultValue)

Description copied from interface: FailableUnaryFunction

Returns a new function based on this function that returns the given default output for null.

Specified by:

replaceNull in interface FailableUnaryFunction<INPUT,OUTPUT,RuntimeException>

propagateNull

@Pure
 @Nonnull
default @Nonnull UnaryFunction<INPUT,OUTPUT> propagateNull()

Description copied from interface: FailableUnaryFunction

Returns a new function based on this function that propagates null instead of evaluating it.

Specified by:

propagateNull in interface FailableUnaryFunction<INPUT,OUTPUT,RuntimeException>

with

@Pure
 @Nonnull
static <KEY,VALUE> @Nonnull UnaryFunction<KEY,VALUE> with(@Nonnull
                                                                          @Nonnull Map<? super KEY,? extends VALUE> map,
                                                                          VALUE defaultValue)

Returns a function that looks up the result in the given map or returns the given default value if the input is not found in the map.

with

@Pure
 @Nonnull
static <KEY,VALUE> @Nonnull UnaryFunction<KEY,VALUE> with(@Nonnull
                                                                          @Nonnull Map<? super KEY,? extends VALUE> map)

Returns a function that looks up the result in the given map or returns null if the input is not found in the map.

constant

@Pure
 @Nonnull
static <OUTPUT> @Nonnull UnaryFunction<Object,OUTPUT> constant(@Captured
                                                                               OUTPUT output)

Returns a function that always returns the given output.