001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.lang3.function;
019
020import java.util.function.BiFunction;
021
022/**
023 * A function that accepts two arguments and produces a boolean result. This is the {@code boolean}-producing primitive
024 * specialization for {@link BiFunction}.
025 *
026 * @param <T> the type of the first argument to the function.
027 * @param <U> the type of the second argument to the function.
028 * @see BiFunction
029 * @since 3.12.0
030 */
031@FunctionalInterface
032public interface ToBooleanBiFunction<T, U> {
033
034    /**
035     * Applies this function to the given arguments.
036     *
037     * @param t the first function argument.
038     * @param u the second function argument.
039     * @return the function result.
040     */
041    boolean applyAsBoolean(T t, U u);
042}