org.eu.zajc.ef.tripredicate.TriPredicate Maven / Gradle / Ivy
Show all versions of extended-functions Show documentation
// SPDX-License-Identifier: Apache-2.0
/*
* extended-functions
* Copyright 2021-2024 Marko Zajc
*
* 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 org.eu.zajc.ef.tripredicate;
import java.util.Objects;
import java.util.function.*;
import javax.annotation.Nonnull;
/**
* Represents a predicate (boolean-valued function) of two arguments. This is the
* three-arity specialization of {@link Predicate}.
*
*
* This is a functional interface whose functional method is
* {@link #test(Object, Object, Object)}.
*
* @param
* the type of the first argument to the predicate
* @param
* the type of the second argument the predicate
* @param
* the type of the third argument to the predicate
*
* @see Predicate
* @see BiPredicate
*
* @author Marko Zajc
*/
@FunctionalInterface
public interface TriPredicate {
/**
* Evaluates this predicate on the given arguments.
*
* @param t
* the first input argument
* @param u
* the second input argument
* @param v
* the third input argument
*
* @return {@code true} if the input arguments match the predicate, otherwise
* {@code false}
*/
boolean test(T t, U u, V v);
/**
* Returns a composed predicate that represents a short-circuiting logical AND of
* this predicate and another. When evaluating the composed predicate, if this
* predicate is {@code false}, then the {@code other} predicate is not evaluated.
*
*
* Any exceptions thrown during evaluation of either predicate are relayed to the
* caller; if evaluation of this predicate throws an exception, the {@code other}
* predicate will not be evaluated.
*
* @param other
* a predicate that will be logically-ANDed with this predicate
*
* @return a composed predicate that represents the short-circuiting logical AND of
* this predicate and the {@code other} predicate
*
* @throws NullPointerException
* if other is null
*/
@Nonnull
default TriPredicate and(@Nonnull TriPredicate other) {
Objects.requireNonNull(other);
return (t, u, v) -> test(t, u, v) && other.test(t, u, v);
}
/**
* Returns a predicate that represents the logical negation of this predicate.
*
* @return a predicate that represents the logical negation of this predicate
*/
@Nonnull
default TriPredicate negate() {
return (t, u, v) -> !test(t, u, v);
}
/**
* Returns a composed predicate that represents a short-circuiting logical OR of this
* predicate and another. When evaluating the composed predicate, if this predicate
* is {@code true}, then the {@code other} predicate is not evaluated.
*
*
* Any exceptions thrown during evaluation of either predicate are relayed to the
* caller; if evaluation of this predicate throws an exception, the {@code other}
* predicate will not be evaluated.
*
* @param other
* a predicate that will be logically-ORed with this predicate
*
* @return a composed predicate that represents the short-circuiting logical OR of
* this predicate and the {@code other} predicate
*
* @throws NullPointerException
* if other is null
*/
@Nonnull
default TriPredicate or(@Nonnull TriPredicate other) {
Objects.requireNonNull(other);
return (t, u, v) -> test(t, u, v) || other.test(t, u, v);
}
}