Source code

001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2025 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.api;
021
022import java.io.Serial;
023
024/**
025 * Represents an error condition within Checkstyle.
026 *
027 * @noinspection CheckedExceptionClass
028 * @noinspectionreason CheckedExceptionClass - we require checked exception since we terminate
029 * execution if thrown
030 */
031public class CheckstyleException extends Exception {
032
033 /** For serialization that will never happen. */
034 @Serial
035 private static final long serialVersionUID = -3517342299748221108L;
036
037 /**
038 * Creates a new {@code CheckstyleException} instance.
039 *
040 * @param message a {@code String} value
041 */
042 public CheckstyleException(String message) {
043 super(message);
044 }
045
046 /**
047 * Creates a new {@code CheckstyleException} instance
048 * that was caused by another exception.
049 *
050 * @param message a message that explains this exception
051 * @param cause the Exception that is wrapped by this exception
052 */
053 public CheckstyleException(String message, Throwable cause) {
054 super(message, cause);
055 }
056
057}