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