dev.mccue.guava.concurrent.SettableFuture Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guava-concurrent Show documentation

com.google.common.util.concurrent repackaged and modularized

The newest version!

/*
 * Copyright (C) 2009 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 dev.mccue.guava.concurrent;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * A {@code ListenableFuture} whose result can be set by a {@code #set(Object)}, {@code
 * #setException(Throwable)} or {@code #setFuture(ListenableFuture)} call. It can also, like any
 * other {@code Future}, be {@code #cancel cancelled}.
 *
 * {@code SettableFuture} is the recommended {@code ListenableFuture} implementation when your
 * task cannot be implemented with {@code ListeningExecutorService}, the various {@code Futures}
 * utility methods, or {@code ListenableFutureTask}. Those APIs have less opportunity for developer
 * error. If your needs are more complex than {@code SettableFuture} supports, use {@code
 * AbstractFuture}, which offers an extensible version of the API.
 *
 * @author Sven Mawson
 * @since 9.0 (in 1.0 as {@code ValueFuture})
 */
@ElementTypesAreNonnullByDefault
public final class SettableFuture
    extends AbstractFuture.TrustedFuture {
  /**
   * Creates a new {@code SettableFuture} that can be completed or cancelled by a later method call.
   */
  public static  SettableFuture create() {
    return new SettableFuture<>();
  }

  @CanIgnoreReturnValue
  @Override
  public boolean set(@ParametricNullness V value) {
    return super.set(value);
  }

  @CanIgnoreReturnValue
  @Override
  public boolean setException(Throwable throwable) {
    return super.setException(throwable);
  }

  @CanIgnoreReturnValue
  @Override
  public boolean setFuture(ListenableFuture future) {
    return super.setFuture(future);
  }

  private SettableFuture() {}
}