001/*
002 * ============================================================================
003 * Copyright © 2002-2021 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.function.tce;
020
021import static org.apiguardian.api.API.Status.STABLE;
022
023import java.util.function.BiFunction;
024import java.util.function.Function;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028
029/**
030 *  <p>{@summary The TCE version of the interface
031 *  {@link BiFunction}
032 *  that represents a function that accepts two arguments and produces a
033 *  result.} This is the two-arity specialisation of
034 *  {@link Function}.</p>
035 *  <p>Different from the method
036 *  {@link java.util.function.BiFunction#apply(Object, Object) BiFunction.apply()}
037 *  the method
038 *  {@link #apply(Object,Object)}
039 *  of this interface declares to throw a
040 *  {@linkplain Exception checked exception}.</p>
041 *  <p>This is a functional interface whose functional method is
042 *  {@link #apply(Object,Object)}.</p>
043 *
044 *  @param  <T1>    The type of the first argument to the function.
045 *  @param  <T2>    The type of the second argument to the function.
046 *  @param  <R> The type of the result of the function.
047 *
048 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
049 *  @version $Id: TCEBiFunction.java 884 2021-03-22 18:02:51Z tquadrat $
050 *  @since 0.0.5
051 *
052 *  @UMLGraph.link
053 */
054@FunctionalInterface
055@ClassVersion( sourceVersion = "$Id: TCEBiFunction.java 884 2021-03-22 18:02:51Z tquadrat $" )
056@API( status = STABLE, since = "0.0.5" )
057public interface TCEBiFunction<T1,T2,R>
058{
059        /*---------*\
060    ====** Methods **==========================================================
061        \*---------*/
062    /**
063     *  Applies this function to the given arguments.
064     *
065     *  @param  arg1    The first function argument.
066     *  @param  arg2    The second function argument.
067     *  @return The function result.
068     *  @throws Exception   Something went wrong.
069     */
070    @SuppressWarnings( "ProhibitedExceptionDeclared" )
071    public R apply( T1 arg1, T2 arg2 ) throws Exception;
072}
073//  interface TCEBiFunction
074
075/*
076 *  End of File
077 */