Package org.checkerframework.javacutil

Class UserError

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.checkerframework.javacutil.UserError

All Implemented Interfaces:

Serializable

public class UserError
extends RuntimeException

Exception type indicating a mistake by an end user in using the Checker Framework, such as incorrect command-line arguments.

To indicate a bug in the framework, use BugInCF. To indicate a bug in a checker implementation, use TypeSystemError.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserError(String message)	Constructs a new CheckerError with the specified detail message.
UserError(String fmt, @Nullable Object... args)	Constructs a new CheckerError with a detail message composed from the given arguments.
UserError(String message, Throwable cause)	Constructs a new CheckerError with the specified detail message and cause.
UserError(Throwable cause, String fmt, @Nullable Object... args)	Constructs a new CheckerError with the specified cause and with a detail message composed from the given arguments.

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UserError

public UserError(String message)

Constructs a new CheckerError with the specified detail message.

Parameters:

message - the detail message

UserError

@FormatMethod
public UserError(String fmt,
 @Nullable Object... args)

Constructs a new CheckerError with a detail message composed from the given arguments.

Beware: if the only argument is a Throwable, then Java instead selects UserError(String, Throwable), which uses fmt literally rather than as a format string, and uses the throwable as the cause. To format a throwable into the detail message, pass it as an explicit cause too, as in new UserError(t, "Cannot read %s", t), or pass t.getMessage() as the format argument.

Parameters:

fmt - the format string

args - the arguments for the format string

UserError

public UserError(String message,
 Throwable cause)

Constructs a new CheckerError with the specified detail message and cause.

Parameters:

message - the detail message

cause - the cause

UserError

@FormatMethod
public UserError(Throwable cause,
 String fmt,
 @Nullable Object... args)

Constructs a new CheckerError with the specified cause and with a detail message composed from the given arguments.

Parameters:

cause - the cause

fmt - the format string

args - the arguments for the format string