org.checkerframework.javacutil.ErrorReporter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation
Show all versions of checker Show documentation
The Checker Framework enhances Java's type system to
make it more powerful and useful. This lets software developers
detect and prevent errors in their Java programs.
The Checker Framework includes compiler plug-ins ("checkers")
that find bugs or verify their absence. It also permits you to
write your own compiler plug-ins.
package org.checkerframework.javacutil;
/**
* Handle errors detected in utility classes. By default, the error reporter throws a
* RuntimeException, but clients of the utility library may register a handler to change the
* behavior. For example, type checkers can direct errors to the
* org.checkerframework.framework.source.SourceChecker class.
*/
public class ErrorReporter {
protected static ErrorHandler handler = null;
/** Register a handler to customize error reporting. */
public static void setHandler(ErrorHandler h) {
handler = h;
}
/**
* Log an error message and abort processing. Call this method instead of raising an exception.
*
* @param msg the error message to log
*/
public static void errorAbort(String msg) {
if (handler != null) {
handler.errorAbort(msg);
} else {
throw new RuntimeException(msg, new Throwable());
}
}
/**
* Log an error message use {@link String#format(String, Object...)}} and abort processing. Call
* this method instead of raising an exception.
*
* @param format a format string
* @param args arguments to the format string
*/
public static void errorAbort(String format, Object... args) {
String formattedMsg = String.format(format, args);
if (handler != null) {
handler.errorAbort(formattedMsg);
} else {
throw new RuntimeException(formattedMsg, new Throwable());
}
}
public static void errorAbort(String msg, Throwable cause) {
if (handler != null) {
handler.errorAbort(msg, cause);
} else {
throw new RuntimeException(msg, cause);
}
}
}