util/concurrent/RunnableScheduledFuture.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/publicdomain/zero/1.0/
 */

package java.util.concurrent;

/**
 * A {@link ScheduledFuture} that is {@link Runnable}. Successful
 * execution of the {@code run} method causes completion of the
 * {@code Future} and allows access to its results.
 * @see FutureTask
 * @see Executor
 * @since 1.6
 * @author Doug Lea
 * @param <V> The result type returned by this Future's {@code get} method
 */
public interface RunnableScheduledFuture<V> extends RunnableFuture<V>, ScheduledFuture<V> {

    /**
     * Returns {@code true} if this task is periodic. A periodic task may
     * re-run according to some schedule. A non-periodic task can be
     * run only once.
     *
     * @return {@code true} if this task is periodic
     */
    boolean isPeriodic();
}
Revision:	1.9
Committed:	Wed May 15 02:39:59 2013 UTC (11 years ago) by jsr166
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.8:	+2 -2 lines
Log Message:	consistent use of "@return {@code true}"
#	User	Rev	Content
1	peierls	1.1	/*
2			* Written by Doug Lea with assistance from members of JCP JSR-166
3			* Expert Group and released to the public domain, as explained at
4	jsr166	1.7	* http://creativecommons.org/publicdomain/zero/1.0/
5	peierls	1.1	*/
6
7			package java.util.concurrent;
8
9			/**
10	dl	1.3	* A {@link ScheduledFuture} that is {@link Runnable}. Successful
11	jsr166	1.8	* execution of the {@code run} method causes completion of the
12			* {@code Future} and allows access to its results.
13	peierls	1.1	* @see FutureTask
14			* @see Executor
15			* @since 1.6
16			* @author Doug Lea
17	jsr166	1.8	* @param <V> The result type returned by this Future's {@code get} method
18	peierls	1.1	*/
19	dl	1.3	public interface RunnableScheduledFuture<V> extends RunnableFuture<V>, ScheduledFuture<V> {
20	dl	1.2
21			/**
22	jsr166	1.9	* Returns {@code true} if this task is periodic. A periodic task may
23	dl	1.2	* re-run according to some schedule. A non-periodic task can be
24			* run only once.
25	jsr166	1.4	*
26	jsr166	1.9	* @return {@code true} if this task is periodic
27	jsr166	1.4	*/
28	dl	1.2	boolean isPeriodic();
29	peierls	1.1	}