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 /**
20 * <p>
21 * An exception class used for reporting error conditions related to accessing
22 * data of background tasks.
23 * </p>
24 * <p>
25 * The purpose of this exception class is analogous to the default JDK exception
26 * class {@link java.util.concurrent.ExecutionException}, i.e. it wraps an
27 * exception that occurred during the execution of a task. However, in contrast
28 * to {@code ExecutionException}, it wraps only checked exceptions. Runtime
29 * exceptions are thrown directly.
30 * </p>
31 *
32 * @since 3.0
33 * @version $Id: ConcurrentException.java 1436768 2013-01-22 07:07:42Z ggregory $
34 */
35 public class ConcurrentException extends Exception {
36 /**
37 * The serial version UID.
38 */
39 private static final long serialVersionUID = 6622707671812226130L;
40
41 /**
42 * Creates a new, uninitialized instance of {@code ConcurrentException}.
43 */
44 protected ConcurrentException() {
45 super();
46 }
47
48 /**
49 * Creates a new instance of {@code ConcurrentException} and initializes it
50 * with the given cause.
51 *
52 * @param cause the cause of this exception
53 * @throws IllegalArgumentException if the cause is not a checked exception
54 */
55 public ConcurrentException(final Throwable cause) {
56 super(ConcurrentUtils.checkedException(cause));
57 }
58
59 /**
60 * Creates a new instance of {@code ConcurrentException} and initializes it
61 * with the given message and cause.
62 *
63 * @param msg the error message
64 * @param cause the cause of this exception
65 * @throws IllegalArgumentException if the cause is not a checked exception
66 */
67 public ConcurrentException(final String msg, final Throwable cause) {
68 super(msg, ConcurrentUtils.checkedException(cause));
69 }
70 }