001/*
002 * Copyright (C) 2015 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.GwtCompatible;
018import java.util.concurrent.Future;
019import org.checkerframework.checker.nullness.qual.Nullable;
020
021/**
022 * Computes a value, possibly asynchronously. For an example usage and more information, see {@link
023 * Futures.FutureCombiner#callAsync(AsyncCallable, java.util.concurrent.Executor)}.
024 *
025 * <p>Much like {@link java.util.concurrent.Callable}, but returning a {@link ListenableFuture}
026 * result.
027 *
028 * @since 20.0
029 */
030@GwtCompatible
031@ElementTypesAreNonnullByDefault
032public interface AsyncCallable<V extends @Nullable Object> {
033  /**
034   * Computes a result {@code Future}. The output {@code Future} need not be {@linkplain
035   * Future#isDone done}, making {@code AsyncCallable} suitable for asynchronous derivations.
036   *
037   * <p>Throwing an exception from this method is equivalent to returning a failing {@link
038   * ListenableFuture}.
039   */
040  ListenableFuture<V> call() throws Exception;
041}