Source code
Description: source: package: org.apache.commons.lang3.concurrent, interface: Computable

    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>This interface allows for wrapping a calculation into a class so that it maybe passed around an application.</p>
    025 *
    026 * <p>See also {@code FailableFunction<I, O, InterruptedException>}.</p>
    027 *
    028 * @param <I> the type of the input to the calculation
    029 * @param <O> the type of the output of the calculation
    030 * @see FailableFunction
    031 * @since 3.6
    032 */
    033@FunctionalInterface
    034public interface Computable<I, O> {
    035
    036    /**
    037     * This method carries out the given operation with the provided argument.
    038     *
    039     * @param arg
    040     *            the argument for the calculation
    041     * @return the result of the calculation
    042     * @throws InterruptedException
    043     *             thrown if the calculation is interrupted
    044     */
    045    O compute(I arg) throws InterruptedException;
    046}