rt/emul/compact/src/main/java/java/util/concurrent/Callable.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Sat, 19 Mar 2016 10:48:29 +0100
changeset 1891 c8af252ea9eb
parent 772 d382dacfd73f
parent 1890 212417b74b72
permissions -rw-r--r--
Merging in JDK's concurrent interfaces
jaroslav@1890
     1
/*
jaroslav@1890
     2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@1890
     3
 *
jaroslav@1890
     4
 * This code is free software; you can redistribute it and/or modify it
jaroslav@1890
     5
 * under the terms of the GNU General Public License version 2 only, as
jaroslav@1890
     6
 * published by the Free Software Foundation.  Oracle designates this
jaroslav@1890
     7
 * particular file as subject to the "Classpath" exception as provided
jaroslav@1890
     8
 * by Oracle in the LICENSE file that accompanied this code.
jaroslav@1890
     9
 *
jaroslav@1890
    10
 * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@1890
    11
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@1890
    12
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@1890
    13
 * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@1890
    14
 * accompanied this code).
jaroslav@1890
    15
 *
jaroslav@1890
    16
 * You should have received a copy of the GNU General Public License version
jaroslav@1890
    17
 * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@1890
    18
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@1890
    19
 *
jaroslav@1890
    20
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@1890
    21
 * or visit www.oracle.com if you need additional information or have any
jaroslav@1890
    22
 * questions.
jaroslav@1890
    23
 */
jaroslav@1890
    24
jaroslav@1890
    25
/*
jaroslav@1890
    26
 * This file is available under and governed by the GNU General Public
jaroslav@1890
    27
 * License version 2 only, as published by the Free Software Foundation.
jaroslav@1890
    28
 * However, the following notice accompanied the original version of this
jaroslav@1890
    29
 * file:
jaroslav@1890
    30
 *
jaroslav@1890
    31
 * Written by Doug Lea with assistance from members of JCP JSR-166
jaroslav@1890
    32
 * Expert Group and released to the public domain, as explained at
jaroslav@1890
    33
 * http://creativecommons.org/publicdomain/zero/1.0/
jaroslav@1890
    34
 */
jaroslav@1890
    35
jaroslav@1890
    36
package java.util.concurrent;
jaroslav@1890
    37
jaroslav@1890
    38
/**
jaroslav@1890
    39
 * A task that returns a result and may throw an exception.
jaroslav@1890
    40
 * Implementors define a single method with no arguments called
jaroslav@1890
    41
 * <tt>call</tt>.
jaroslav@1890
    42
 *
jaroslav@1890
    43
 * <p>The <tt>Callable</tt> interface is similar to {@link
jaroslav@1890
    44
 * java.lang.Runnable}, in that both are designed for classes whose
jaroslav@1890
    45
 * instances are potentially executed by another thread.  A
jaroslav@1890
    46
 * <tt>Runnable</tt>, however, does not return a result and cannot
jaroslav@1890
    47
 * throw a checked exception.
jaroslav@1890
    48
 *
jaroslav@1890
    49
 * <p> The {@link Executors} class contains utility methods to
jaroslav@1890
    50
 * convert from other common forms to <tt>Callable</tt> classes.
jaroslav@1890
    51
 *
jaroslav@1890
    52
 * @see Executor
jaroslav@1890
    53
 * @since 1.5
jaroslav@1890
    54
 * @author Doug Lea
jaroslav@1890
    55
 * @param <V> the result type of method <tt>call</tt>
jaroslav@1890
    56
 */
jaroslav@1890
    57
public interface Callable<V> {
jaroslav@1890
    58
    /**
jaroslav@1890
    59
     * Computes a result, or throws an exception if unable to do so.
jaroslav@1890
    60
     *
jaroslav@1890
    61
     * @return computed result
jaroslav@1890
    62
     * @throws Exception if unable to compute a result
jaroslav@1890
    63
     */
jaroslav@1890
    64
    V call() throws Exception;
jaroslav@1890
    65
}