Package org.checkerframework.javacutil

Class BugInCF

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.checkerframework.javacutil.BugInCF

All Implemented Interfaces:

Serializable

public class BugInCF
extends RuntimeException

Exception type indicating a bug in the framework.

To indicate a bug in a checker implementation, use TypeSystemError. To indicate that an end user made a mistake, use UserError.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BugInCF(@Nullable Tree location, String message, Throwable cause)	Constructs a new BugInCF with the specified detail message and cause.
BugInCF(@Nullable Tree location, Throwable cause)	Constructs a new BugInCF with the specified cause.
BugInCF(String message)	Constructs a new BugInCF with the specified detail message and no cause (use this at the root cause).
BugInCF(String fmt, @Nullable Object... args)	Constructs a new BugInCF with a detail message composed from the given arguments, and with no cause (use the current callstack as the root cause).
BugInCF(String message, Throwable cause)	Constructs a new BugInCF with the specified detail message and cause.
BugInCF(Throwable cause)	Constructs a new BugInCF with the specified cause.
BugInCF(Throwable cause, String fmt, @Nullable Object... args)	Constructs a new BugInCF with the specified cause and with a detail message composed from the given arguments.

Method Summary

Modifier and Type	Method	Description
static BugInCF	addLocation(Tree location, Throwable throwable)	Adds the location to throwable.
@Nullable Tree	getLocation()	Return the tree at which to report the exception.

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

BugInCF

public BugInCF(String message)

Constructs a new BugInCF with the specified detail message and no cause (use this at the root cause).

Parameters:

message - the detail message

BugInCF

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

Constructs a new BugInCF with a detail message composed from the given arguments, and with no cause (use the current callstack as the root cause).

Parameters:

fmt - the format string

args - the arguments for the format string

BugInCF

public BugInCF(Throwable cause)

Constructs a new BugInCF with the specified cause.

Parameters:

cause - the cause; its detail message will be used and must be non-null

BugInCF

public BugInCF(@Nullable Tree location,
 Throwable cause)

Constructs a new BugInCF with the specified cause.

Parameters:

location - where to report the bug

cause - the cause; its detail message will be used and must be non-null

BugInCF

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

Constructs a new BugInCF 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

BugInCF

public BugInCF(String message,
 Throwable cause)

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

Parameters:

message - the detail message

cause - the cause

BugInCF

public BugInCF(@Nullable Tree location,
 String message,
 Throwable cause)

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

Parameters:

location - where to report the bug

message - the detail message

cause - the cause

Method Details

getLocation

public @Nullable Tree getLocation()

Return the tree at which to report the exception.

Returns:

the tree at which to report the exception

addLocation

public static BugInCF addLocation(Tree location,
 Throwable throwable)

Adds the location to throwable. If throwable is a BugInCF that does not have a location, then its location is set to location.

If throwable is not aBugInCF, then a BugInCF is created with location and cause throwable.

Parameters:

location - the location at which to report this bug

throwable - a throwable whose location is set to location if it does not already have a location

Returns:

throwable if its a BugInCF otherwise a new BugInCF object