com.mogudiandian.util.function.TriPredicate Maven / Gradle / Ivy
Show all versions of joshua-util Show documentation
package com.mogudiandian.util.function;
import java.util.Objects;
/**
* Represents a predicate (boolean-valued function) of two arguments. This is
* the two-arity specialization of {@link java.util.function.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 the predicate
*
* @see java.util.function.Predicate
* @since 1.0.9
* @author Joshua Sun
*/
@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
*/
default TriPredicate and(TriPredicate other) {
Objects.requireNonNull(other);
return (T t, U u, V 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
*/
default TriPredicate negate() {
return (T t, U u, V 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
*/
default TriPredicate or(TriPredicate other) {
Objects.requireNonNull(other);
return (T t, U u, V v) -> test(t, u, v) || other.test(t, u, v);
}
}