com.couchbase.client.core.deps.com.google.common.util.concurrent.ListeningExecutorService Maven / Gradle / Ivy
Show all versions of core-io Show documentation
/*
* Copyright (C) 2010 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.couchbase.client.core.deps.com.google.common.util.concurrent;
import static com.couchbase.client.core.deps.com.google.common.util.concurrent.Internal.toNanosSaturated;
import com.couchbase.client.core.deps.com.google.common.annotations.GwtIncompatible;
import com.couchbase.client.core.deps.com.google.common.annotations.J2ktIncompatible;
import com.couchbase.client.core.deps.com.google.errorprone.annotations.DoNotMock;
import java.time.Duration;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* An {@link ExecutorService} that returns {@link ListenableFuture} instances. To create an instance
* from an existing {@link ExecutorService}, call {@link
* MoreExecutors#listeningDecorator(ExecutorService)}.
*
* @author Chris Povirk
* @since 10.0
*/
@DoNotMock(
"Use TestingExecutors.sameThreadScheduledExecutor, or wrap a real Executor from "
+ "java.util.concurrent.Executors with MoreExecutors.listeningDecorator")
@GwtIncompatible
@ElementTypesAreNonnullByDefault
public interface ListeningExecutorService extends ExecutorService {
/**
* @return a {@code ListenableFuture} representing pending completion of the task
* @throws RejectedExecutionException {@inheritDoc}
*/
@Override
ListenableFuture submit(Callable task);
/**
* @return a {@code ListenableFuture} representing pending completion of the task
* @throws RejectedExecutionException {@inheritDoc}
*/
@Override
ListenableFuture submit(Runnable task);
/**
* @return a {@code ListenableFuture} representing pending completion of the task
* @throws RejectedExecutionException {@inheritDoc}
*/
@Override
ListenableFuture submit(
Runnable task, @ParametricNullness T result);
/**
* {@inheritDoc}
*
* All elements in the returned list must be {@link ListenableFuture} instances. The easiest
* way to obtain a {@code List>} from this method is an unchecked (but safe)
* cast:
*
*
* {@code @SuppressWarnings("unchecked") // guaranteed by invokeAll contract}
* {@code List> futures = (List) executor.invokeAll(tasks);}
*
*
* @return A list of {@code ListenableFuture} instances representing the tasks, in the same
* sequential order as produced by the iterator for the given task list, each of which has
* completed.
* @throws RejectedExecutionException {@inheritDoc}
* @throws NullPointerException if any task is null
*/
@Override
List> invokeAll(Collection> tasks)
throws InterruptedException;
/**
* {@inheritDoc}
*
* All elements in the returned list must be {@link ListenableFuture} instances. The easiest
* way to obtain a {@code List>} from this method is an unchecked (but safe)
* cast:
*
*
* {@code @SuppressWarnings("unchecked") // guaranteed by invokeAll contract}
* {@code List> futures = (List) executor.invokeAll(tasks, timeout, unit);}
*
*
* @return a list of {@code ListenableFuture} instances representing the tasks, in the same
* sequential order as produced by the iterator for the given task list. If the operation did
* not time out, each task will have completed. If it did time out, some of these tasks will
* not have completed.
* @throws RejectedExecutionException {@inheritDoc}
* @throws NullPointerException if any task is null
*/
@Override
List> invokeAll(
Collection> tasks, long timeout, TimeUnit unit)
throws InterruptedException;
/**
* Duration-based overload of {@link #invokeAll(Collection, long, TimeUnit)}.
*
* @since 32.1.0
*/
@J2ktIncompatible
default List> invokeAll(
Collection> tasks, Duration timeout) throws InterruptedException {
return invokeAll(tasks, toNanosSaturated(timeout), TimeUnit.NANOSECONDS);
}
/**
* Duration-based overload of {@link #invokeAny(Collection, long, TimeUnit)}.
*
* @since 32.1.0
*/
@J2ktIncompatible
default T invokeAny(
Collection> tasks, Duration timeout)
throws InterruptedException, ExecutionException, TimeoutException {
return invokeAny(tasks, toNanosSaturated(timeout), TimeUnit.NANOSECONDS);
}
/**
* Duration-based overload of {@link #awaitTermination(long, TimeUnit)}.
*
* @since 32.1.0
*/
@J2ktIncompatible
default boolean awaitTermination(Duration timeout) throws InterruptedException {
return awaitTermination(toNanosSaturated(timeout), TimeUnit.NANOSECONDS);
}
}