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 * An exception class used for reporting runtime error conditions related to
21 * accessing data of background tasks.
22 *
23 * <p>
24 * This class is an analogue of the {@link ConcurrentException} exception class.
25 * However, it is a runtime exception and thus does not need explicit catch
26 * clauses. Some methods of {@link ConcurrentUtils} throw {@code
27 * ConcurrentRuntimeException} exceptions rather than
28 * {@link ConcurrentException} exceptions. They can be used by client code that
29 * does not want to be bothered with checked exceptions.
30 * </p>
31 *
32 * @since 3.0
33 */
34 public class ConcurrentRuntimeException extends RuntimeException {
35 /**
36 * The serial version UID.
37 */
38 private static final long serialVersionUID = -6582182735562919670L;
39
40 /**
41 * Creates a new, uninitialized instance of {@code
42 * ConcurrentRuntimeException}.
43 */
44 protected ConcurrentRuntimeException() {
45 }
46
47 /**
48 * Creates a new instance of {@link ConcurrentRuntimeException} and
49 * initializes it with the given message and cause.
50 *
51 * @param msg the error message
52 * @param cause the cause of this exception
53 * @throws IllegalArgumentException if the cause is not a checked exception
54 */
55 public ConcurrentRuntimeException(final String msg, final Throwable cause) {
56 super(msg, ConcurrentUtils.checkedException(cause));
57 }
58
59 /**
60 * Creates a new instance of {@link ConcurrentRuntimeException} and
61 * initializes it with the given cause.
62 *
63 * @param cause the cause of this exception
64 * @throws IllegalArgumentException if the cause is not a checked exception
65 */
66 public ConcurrentRuntimeException(final Throwable cause) {
67 super(ConcurrentUtils.checkedException(cause));
68 }
69 }