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 * https://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
18 package org.apache.commons.configuration2.ex;
19
20 /**
21 * A configuration related runtime exception.
22 *
23 * @since 1.0
24 */
25 public class ConfigurationRuntimeException extends RuntimeException {
26
27 /**
28 * The serial version ID.
29 */
30 private static final long serialVersionUID = -7838702245512140996L;
31
32 /**
33 * Constructs a new {@code ConfigurationRuntimeException} without specified detail message.
34 */
35 public ConfigurationRuntimeException() {
36 }
37
38 /**
39 * Constructs a new {@code ConfigurationRuntimeException} with specified detail message.
40 *
41 * @param message the error message
42 */
43 public ConfigurationRuntimeException(final String message) {
44 super(message);
45 }
46
47 /**
48 * Constructs a new {@code ConfigurationRuntimeException} with specified detail message using {@link String#format(String,Object...)}.
49 *
50 * @param message the error message
51 * @param args arguments to the error message
52 * @see String#format(String,Object...)
53 */
54 public ConfigurationRuntimeException(final String message, final Object... args) {
55 super(String.format(message, args));
56 }
57
58 /**
59 * Constructs a new {@code ConfigurationRuntimeException} with specified detail message and nested {@code Throwable}.
60 *
61 * @param message the error message
62 * @param cause the exception or error that caused this exception to be thrown
63 */
64 public ConfigurationRuntimeException(final String message, final Throwable cause) {
65 super(message, cause);
66 }
67
68 /**
69 * Constructs a new {@code ConfigurationRuntimeException} with specified nested {@code Throwable}.
70 *
71 * @param cause the exception or error that caused this exception to be thrown
72 */
73 public ConfigurationRuntimeException(final Throwable cause) {
74 super(cause);
75 }
76
77 /**
78 * Constructs a new {@code ConfigurationRuntimeException} with specified detail message.
79 *
80 * @param format the error message for for {@link String#format(String, Object...)}.
81 * @param params the error parameters for for {@link String#format(String, Object...)}.
82 * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value is permitted, and indicates that
83 * the cause is nonexistent or unknown.)
84 * @since 2.14.0
85 */
86 public ConfigurationRuntimeException(final Throwable cause, final String format, final Object... params) {
87 super(String.format(format, params), cause);
88 }
89 }