org.checkerframework.framework.util.dependenttypes

Class DependentTypesError

java.lang.Object

org.checkerframework.framework.util.dependenttypes.DependentTypesError

public class DependentTypesError
extends Object

Helper class for creating dependent type annotation error strings.

IMPORTANT: This is not an Exception. It is a regular class that is returned, not thrown. The errors are not thrown so that they are only reported once rather than every time the annotation is parsed. See DependentTypesHelper for more details.

Field Summary

Fields

Modifier and Type	Field and Description
String	error An error message about that expression.
String	expression The expression that is unparseable or otherwise problematic.
static String	FORMAL_PARAM_NAME_STRING How to format warnings about use of formal parameter name.

Constructor Summary

Constructors

Constructor and Description
DependentTypesError(String expression, FlowExpressionParseUtil.FlowExpressionParseException e) Create a DependentTypesError for the given expression and exception.
DependentTypesError(String expression, String error) Create a DependentTypesError for the given expression and error message.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object o)
String	format() Like toString, but uses better formatting sometimes.
int	hashCode()
static boolean	isExpressionError(String expression) Returns whether or not the given expression string is an error.
String	toString()
static DependentTypesError	unparse(String formattedError) Create a DependentTypesError by parsing a printed one.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FORMAL_PARAM_NAME_STRING

public static final String FORMAL_PARAM_NAME_STRING

How to format warnings about use of formal parameter name.

See Also:

Constant Field Values

expression

public final String expression

The expression that is unparseable or otherwise problematic.

error

public final String error

An error message about that expression.

Constructor Detail

DependentTypesError

public DependentTypesError(String expression,
                           String error)

Create a DependentTypesError for the given expression and error message.

Parameters:

expression - the incorrect Java expression

error - an error message about the expression

DependentTypesError

public DependentTypesError(String expression,
                           FlowExpressionParseUtil.FlowExpressionParseException e)

Create a DependentTypesError for the given expression and exception.

Parameters:

expression - the incorrect Java expression

e - wraps an error message about the expression

Method Detail

isExpressionError

public static boolean isExpressionError(String expression)

Returns whether or not the given expression string is an error. That is, whether it is a string that was generated by this class.

Parameters:

expression - expression string to test

Returns:

whether or not the given expressions string is an error

unparse

public static DependentTypesError unparse(String formattedError)

Create a DependentTypesError by parsing a printed one.

Parameters:

formattedError - the toString() representation of a DependentTypesError

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

format

public String format()

Like toString, but uses better formatting sometimes. Use this only for the final output, because of the design that hides error messages in toString().