org.checkerframework.framework.test.diagnostics

Class TestDiagnostic

java.lang.Object

org.checkerframework.framework.test.diagnostics.TestDiagnostic

public class TestDiagnostic
extends Object

Represents an expected error/warning message in a Java test file or an error/warning reported by the Javac compiler See JavaFileDiagnosticReader and TestDiagnosticLine

Constructor Summary

Constructors

Constructor and Description
TestDiagnostic(long lineNumber, DiagnosticKind kind, String message, boolean isFixable, boolean omitParentheses) Basic constructor that sets the immutable fields of this diagnostic.

Method Summary

Modifier and Type	Method and Description
String	asSourceString()
boolean	equals(Object otherObj) Equality is compared without isFixable/omitParentheses
DiagnosticKind	getKind()
long	getLineNumber()
String	getMessage()
int	hashCode()
boolean	isFixable()
boolean	shouldOmitParentheses()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TestDiagnostic

public TestDiagnostic(long lineNumber,
                      DiagnosticKind kind,
                      String message,
                      boolean isFixable,
                      boolean omitParentheses)

Basic constructor that sets the immutable fields of this diagnostic.

Method Detail

getLineNumber

public long getLineNumber()

getKind

public DiagnosticKind getKind()

isFixable

public boolean isFixable()

getMessage

public String getMessage()

shouldOmitParentheses

public boolean shouldOmitParentheses()

Returns:

whether or not String representation methods should omit the parentheses around the message

asSourceString

public String asSourceString()

Returns:

a String representing the format of this diagnostic as if it appeared in a source file

equals

public boolean equals(Object otherObj)

Equality is compared without isFixable/omitParentheses

Overrides:

equals in class Object

Returns:

true if this and otherObj are equal according to lineNumber, kind, and message

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

a representation of this diagnostic as if it appeared in a diagnostics file