util/concurrent/Callable.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain. Use, modify, and
 * redistribute this code in any way without acknowledgement.
 */

package java.util.concurrent;

/**
 * A task that returns a result and may throw an exception.
 * Implementors define a single method with no arguments called
 * <tt>call</tt>.
 *
 * <p>The <tt>Callable</tt> interface is similar to {@link Runnable},
 * in that both are designed for classes whose instances are
 * potentially executed by another thread.  A <tt>Runnable</tt>,
 * however, does not return a result and cannot throw a checked
 * exception.
 *

 * @since 1.5
 * @see Executor
 * @see FutureTask
 *
 * @spec JSR-166
 * @revised $Date: 2003/06/23 02:26:16 $
 * @editor $Author: brian $
 * @author Doug Lea
 */
public interface Callable<V> {
    /**
     * Computes a result, or throws an exception if unable to do so.
     *
     * @return computed result
     * @throws Exception if unable to compute a result
     */
    V call() throws Exception;
}
Revision:	1.4
Committed:	Tue Jun 24 14:34:47 2003 UTC (21 years ago) by dl
Branch:	MAIN
CVS Tags:	JSR166_CR1, JSR166_PRELIMINARY_TEST_RELEASE_2
Changes since 1.3:	+12 -10 lines
Log Message:	Added missing javadoc tags; minor reformatting
#	User	Rev	Content
1	tim	1.1	/*
2	dl	1.2	* Written by Doug Lea with assistance from members of JCP JSR-166
3			* Expert Group and released to the public domain. Use, modify, and
4			* redistribute this code in any way without acknowledgement.
5	tim	1.1	*/
6
7			package java.util.concurrent;
8
9			/**
10	dl	1.4	* A task that returns a result and may throw an exception.
11			* Implementors define a single method with no arguments called
12			* <tt>call</tt>.
13	tim	1.1	*
14	dl	1.4	* <p>The <tt>Callable</tt> interface is similar to {@link Runnable},
15			* in that both are designed for classes whose instances are
16			* potentially executed by another thread. A <tt>Runnable</tt>,
17			* however, does not return a result and cannot throw a checked
18			* exception.
19	tim	1.1	*
20	dl	1.4
21	tim	1.1	* @since 1.5
22			* @see Executor
23			* @see FutureTask
24			*
25			* @spec JSR-166
26	dl	1.4	* @revised $Date: 2003/06/23 02:26:16 $
27			* @editor $Author: brian $
28			* @author Doug Lea
29	tim	1.1	*/
30			public interface Callable<V> {
31			/**
32			* Computes a result, or throws an exception if unable to do so.
33			*
34			* @return computed result
35			* @throws Exception if unable to compute a result
36			*/
37			V call() throws Exception;
38			}