1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.api;
21
22 /**
23 * Represents an error condition within Checkstyle.
24 *
25 * @noinspection CheckedExceptionClass
26 * @noinspectionreason CheckedExceptionClass - we require checked exception since we terminate
27 * execution if thrown
28 */
29 public class CheckstyleException extends Exception {
30
31 /** For serialization that will never happen. */
32 private static final long serialVersionUID = -3517342299748221108L;
33
34 /**
35 * Creates a new {@code CheckstyleException} instance.
36 *
37 * @param message a {@code String} value
38 */
39 public CheckstyleException(String message) {
40 super(message);
41 }
42
43 /**
44 * Creates a new {@code CheckstyleException} instance
45 * that was caused by another exception.
46 *
47 * @param message a message that explains this exception
48 * @param cause the Exception that is wrapped by this exception
49 */
50 public CheckstyleException(String message, Throwable cause) {
51 super(message, cause);
52 }
53
54 }