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.Function}
029 *  that represents a function that accepts one argument and produces a
030 *  result. <br>
031 *  <br>Different from the method
032 *  {@link java.util.function.Function#apply(Object) Function.apply()}
033 *  the method
034 *  {@link #apply(Object)}
035 *  of this interface declares to throw a
036 *  {@linkplain Exception checked exception}.<br>
037 *  <br>This is a functional interface whose functional method is
038 *  {@link #apply(Object)}.
039 *
040 *  @param <T> The type of the input to the function.
041 *  @param <R> The type of the result of the function.
042 *
043 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
044 *  @version $Id: TCEFunction.java 993 2022-01-19 22:26:20Z tquadrat $
045 *  @since 0.0.5
046 *
047 *  @UMLGraph.link
048 */
049@FunctionalInterface
050@ClassVersion( sourceVersion = "$Id: TCEFunction.java 993 2022-01-19 22:26:20Z tquadrat $" )
051@API( status = STABLE, since = "0.0.5" )
052public interface TCEFunction<T,R>
053{
054        /*---------*\
055    ====** Methods **==========================================================
056        \*---------*/
057    /**
058     *  Applies this function to the given argument.
059     *
060     *  @param  arg The function argument.
061     *  @return The function result.
062     *  @throws Exception   Something went wrong.
063     */
064    @SuppressWarnings( "ProhibitedExceptionDeclared" )
065    public R apply( T arg ) throws Exception;
066}
067//  interface TCEFunction
068
069/*
070 *  End of File
071 */