org.eu.zajc.ef.bipredicate.except.EBiPredicate 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.bipredicate.except;
import static org.eu.zajc.ef.Utilities.asUnchecked;
import java.util.function.BiPredicate;
import org.eu.zajc.ef.predicate.except.EPredicate;
import org.eu.zajc.ef.tripredicate.except.ETriPredicate;
/**
* Represents a predicate (boolean-valued function) of two arguments. This is the
* two-arity specialization of {@link EPredicate}.
*
*
* Additionally, the functional method is allowed to throw a generic
* {@link Throwable} of type {@code E}.
*
*
* This is a functional interface whose functional method is
* {@link #testChecked(Object, Object)}.
*
* @param
* the type of the first argument to the predicate
* @param
* the type of the second argument the predicate
* @param
* {@link Throwable} type
*
* @see BiPredicate
* @see EPredicate
* @see ETriPredicate
*
* @author Marko Zajc
*/
@FunctionalInterface
public interface EBiPredicate extends BiPredicate {
@Override
default boolean test(T t, U u) {
try {
return testChecked(t, u);
} catch (Throwable e) { // NOSONAR can't catch generic exceptions
throw asUnchecked(e);
}
}
/**
* Same as {@link #test(Object, Object)}, but throws a checked exception.
*
* @param t
* the first input argument
* @param u
* the second input argument
*
* @return {@code true} if the input arguments match the predicate, otherwise
* {@code false}
*
* @throws E
* the defined exception type
*/
boolean testChecked(T t, U u) throws E;
}