net.digitalid.utility.functional.failable

Interface FailableBinaryOperator<TYPE,EXCEPTION extends Exception>

All Superinterfaces:

FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION>

All Known Subinterfaces:

BinaryOperator<TYPE>

@Immutable
 @Functional
public interface FailableBinaryOperator<TYPE,EXCEPTION extends Exception>
extends FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION>

This functional interface models a failable binary operator that maps two objects of type TYPE to another object of type TYPE.

Method Summary

Modifier and Type	Method and Description
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION>	after(@Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> operator0, @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> operator1) Returns the composition of the given operators followed by this operator.
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION>	before(@Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> operator) Returns the composition of this operator followed by the given operator.
static <TYPE,EXCEPTION extends Exception> @Nonnull FailableBinaryOperator<TYPE,EXCEPTION>	compose(@Nonnull FailableBinaryOperator<TYPE,? extends EXCEPTION> binaryOperator, @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> unaryOperator) Returns the composition of the given operators with a flexible exception type.
static <TYPE,EXCEPTION extends Exception> @Nonnull FailableBinaryOperator<TYPE,EXCEPTION>	compose(@Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> unaryOperator0, @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> unaryOperator1, @Nonnull FailableBinaryOperator<TYPE,? extends EXCEPTION> binaryOperator) Returns the composition of the given operators with a flexible exception type.
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION>	propagateNull() Returns a new function based on this function that propagates null instead of evaluating it.
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION>	replaceNull(TYPE defaultOutput) Returns a new function based on this function that returns the given default output if either input is null.
default @Nonnull BinaryOperator<TYPE>	suppressExceptions() Returns a function that suppresses the exceptions of this function and returns null instead.
default @Nonnull BinaryOperator<TYPE>	suppressExceptions(@Nonnull Consumer<? super Exception> handler) Returns a function that catches the exceptions of this function, passes them to the given exception handler and returns null instead.
default @Nonnull BinaryOperator<TYPE>	suppressExceptions(@Nonnull Consumer<? super Exception> handler, TYPE defaultOutput) Returns a function that catches the exceptions of this function, passes them to the given exception handler and returns the given default output instead.
default @Nonnull BinaryOperator<TYPE>	suppressExceptions(TYPE defaultOutput) Returns a function that suppresses the exceptions of this function and returns the given default output instead.

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

after, before, compose, compose, evaluate, evaluate

Method Detail

suppressExceptions

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

Description copied from interface: FailableBinaryFunction

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

Specified by:

suppressExceptions in interface FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION extends Exception>

suppressExceptions

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> suppressExceptions(@Captured @Nonnull
                                                                         @Nonnull Consumer<? super Exception> handler)

Description copied from interface: FailableBinaryFunction

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

Specified by:

suppressExceptions in interface FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION extends Exception>

suppressExceptions

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> suppressExceptions(@Captured
                                                                         TYPE defaultOutput)

Description copied from interface: FailableBinaryFunction

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

Specified by:

suppressExceptions in interface FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION extends Exception>

suppressExceptions

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> suppressExceptions()

Description copied from interface: FailableBinaryFunction

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

Specified by:

suppressExceptions in interface FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION extends Exception>

compose

@Pure
 @Nonnull
static <TYPE,EXCEPTION extends Exception> @Nonnull FailableBinaryOperator<TYPE,EXCEPTION> compose(@Nonnull
                                                                                                                  @Nonnull FailableBinaryOperator<TYPE,? extends EXCEPTION> binaryOperator,
                                                                                                                  @Nonnull
                                                                                                                  @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> unaryOperator)

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

before

@Pure
 @Nonnull
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION> before(@Nonnull
                                                                               @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> operator)

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

See Also:

compose(net.digitalid.utility.functional.failable.FailableBinaryOperator, net.digitalid.utility.functional.failable.FailableUnaryOperator)

compose

@Pure
 @Nonnull
static <TYPE,EXCEPTION extends Exception> @Nonnull FailableBinaryOperator<TYPE,EXCEPTION> compose(@Nonnull
                                                                                                                  @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> unaryOperator0,
                                                                                                                  @Nonnull
                                                                                                                  @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> unaryOperator1,
                                                                                                                  @Nonnull
                                                                                                                  @Nonnull FailableBinaryOperator<TYPE,? extends EXCEPTION> binaryOperator)

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

after

@Pure
 @Nonnull
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION> after(@Nonnull
                                                                              @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> operator0,
                                                                              @Nonnull
                                                                              @Nonnull FailableUnaryOperator<TYPE,? extends EXCEPTION> operator1)

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

See Also:

compose(net.digitalid.utility.functional.failable.FailableUnaryOperator, net.digitalid.utility.functional.failable.FailableUnaryOperator, net.digitalid.utility.functional.failable.FailableBinaryOperator)

replaceNull

@Pure
 @Nonnull
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION> replaceNull(@Captured
                                                                                    TYPE defaultOutput)

Description copied from interface: FailableBinaryFunction

Returns a new function based on this function that returns the given default output if either input is null.

Specified by:

replaceNull in interface FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION extends Exception>

propagateNull

@Pure
 @Nonnull
default @Nonnull FailableBinaryOperator<TYPE,EXCEPTION> propagateNull()

Description copied from interface: FailableBinaryFunction

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

Specified by:

propagateNull in interface FailableBinaryFunction<TYPE,TYPE,TYPE,EXCEPTION extends Exception>