All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
eu.lunisolar.magma.func.operator.binary.LIntBinaryOperator Maven / Gradle / Ivy
/*
* This file is part of "lunisolar-magma".
*
* (C) Copyright 2015 Lunisolar (http://lunisolar.eu/).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package eu.lunisolar.magma.func.operator.binary;
import javax.annotation.Nonnull; // NOSONAR
import javax.annotation.Nullable; // NOSONAR
import java.util.Comparator; // NOSONAR
import java.util.Objects; // NOSONAR
import eu.lunisolar.magma.basics.*; //NOSONAR
import eu.lunisolar.magma.basics.builder.*; // NOSONAR
import eu.lunisolar.magma.basics.exceptions.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.type.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.domain.*; // NOSONAR
import eu.lunisolar.magma.func.*; // NOSONAR
import eu.lunisolar.magma.func.operator.unary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.binary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.ternary.*; // NOSONAR
import eu.lunisolar.magma.func.function.*; // NOSONAR
import eu.lunisolar.magma.func.function.from.*; // NOSONAR
import eu.lunisolar.magma.func.function.to.*; // NOSONAR
import eu.lunisolar.magma.func.function.conversion.*; // NOSONAR
import eu.lunisolar.magma.func.predicate.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.bi.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.tri.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.obj.*; // NOSONAR
import eu.lunisolar.magma.func.action.*; // NOSONAR
/**
* Non-throwing functional interface (lambda) LIntBinaryOperator for Java 8.
*
* Type: operator
*
* Domain (lvl: 2): int i1,int i2
*
* Co-domain: none
*
* @see LIntBinaryOperatorX
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LIntBinaryOperator extends LIntBinaryOperatorX, MetaOperator, PrimitiveCodomain, MetaInterface.NonThrowing { // NOSONAR
static final String DESCRIPTION = "LIntBinaryOperator: int doApplyAsInt(int i1,int i2)";
/**
* Default implementation for JRE method that calls exception nesting method.
* @deprecated Calling this method via LIntBinaryOperator interface should be discouraged.
*/
@Override
@Deprecated
default int applyAsInt(int i1, int i2) {
return this.nestingDoApplyAsInt(i1, i2);
}
int doApplyAsInt(int i1, int i2);
/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
default int nestingDoApplyAsInt(int i1, int i2) {
return this.doApplyAsInt(i1, i2);
}
/** Function call that handles exceptions by always propagating them as is even when they are undeclared checked ones. */
default int shovingDoApplyAsInt(int i1, int i2) {
return this.doApplyAsInt(i1, i2);
}
/** Just to mirror the method: Ensures the result is not null */
default int nonNullDoApplyAsInt(int i1, int i2) {
return doApplyAsInt(i1, i2);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LIntBinaryOperator.DESCRIPTION;
}
/** Captures arguments but delays the evaluation. */
default LIntSupplier captureIntBinaryOp(int i1, int i2) {
return () -> this.doApplyAsInt(i1, i2);
}
/** Creates function that always returns the same value. */
static LIntBinaryOperator constant(int r) {
return (i1, i2) -> r;
}
/** Captures single parameter function into this interface where only 1st parameter will be used. */
@Nonnull
static LIntBinaryOperator apply1stAsInt(@Nonnull LIntUnaryOperator func) {
return (i1, i2) -> func.doApplyAsInt(i1);
}
/** Captures single parameter function into this interface where only 2nd parameter will be used. */
@Nonnull
static LIntBinaryOperator apply2ndAsInt(@Nonnull LIntUnaryOperator func) {
return (i1, i2) -> func.doApplyAsInt(i2);
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LIntBinaryOperator l(final @Nonnull LIntBinaryOperator lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
//
/** Wraps JRE instance. */
@Nonnull
static LIntBinaryOperator wrap(final java.util.function.IntBinaryOperator other) {
return other::applyAsInt;
}
/** Wraps opposite (throwing vs non-throwing) instance. */
@Nonnull
static LIntBinaryOperator wrap(final @Nonnull LIntBinaryOperatorX other) {
return other::nestingDoApplyAsInt;
}
//
/**
* Creates function that returns the lesser value according to the comparator.
* @see {@link java.util.function.BinaryOperator#minBy}
*/
@Nonnull
static LIntBinaryOperator minBy(@Nonnull Comparator comparator) {
Null.nonNullArg(comparator, "comparator");
return (a, b) -> comparator.compare(a, b) <= 0 ? a : b;
}
/**
* Creates function that returns the lesser value according to the comparator.
* @see {@link java.util.function.BinaryOperator#maxBy}
*/
@Nonnull
static LIntBinaryOperator maxBy(@Nonnull Comparator comparator) {
Null.nonNullArg(comparator, "comparator");
return (a, b) -> comparator.compare(a, b) >= 0 ? a : b;
}
/**
* Returns function that returns the lower value.
* @see {@link java.util.function.BinaryOperator#minBy}
*/
@Nonnull
static LIntBinaryOperator min() {
return Integer::min;
}
/**
* Returns function that returns the higher value.
* @see {@link java.util.function.BinaryOperator#maxBy}
*/
@Nonnull
static LIntBinaryOperator max() {
return Integer::max;
}
//
/** Allows to manipulate the domain of the function. */
@Nonnull
default LIntBinaryOperator intBinaryOpComposeInt(@Nonnull final LIntUnaryOperator before1, @Nonnull final LIntUnaryOperator before2) {
Null.nonNullArg(before1, "before1");
Null.nonNullArg(before2, "before2");
return (final int v1, final int v2) -> this.doApplyAsInt(before1.doApplyAsInt(v1), before2.doApplyAsInt(v2));
}
/** Allows to manipulate the domain of the function. */
@Nonnull
default LToIntBiFunction intBinaryOpCompose(@Nonnull final LToIntFunction before1, @Nonnull final LToIntFunction before2) {
Null.nonNullArg(before1, "before1");
Null.nonNullArg(before2, "before2");
return (V1 v1, V2 v2) -> this.doApplyAsInt(before1.doApplyAsInt(v1), before2.doApplyAsInt(v2));
}
//
//
/** Combines two operators together in a order. */
@Nonnull
default LBiIntFunction then(@Nonnull LIntFunction after) {
Null.nonNullArg(after, "after");
return (int i1, int i2) -> after.doApply(this.doApplyAsInt(i1, i2));
}
//
//
/** Converts to non-throwing variant (if required). */
@Nonnull
default LIntBinaryOperator nestingIntBinaryOp() {
return this;
}
/** Converts to throwing variant (RuntimeException). */
@Nonnull
default LIntBinaryOperatorX nestingIntBinaryOpX() {
return this;
}
/** Converts to non-throwing variant that will propagate checked exception as it would be unchecked - there is no exception wrapping involved (at least not here). */
default LIntBinaryOperator shovingIntBinaryOp() {
return this;
}
/** Converts to throwing variant (RuntimeException) that will propagate checked exception as it would be unchecked - there is no exception wrapping involved (at least not here). */
default LIntBinaryOperatorX shovingIntBinaryOpX() {
return this;
}
//
}
