001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 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
022/**
023 * Represents an error condition within Checkstyle.
024 *
025 * @noinspection CheckedExceptionClass
026 * @noinspectionreason CheckedExceptionClass - we require checked exception since we terminate
027 *      execution if thrown
028 */
029public class CheckstyleException extends Exception {
030
031    /** For serialization that will never happen. */
032    private static final long serialVersionUID = -3517342299748221108L;
033
034    /**
035     * Creates a new {@code CheckstyleException} instance.
036     *
037     * @param message a {@code String} value
038     */
039    public CheckstyleException(String message) {
040        super(message);
041    }
042
043    /**
044     * Creates a new {@code CheckstyleException} instance
045     * that was caused by another exception.
046     *
047     * @param message a message that explains this exception
048     * @param cause the Exception that is wrapped by this exception
049     */
050    public CheckstyleException(String message, Throwable cause) {
051        super(message, cause);
052    }
053
054}