001/*
002 * ============================================================================
003 * Copyright © 2002-2020 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 org.apiguardian.api.API;
024import org.tquadrat.foundation.annotation.ClassVersion;
025
026/**
027 *  The TCE version of the interface
028 *  {@link java.util.function.BinaryOperator}
029 *  that represents an operation upon two operands of the same type, producing
030 *  a result of the same type as the operands. This is a specialisation of
031 *  {@link java.util.function.BiFunction}
032 *  for the case where the operands and the result are all the same type.<br>
033 *  <br>Different from the method
034 *  {@link java.util.function.BinaryOperator#apply(Object, Object) BinaryOperator.apply()}
035 *  the method
036 *  {@link #apply(Object,Object)}
037 *  of this interface declares to throw a
038 *  {@linkplain Exception checked exception}.<br>
039 *  <br>This is a functional interface whose functional method is
040 *  {@link #apply(Object,Object)}.
041 *
042 *  @param  <T> The type of the operands and result of the operator.
043 *
044 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
045 *  @version $Id: TCEBinaryOperator.java 993 2022-01-19 22:26:20Z tquadrat $
046 *  @since 0.0.5
047 *
048 *  @UMLGraph.link
049 */
050@FunctionalInterface
051@ClassVersion( sourceVersion = "$Id: TCEBinaryOperator.java 993 2022-01-19 22:26:20Z tquadrat $" )
052@API( status = STABLE, since = "0.0.5" )
053public interface TCEBinaryOperator<T> extends TCEBiFunction<T,T,T>
054{
055        /*---------*\
056    ====** Methods **==========================================================
057        \*---------*/
058    /**
059     *  Applies this function to the given arguments.
060     *
061     *  @param  arg1    The first function argument.
062     *  @param  arg2    The second function argument.
063     *  @return The function result.
064     *  @throws Exception   Something went wrong.
065     */
066    @SuppressWarnings( "ProhibitedExceptionDeclared" )
067    @Override
068    public T apply( T arg1, T arg2 ) throws Exception;
069}
070//  interface TCEBiFunction
071
072/*
073 *  End of File
074 */