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 *      https://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.commons.lang3.concurrent;
018
019import org.apache.commons.lang3.function.FailableFunction;
020
021/**
022 * Definition of an interface for a wrapper around a calculation that takes a single parameter and returns a result.
023 *
024 * <p>
025 * This interface allows for wrapping a calculation into a class so that it maybe passed around an application.
026 * </p>
027 *
028 * <p>
029 * See also {@code FailableFunction<I, O, InterruptedException>}.
030 * </p>
031 *
032 * @param <I> The type of the input to the calculation
033 * @param <O> The type of the output of the calculation
034 * @see FailableFunction
035 * @since 3.6
036 */
037@FunctionalInterface
038public interface Computable<I, O> {
039
040    /**
041     * This method carries out the given operation with the provided argument.
042     *
043     * @param arg
044     *            the argument for the calculation
045     * @return The result of the calculation
046     * @throws InterruptedException Thrown if the calculation is interrupted.
047     */
048    O compute(I arg) throws InterruptedException;
049}