net.digitalid.utility.functional.interfaces

Interface BinaryOperator<TYPE>

All Superinterfaces:

BinaryFunction<TYPE,TYPE,TYPE>, FailableBinaryFunction<TYPE,TYPE,TYPE,RuntimeException>, FailableBinaryOperator<TYPE,RuntimeException>

@Immutable
 @Functional
public interface BinaryOperator<TYPE>
extends BinaryFunction<TYPE,TYPE,TYPE>, FailableBinaryOperator<TYPE,RuntimeException>

This functional interface models a 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 BinaryOperator<TYPE>	after(@Nonnull UnaryOperator<TYPE> operator0, @Nonnull UnaryOperator<TYPE> operator1) Returns the composition of the given operators followed by this operator.
default @Nonnull BinaryOperator<TYPE>	before(@Nonnull UnaryOperator<TYPE> operator) Returns the composition of this operator followed by the given operator.
static <TYPE> @Nonnull BinaryOperator<TYPE>	constant(TYPE output) Returns a binary function that always returns the given output.
static <TYPE> @Nonnull BinaryOperator<TYPE>	max(@Nonnull Comparator<? super TYPE> comparator) Returns a binary operator which returns the greater of two objects according to the given comparator.
static <TYPE> @Nonnull BinaryOperator<TYPE>	min(@Nonnull Comparator<? super TYPE> comparator) Returns a binary operator which returns the lesser of two objects according to the given comparator.
default @Nonnull BinaryOperator<TYPE>	propagateNull() Returns a new function based on this function that propagates null instead of evaluating it.
default @Nonnull BinaryOperator<TYPE>	replaceNull(TYPE defaultValue) Returns a new function based on this function that returns the given default output if either input is null.

Methods inherited from interface net.digitalid.utility.functional.interfaces.BinaryFunction

after, before

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

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

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

after, before, compose, compose, evaluate, evaluate

Method Detail

before

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> before(@Nonnull
                                                             @Nonnull UnaryOperator<TYPE> operator)

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

after

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> after(@Nonnull
                                                            @Nonnull UnaryOperator<TYPE> operator0,
                                                            @Nonnull
                                                            @Nonnull UnaryOperator<TYPE> operator1)

Returns the composition of the given operators followed by this operator.

replaceNull

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> replaceNull(@Captured
                                                                  TYPE defaultValue)

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 BinaryFunction<TYPE,TYPE,TYPE>

Specified by:

replaceNull in interface FailableBinaryFunction<TYPE,TYPE,TYPE,RuntimeException>

Specified by:

replaceNull in interface FailableBinaryOperator<TYPE,RuntimeException>

propagateNull

@Pure
 @Nonnull
default @Nonnull BinaryOperator<TYPE> 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 BinaryFunction<TYPE,TYPE,TYPE>

Specified by:

propagateNull in interface FailableBinaryFunction<TYPE,TYPE,TYPE,RuntimeException>

Specified by:

propagateNull in interface FailableBinaryOperator<TYPE,RuntimeException>

constant

@Pure
 @Nonnull
static <TYPE> @Nonnull BinaryOperator<TYPE> constant(@Captured
                                                                     TYPE output)

Returns a binary function that always returns the given output.

Specified by:

constant in interface BinaryFunction<TYPE,TYPE,TYPE>

min

@Pure
 @Nonnull
static <TYPE> @Nonnull BinaryOperator<TYPE> min(@Nonnull
                                                                @Nonnull Comparator<? super TYPE> comparator)

Returns a binary operator which returns the lesser of two objects according to the given comparator.

max

@Pure
 @Nonnull
static <TYPE> @Nonnull BinaryOperator<TYPE> max(@Nonnull
                                                                @Nonnull Comparator<? super TYPE> comparator)

Returns a binary operator which returns the greater of two objects according to the given comparator.