The ToIntBiFunction is a functional interface in Java that comes from the java.util.function package. It represents a function that accepts two arguments and produces an int as a result. This interface is useful when we need to create a lambda expression or method reference that takes in two arguments of generic types and returns an int.

Functional Method

The functional method of ToIntBiFunction is:

int applyAsInt(T t, U u);

Here:
– T is the type of the first argument.
– U is the type of the second argument.
– The method returns an int.

Example Use Cases

We can use ToIntBiFunction in scenarios like calculations, comparisons, or when processing two arguments to produce an int result.

---

Example 1: Adding Two Integer Values

package org.kodejava.util.function;

import java.util.function.ToIntBiFunction;

public class ToIntBiFunctionExample {
    public static void main(String[] args) {
        // Define a ToIntBiFunction that adds two integers
        ToIntBiFunction<Integer, Integer> add = (a, b) -> a + b;

        // Use the applyAsInt method
        int result = add.applyAsInt(5, 10);
        System.out.println("Sum: " + result);
        // Output: Sum: 15
    }
}

---

Example 2: Length of Concatenated Strings

package org.kodejava.util.function;

import java.util.function.ToIntBiFunction;

public class ToIntBiFunctionExample2 {
    public static void main(String[] args) {
        // Define a ToIntBiFunction that computes the length of concatenated strings
        ToIntBiFunction<String, String> concatenatedLength =
                (str1, str2) -> (str1 + str2).length();

        // Use the applyAsInt method
        int length = concatenatedLength.applyAsInt("Hello", "World");
        System.out.println("Length of concatenated string: " + length);
        // Output: 10
    }
}

---

Example 3: Comparing Two Numbers

package org.kodejava.util.function;

import java.util.function.ToIntBiFunction;

public class ToIntBiFunctionExample3 {
    public static void main(String[] args) {
        // Define a ToIntBiFunction that compares two integers 
        // (returns -1, 0, or 1 like Comparator)
        ToIntBiFunction<Integer, Integer> compare = (a, b) -> Integer.compare(a, b);

        // Compare two numbers
        int compareResult = compare.applyAsInt(15, 10);
        System.out.println("Comparison result: " + compareResult);
        // Output: 1 (because 15 > 10)
    }
}

---

Key Points:

1. Method Signature: The applyAsInt method in ToIntBiFunction takes two arguments of types T and U, and it returns an int.
2. Lambda-Friendly: It is commonly used with lambda expressions or method references.
3. Generic Parameters: we can use it with any types for T and U, making it flexible for computations involving two inputs that result in an integer.

By using this functional interface, we benefit from the concise and functional programming style enabled in Java 8 and later.