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 *  <p>{@summary The TCE version of the interface
028 *  {@link java.util.function.BiConsumer}
029 *  that represents an operation that accepts two input arguments and returns
030 *  no result.} This is the two-arity specialisation of
031 *  {@link TCEConsumer}.</p>
032 *  <p>Unlike most other functional interfaces, {@code BiConsumer} is expected
033 *  to operate via side effects.</p>
034 *  <p>Different from the method
035 *  {@link java.util.function.BiConsumer#accept(Object,Object) BiConsumer.accept()}
036 *  the method
037 *  {@link #accept(Object,Object)}
038 *  of this interface declares to throw a
039 *  {@linkplain Exception checked exception}.</p>
040 *  <p>This is a functional interface whose functional method is
041 *  {@link #accept(Object,Object)}.</p>
042 *
043 *  @param <T1> The type of the first argument to the operation.
044 *  @param <T2> The type of the second argument to the operation.
045 *
046 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
047 *  @version $Id: TCEBiConsumer.java 1020 2022-02-27 21:26:03Z tquadrat $
048 *  @since 0.0.5
049 *
050 *  @UMLGraph.link
051 */
052@SuppressWarnings( "ProhibitedExceptionDeclared" )
053@FunctionalInterface
054@ClassVersion( sourceVersion = "$Id: TCEBiConsumer.java 1020 2022-02-27 21:26:03Z tquadrat $" )
055@API( status = STABLE, since = "0.0.5" )
056public interface TCEBiConsumer<T1,T2>
057{
058        /*---------*\
059    ====** Methods **==========================================================
060        \*---------*/
061    /**
062     *  Performs this operation on the given argument.
063     *
064     *  @param  arg1    The first input argument
065     *  @param  arg2    The second input argument
066     *  @throws Exception   Something went wrong.
067     */
068    public void accept( T1 arg1, T2 arg2 ) throws Exception;
069}
070//  interface TCEBiConsumer
071
072/*
073 *  End of File
074 */