1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.lang3.concurrent;
18
19 import org.apache.commons.lang3.function.FailableFunction;
20
21 /**
22 * Definition of an interface for a wrapper around a calculation that takes a single parameter and returns a result.
23 *
24 * <p>This interface allows for wrapping a calculation into a class so that it maybe passed around an application.</p>
25 *
26 * <p>See also {@code FailableFunction<I, O, InterruptedException>}.</p>
27 *
28 * @param <I> the type of the input to the calculation
29 * @param <O> the type of the output of the calculation
30 * @see FailableFunction
31 * @since 3.6
32 */
33 public interface Computable<I, O> {
34
35 /**
36 * This method carries out the given operation with the provided argument.
37 *
38 * @param arg
39 * the argument for the calculation
40 * @return the result of the calculation
41 * @throws InterruptedException
42 * thrown if the calculation is interrupted
43 */
44 O compute(I arg) throws InterruptedException;
45 }