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 *      http://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 */
017package org.apache.camel.util.function;
018
019/**
020 * Represents a function that accepts two arguments, produces a result and may thrown an exception.
021 *
022 * @param <I1> the type of the first argument to the operation
023 * @param <I2> the type of the second argument to the operation
024 * @param <R>  the type of the result of the function
025 * @param <T>  the type of the exception the accept method may throw
026 *
027 * @see        java.util.function.BiFunction
028 */
029@FunctionalInterface
030public interface ThrowingBiFunction<I1, I2, R, T extends Throwable> {
031    /**
032     * Applies this function to the given arguments, potentially throwing an exception.
033     *
034     * @param  in1 the first function argument
035     * @param  in2 the second function argument
036     * @return     the function result
037     * @throws T   the exception that may be thrown
038     */
039    R apply(I1 in1, I2 in2) throws T;
040}