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 a single arguments, produces a result and may thrown an exception.
021 *
022 * @param <I> the type of the input of the function
023 * @param <R> the type of the result of the function
024 * @param <T> the type of the exception the accept method may throw
025 *
026 * @see       java.util.function.Function
027 */
028@FunctionalInterface
029public interface ThrowingFunction<I, R, T extends Throwable> {
030    /**
031     * Applies this function to the given argument, potentially throwing an exception.
032     *
033     * @param  in the function argument
034     * @return    the function result
035     * @throws T  the exception that may be thrown
036     */
037    R apply(I in) throws T;
038}