RunnableScheduledFuture.java revision 29957558cf0db700bfaae360a80c42dc3871d0e5 
1/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation.  Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25/*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file:
30 *
31 * Written by Doug Lea with assistance from members of JCP JSR-166
32 * Expert Group and released to the public domain, as explained at
33 * http://creativecommons.org/publicdomain/zero/1.0/
34 */
35
36package java.util.concurrent;
37
38/**
39 * A {@link ScheduledFuture} that is {@link Runnable}. Successful
40 * execution of the {@code run} method causes completion of the
41 * {@code Future} and allows access to its results.
42 * @see FutureTask
43 * @see Executor
44 * @since 1.6
45 * @author Doug Lea
46 * @param <V> The result type returned by this Future's {@code get} method
47 */
48public interface RunnableScheduledFuture<V> extends RunnableFuture<V>, ScheduledFuture<V> {
49
50    /**
51     * Returns {@code true} if this task is periodic. A periodic task may
52     * re-run according to some schedule. A non-periodic task can be
53     * run only once.
54     *
55     * @return {@code true} if this task is periodic
56     */
57    boolean isPeriodic();
58}
59