001/*
002 * Copyright (C) 2011 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005 * in compliance with the License. You may obtain a copy of the License at
006 *
007 * http://www.apache.org/licenses/LICENSE-2.0
008 *
009 * Unless required by applicable law or agreed to in writing, software distributed under the License
010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011 * or implied. See the License for the specific language governing permissions and limitations under
012 * the License.
013 */
014
015package com.google.common.util.concurrent;
016
017import com.google.common.annotations.Beta;
018import com.google.common.annotations.GwtIncompatible;
019import com.google.errorprone.annotations.CanIgnoreReturnValue;
020import java.util.concurrent.Callable;
021import java.util.concurrent.ScheduledExecutorService;
022import java.util.concurrent.TimeUnit;
023
024/**
025 * A {@link ScheduledExecutorService} that returns {@link ListenableFuture} instances from its
026 * {@code ExecutorService} methods. To create an instance from an existing {@link
027 * ScheduledExecutorService}, call {@link
028 * MoreExecutors#listeningDecorator(ScheduledExecutorService)}.
029 *
030 * @author Chris Povirk
031 * @since 10.0
032 */
033@Beta
034@CanIgnoreReturnValue
035@GwtIncompatible
036public interface ListeningScheduledExecutorService
037    extends ScheduledExecutorService, ListeningExecutorService {
038
039  /** @since 15.0 (previously returned ScheduledFuture) */
040  @Override
041  ListenableScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit);
042
043  /** @since 15.0 (previously returned ScheduledFuture) */
044  @Override
045  <V> ListenableScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit);
046
047  /** @since 15.0 (previously returned ScheduledFuture) */
048  @Override
049  ListenableScheduledFuture<?> scheduleAtFixedRate(
050      Runnable command, long initialDelay, long period, TimeUnit unit);
051
052  /** @since 15.0 (previously returned ScheduledFuture) */
053  @Override
054  ListenableScheduledFuture<?> scheduleWithFixedDelay(
055      Runnable command, long initialDelay, long delay, TimeUnit unit);
056}