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.predicate.LBiPredicate 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.predicate;
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) LBiPredicate for Java 8.
*
* Type: predicate
*
* Domain (lvl: 2): T1 t1,T2 t2
*
* Co-domain: none
*
* @see LBiPredicateX
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LBiPredicate extends LBiPredicateX, MetaPredicate, PrimitiveCodomain, MetaInterface.NonThrowing { // NOSONAR
static final String DESCRIPTION = "LBiPredicate: boolean doTest(T1 t1,T2 t2)";
/**
* Default implementation for JRE method that calls exception nesting method.
* @deprecated Calling this method via LBiPredicate interface should be discouraged.
*/
@Override
@Deprecated
default boolean test(T1 t1, T2 t2) {
return this.nestingDoTest(t1, t2);
}
boolean doTest(T1 t1, T2 t2);
/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
default boolean nestingDoTest(T1 t1, T2 t2) {
return this.doTest(t1, t2);
}
/** Function call that handles exceptions by always propagating them as is even when they are undeclared checked ones. */
default boolean shovingDoTest(T1 t1, T2 t2) {
return this.doTest(t1, t2);
}
/** Just to mirror the method: Ensures the result is not null */
default boolean nonNullDoTest(T1 t1, T2 t2) {
return doTest(t1, t2);
}
/** For convenience, where "test()" makes things more confusing than "applyAsBoolean()". */
default boolean doApplyAsBoolean(T1 t1, T2 t2) {
return doTest(t1, t2);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LBiPredicate.DESCRIPTION;
}
/** Captures arguments but delays the evaluation. */
default LBoolSupplier captureBiPred(T1 t1, T2 t2) {
return () -> this.doTest(t1, t2);
}
/** Creates function that always returns the same value. */
static LBiPredicate constant(boolean r) {
return (t1, t2) -> r;
}
/** Captures single parameter function into this interface where only 1st parameter will be used. */
@Nonnull
static LBiPredicate test1st(@Nonnull LPredicate func) {
return (t1, t2) -> func.doTest(t1);
}
/** Captures single parameter function into this interface where only 2nd parameter will be used. */
@Nonnull
static LBiPredicate test2nd(@Nonnull LPredicate func) {
return (t1, t2) -> func.doTest(t2);
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LBiPredicate l(final @Nonnull LBiPredicate lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
//
/** Wraps JRE instance. */
@Nonnull
static LBiPredicate wrap(final java.util.function.BiPredicate other) {
return other::test;
}
/** Wraps opposite (throwing vs non-throwing) instance. */
@Nonnull
static LBiPredicate wrap(final @Nonnull LBiPredicateX other) {
return other::nestingDoTest;
}
//
//
/**
* Returns a predicate that represents the logical negation of this predicate.
*
* @see {@link java.util.function.Predicate#negate}
*/
@Nonnull
default LBiPredicate negate() {
return (T1 t1, T2 t2) -> !doTest(t1, t2);
}
/**
* Returns a predicate that represents the logical AND of evaluation of this predicate and the argument one.
* @see {@link java.util.function.Predicate#and()}
*/
@Nonnull
default LBiPredicate and(@Nonnull LBiPredicate other) {
Null.nonNullArg(other, "other");
return (T1 t1, T2 t2) -> doTest(t1, t2) && other.doTest(t1, t2);
}
/**
* Returns a predicate that represents the logical OR of evaluation of this predicate and the argument one.
* @see {@link java.util.function.Predicate#or}
*/
@Nonnull
default LBiPredicate or(@Nonnull LBiPredicate other) {
Null.nonNullArg(other, "other");
return (T1 t1, T2 t2) -> doTest(t1, t2) || other.doTest(t1, t2);
}
/**
* Returns a predicate that represents the logical XOR of evaluation of this predicate and the argument one.
* @see {@link java.util.function.Predicate#or}
*/
@Nonnull
default LBiPredicate xor(@Nonnull LBiPredicate other) {
Null.nonNullArg(other, "other");
return (T1 t1, T2 t2) -> doTest(t1, t2) ^ other.doTest(t1, t2);
}
/**
* Creates predicate that evaluates if an object is equal with the argument one.
* @see {@link java.util.function.Predicate#isEqual()
*/
@Nonnull
static LBiPredicate isEqual(final T1 v1, final T2 v2) {
return (t1, t2) -> (t1 == null ? v1 == null : t1.equals(v1)) && (t2 == null ? v2 == null : t2.equals(v2));
}
//
//
/** Allows to manipulate the domain of the function. */
@Nonnull
default LBiPredicate biPredCompose(@Nonnull final LFunction before1, @Nonnull final LFunction before2) {
Null.nonNullArg(before1, "before1");
Null.nonNullArg(before2, "before2");
return (final V1 v1, final V2 v2) -> this.doTest(before1.doApply(v1), before2.doApply(v2));
}
//
//
/** Combines two predicates together in a order. */
@Nonnull
default LBiFunction boolToBiFunction(@Nonnull LBoolFunction after) {
Null.nonNullArg(after, "after");
return (T1 t1, T2 t2) -> after.doApply(this.doTest(t1, t2));
}
//
//
/** Converts to non-throwing variant (if required). */
@Nonnull
default LBiPredicate nestingBiPred() {
return this;
}
/** Converts to throwing variant (RuntimeException). */
@Nonnull
default LBiPredicateX nestingBiPredX() {
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 LBiPredicate shovingBiPred() {
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 LBiPredicateX shovingBiPredX() {
return this;
}
//
}
