View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.lang3.function;
19  
20  import java.util.function.BiFunction;
21  
22  /**
23   * A function that accepts two arguments and produces a boolean result. This is the {@code boolean}-producing primitive
24   * specialization for {@link BiFunction}.
25   *
26   * @param <T> the type of the first argument to the function.
27   * @param <U> the type of the second argument to the function.
28   * @see BiFunction
29   * @since 3.12.0
30   */
31  @FunctionalInterface
32  public interface ToBooleanBiFunction<T, U> {
33  
34      /**
35       * Applies this function to the given arguments.
36       *
37       * @param t the first function argument.
38       * @param u the second function argument.
39       * @return the function result.
40       */
41      boolean applyAsBoolean(T t, U u);
42  }