/*
* 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.google.common.util.concurrent;
import com.google.common.annotations.GwtIncompatible;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;
An ExecutorService
that returns ListenableFuture
instances. To create an instance from an existing ExecutorService
, call MoreExecutors.listeningDecorator(ExecutorService)
. Author: Chris Povirk Since: 10.0
/**
* 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
*/
@GwtIncompatible
public interface ListeningExecutorService extends ExecutorService {
Throws: - RejectedExecutionException – {@inheritDoc}
Returns: a ListenableFuture
representing pending completion of the task
/**
* @return a {@code ListenableFuture} representing pending completion of the task
* @throws RejectedExecutionException {@inheritDoc}
*/
@Override
<T> ListenableFuture<T> submit(Callable<T> task);
Throws: - RejectedExecutionException – {@inheritDoc}
Returns: a ListenableFuture
representing pending completion of the task
/**
* @return a {@code ListenableFuture} representing pending completion of the task
* @throws RejectedExecutionException {@inheritDoc}
*/
@Override
ListenableFuture<?> submit(Runnable task);
Throws: - RejectedExecutionException – {@inheritDoc}
Returns: a ListenableFuture
representing pending completion of the task
/**
* @return a {@code ListenableFuture} representing pending completion of the task
* @throws RejectedExecutionException {@inheritDoc}
*/
@Override
<T> ListenableFuture<T> submit(Runnable task, T result);
{@inheritDoc}
All elements in the returned list must be ListenableFuture
instances. The easiest way to obtain a List<ListenableFuture<T>>
from this method is an unchecked (but safe) cast:
@SuppressWarnings("unchecked") // guaranteed by invokeAll contract
List<ListenableFuture<T>> futures = (List) executor.invokeAll(tasks);
Throws: - RejectedExecutionException – {@inheritDoc}
- NullPointerException – if any task is null
Returns: A list of 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.
/**
* {@inheritDoc}
*
* <p>All elements in the returned list must be {@link ListenableFuture} instances. The easiest
* way to obtain a {@code List<ListenableFuture<T>>} from this method is an unchecked (but safe)
* cast:
*
* <pre>
* {@code @SuppressWarnings("unchecked") // guaranteed by invokeAll contract}
* {@code List<ListenableFuture<T>> futures = (List) executor.invokeAll(tasks);}
* </pre>
*
* @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
<T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
throws InterruptedException;
{@inheritDoc}
All elements in the returned list must be ListenableFuture
instances. The easiest way to obtain a List<ListenableFuture<T>>
from this method is an unchecked (but safe) cast:
@SuppressWarnings("unchecked") // guaranteed by invokeAll contract
List<ListenableFuture<T>> futures = (List) executor.invokeAll(tasks, timeout, unit);
Throws: - RejectedExecutionException – {@inheritDoc}
- NullPointerException – if any task is null
Returns: a list of 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.
/**
* {@inheritDoc}
*
* <p>All elements in the returned list must be {@link ListenableFuture} instances. The easiest
* way to obtain a {@code List<ListenableFuture<T>>} from this method is an unchecked (but safe)
* cast:
*
* <pre>
* {@code @SuppressWarnings("unchecked") // guaranteed by invokeAll contract}
* {@code List<ListenableFuture<T>> futures = (List) executor.invokeAll(tasks, timeout, unit);}
* </pre>
*
* @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
<T> List<Future<T>> invokeAll(
Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
throws InterruptedException;
}