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.GwtCompatible;
018import org.checkerframework.checker.nullness.qual.Nullable;
019
020/**
021 * Unchecked variant of {@link java.util.concurrent.ExecutionException}. As with {@code
022 * ExecutionException}, the exception's {@linkplain #getCause() cause} comes from a failed task,
023 * possibly run in another thread.
024 *
025 * <p>{@code UncheckedExecutionException} is intended as an alternative to {@code
026 * ExecutionException} when the exception thrown by a task is an unchecked exception. However, it
027 * may also wrap a checked exception in some cases.
028 *
029 * <p>When wrapping an {@code Error} from another thread, prefer {@link ExecutionError}. When
030 * wrapping a checked exception, prefer {@code ExecutionException}.
031 *
032 * @author Charles Fry
033 * @since 10.0
034 */
035@GwtCompatible
036public class UncheckedExecutionException extends RuntimeException {
037  /*
038   * Ideally, this class would have exposed only constructors that require a non-null cause. See
039   * https://github.com/jspecify/jspecify-reference-checker/blob/61aafa4ae52594830cfc2d61c8b113009dbdb045/src/main/java/com/google/jspecify/nullness/NullSpecTransfer.java#L789
040   * and https://github.com/jspecify/jspecify/issues/490.
041   *
042   * (Perhaps it should also have required that its cause was a RuntimeException. However, that
043   * would have required that we throw a different kind of exception for wrapping *checked*
044   * exceptions in methods like Futures.getUnchecked and LoadingCache.get.)
045   */
046
047  /**
048   * Creates a new instance with {@code null} as its detail message and no cause.
049   *
050   * @deprecated Prefer {@linkplain UncheckedExecutionException(Throwable)} a constructor that
051   *     accepts a cause: Users of this class typically expect for instances to have a non-null
052   *     cause. At the moment, you can <i>usually</i> still preserve behavior by passing an explicit
053   *     {@code null} cause. Note, however, that passing an explicit {@code null} cause prevents
054   *     anyone from calling {@link #initCause} later, so it is not quite equivalent to using a
055   *     constructor that omits the cause.
056   */
057  @Deprecated
058  protected UncheckedExecutionException() {}
059
060  /**
061   * Creates a new instance with the given detail message and no cause.
062   *
063   * @deprecated Prefer {@linkplain UncheckedExecutionException(String, Throwable)} a constructor
064   *     that accepts a cause: Users of this class typically expect for instances to have a non-null
065   *     cause. At the moment, you can <i>usually</i> still preserve behavior by passing an explicit
066   *     {@code null} cause. Note, however, that passing an explicit {@code null} cause prevents
067   *     anyone from calling {@link #initCause} later, so it is not quite equivalent to using a
068   *     constructor that omits the cause.
069   */
070  @Deprecated
071  protected UncheckedExecutionException(@Nullable String message) {
072    super(message);
073  }
074
075  /**
076   * Creates a new instance with the given detail message and cause. Prefer to provide a
077   * non-nullable {@code cause}, as many users expect to find one.
078   */
079  public UncheckedExecutionException(@Nullable String message, @Nullable Throwable cause) {
080    super(message, cause);
081  }
082
083  /**
084   * Creates a new instance with {@code null} as its detail message and the given cause. Prefer to
085   * provide a non-nullable {@code cause}, as many users expect to find one.
086   */
087  public UncheckedExecutionException(@Nullable Throwable cause) {
088    super(cause);
089  }
090
091  private static final long serialVersionUID = 0;
092}