com.puppycrawl.tools.checkstyle.api

Class CheckstyleException


public class CheckstyleException
extends Exception

Represents an error condition within Checkstyle.

Version:
1.0

Author:
Oliver Burn

Constructor Summary

CheckstyleException(String aMessage)
Creates a new CheckstyleException instance.
CheckstyleException(String aMessage, Throwable aCause)
Creates a new CheckstyleException instance that was caused by another exception.

Method Summary

Throwable
getCause()
Throwable
initCause(Throwable aCause)
Initializes the cause of this exception.

Constructor Details

CheckstyleException

public CheckstyleException(String aMessage)
Creates a new CheckstyleException instance.

Parameters:
aMessage - a String value


CheckstyleException

public CheckstyleException(String aMessage,
                           Throwable aCause)
Creates a new CheckstyleException instance that was caused by another exception.

Parameters:
aMessage - a message that explains this exception
aCause - the Exception that is wrapped by this exception

Method Details

getCause

public Throwable getCause()

Returns:
the cause of this exception, might be null.


initCause

public Throwable initCause(Throwable aCause)
Initializes the cause of this exception. In JDK 1.4 (and later) the cause is printed as part of the exception stacktrace.

Parameters:
aCause - the exception that caused this CheckstyleException to be thrown

Returns:
a reference to this CheckstyleException instance