View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.lang3.concurrent;
18  
19  import java.util.concurrent.ExecutionException;
20  
21  /**
22   * An exception class used for reporting error conditions related to accessing data of background tasks.
23   *
24   * <p>
25   * The purpose of this exception class is analogous to the default JDK exception class {@link ExecutionException}, i.e.
26   * it wraps an exception that occurred during the execution of a task. However, in contrast to
27   * {@link ExecutionException}, it wraps only checked exceptions. Runtime exceptions are thrown directly.
28   * </p>
29   *
30   * @since 3.0
31   */
32  public class ConcurrentException extends Exception {
33      /**
34       * The serial version UID.
35       */
36      private static final long serialVersionUID = 6622707671812226130L;
37  
38      /**
39       * Creates a new, uninitialized instance of {@link ConcurrentException}.
40       */
41      protected ConcurrentException() {
42      }
43  
44      /**
45       * Creates a new instance of {@link ConcurrentException} and initializes it
46       * with the given message and cause.
47       *
48       * @param msg the error message
49       * @param cause the cause of this exception
50       * @throws IllegalArgumentException if the cause is not a checked exception
51       */
52      public ConcurrentException(final String msg, final Throwable cause) {
53          super(msg, ConcurrentUtils.checkedException(cause));
54      }
55  
56      /**
57       * Creates a new instance of {@link ConcurrentException} and initializes it
58       * with the given cause.
59       *
60       * @param cause the cause of this exception
61       * @throws IllegalArgumentException if the cause is not a checked exception
62       */
63      public ConcurrentException(final Throwable cause) {
64          super(ConcurrentUtils.checkedException(cause));
65      }
66  }