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.GwtIncompatible;
018import java.util.concurrent.Callable;
019import java.util.concurrent.ScheduledExecutorService;
020import java.util.concurrent.TimeUnit;
021import org.checkerframework.checker.nullness.qual.Nullable;
022
023/**
024 * A {@link ScheduledExecutorService} that returns {@link ListenableFuture} instances from its
025 * {@code ExecutorService} methods. To create an instance from an existing {@link
026 * ScheduledExecutorService}, call {@link
027 * MoreExecutors#listeningDecorator(ScheduledExecutorService)}.
028 *
029 * @author Chris Povirk
030 * @since 10.0
031 */
032@GwtIncompatible
033@ElementTypesAreNonnullByDefault
034public interface ListeningScheduledExecutorService
035    extends ScheduledExecutorService, ListeningExecutorService {
036
037  /** @since 15.0 (previously returned ScheduledFuture) */
038  @Override
039  ListenableScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit);
040
041  /** @since 15.0 (previously returned ScheduledFuture) */
042  @Override
043  <V extends @Nullable Object> ListenableScheduledFuture<V> schedule(
044      Callable<V> callable, long delay, TimeUnit unit);
045
046  /** @since 15.0 (previously returned ScheduledFuture) */
047  @Override
048  ListenableScheduledFuture<?> scheduleAtFixedRate(
049      Runnable command, long initialDelay, long period, TimeUnit unit);
050
051  /** @since 15.0 (previously returned ScheduledFuture) */
052  @Override
053  ListenableScheduledFuture<?> scheduleWithFixedDelay(
054      Runnable command, long initialDelay, long delay, TimeUnit unit);
055}