org.checkerframework.framework.test.diagnostics

Class TestDiagnosticUtils

java.lang.Object

org.checkerframework.framework.test.diagnostics.TestDiagnosticUtils

public class TestDiagnosticUtils
extends Object

A set of utilities and factory methods useful for working with TestDiagnostics

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	DIAGNOSTIC_FILE_PATTERN
static String	DIAGNOSTIC_FILE_REGEX
static Pattern	DIAGNOSTIC_FILE_WARNING_PATTERN
static String	DIAGNOSTIC_FILE_WARNING_REGEX
static Pattern	DIAGNOSTIC_IN_JAVA_PATTERN
static String	DIAGNOSTIC_IN_JAVA_REGEX
static Pattern	DIAGNOSTIC_PATTERN
static String	DIAGNOSTIC_REGEX
static Pattern	DIAGNOSTIC_WARNING_IN_JAVA_PATTERN
static String	DIAGNOSTIC_WARNING_IN_JAVA_REGEX
static Pattern	DIAGNOSTIC_WARNING_PATTERN
static String	DIAGNOSTIC_WARNING_REGEX

Constructor Summary

Constructors

Constructor and Description
TestDiagnosticUtils()

Method Summary

Modifier and Type	Method and Description
static List<String>	diagnosticsToString(List<TestDiagnostic> diagnostics) Converts the given diagnostics to strings (as they would appear in a source file individually)
static Pair<String,String>	formatJavaxToolString(String original, boolean noMsgText)
static TestDiagnosticLine	fromDiagnosticFileLine(String diagnosticLine) Convert a line in a DiagnosticFile to a TestDiagnosticLine
static TestDiagnostic	fromDiagnosticFileString(String stringFromDiagnosticFile) Instantiate the diagnostic based on a string that would appear in diagnostic files (i.e.
static TestDiagnostic	fromJavaFileComment(String filename, long lineNumber, String stringFromjavaFile) Instantiate the diagnostic from a string that would appear in a Java file, e.g.: "error: (message)"
static TestDiagnosticLine	fromJavaSourceLine(String filename, String originalLine, long lineNumber) Convert a line in a JavaSource file to a (possibly empty) TestDiagnosticLine
static Set<TestDiagnostic>	fromJavaxDiagnosticList(List<Diagnostic<? extends JavaFileObject>> javaxDiagnostics, boolean noMsgText)
static TestDiagnostic	fromJavaxToolsDiagnostic(String diagnosticString, boolean noMsgText) Instantiate a diagnostic using a diagnostic from the Java Compiler.
protected static TestDiagnostic	fromPatternMatching(Pattern diagnosticPattern, Pattern warningPattern, String filename, Long lineNumber, String diagnosticString)
static void	removeDiagnosticsOfKind(DiagnosticKind kind, List<TestDiagnostic> expectedDiagnostics)

Methods inherited from class java.lang.Object

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

Field Detail

DIAGNOSTIC_IN_JAVA_REGEX

public static final String DIAGNOSTIC_IN_JAVA_REGEX

See Also:

Constant Field Values

DIAGNOSTIC_IN_JAVA_PATTERN

public static final Pattern DIAGNOSTIC_IN_JAVA_PATTERN

DIAGNOSTIC_WARNING_IN_JAVA_REGEX

public static final String DIAGNOSTIC_WARNING_IN_JAVA_REGEX

See Also:

Constant Field Values

DIAGNOSTIC_WARNING_IN_JAVA_PATTERN

public static final Pattern DIAGNOSTIC_WARNING_IN_JAVA_PATTERN

DIAGNOSTIC_REGEX

public static final String DIAGNOSTIC_REGEX

See Also:

Constant Field Values

DIAGNOSTIC_PATTERN

public static final Pattern DIAGNOSTIC_PATTERN

DIAGNOSTIC_WARNING_REGEX

public static final String DIAGNOSTIC_WARNING_REGEX

See Also:

Constant Field Values

DIAGNOSTIC_WARNING_PATTERN

public static final Pattern DIAGNOSTIC_WARNING_PATTERN

DIAGNOSTIC_FILE_REGEX

public static final String DIAGNOSTIC_FILE_REGEX

See Also:

Constant Field Values

DIAGNOSTIC_FILE_PATTERN

public static final Pattern DIAGNOSTIC_FILE_PATTERN

DIAGNOSTIC_FILE_WARNING_REGEX

public static final String DIAGNOSTIC_FILE_WARNING_REGEX

See Also:

Constant Field Values

DIAGNOSTIC_FILE_WARNING_PATTERN

public static final Pattern DIAGNOSTIC_FILE_WARNING_PATTERN

Constructor Detail

TestDiagnosticUtils

public TestDiagnosticUtils()

Method Detail

fromDiagnosticFileString

public static TestDiagnostic fromDiagnosticFileString(String stringFromDiagnosticFile)

Instantiate the diagnostic based on a string that would appear in diagnostic files (i.e. files that only contain line after line of expected diagnostics)

Parameters:

stringFromDiagnosticFile - a single diagnostic string to parse

fromJavaFileComment

public static TestDiagnostic fromJavaFileComment(String filename,
                                                 long lineNumber,
                                                 String stringFromjavaFile)

Instantiate the diagnostic from a string that would appear in a Java file, e.g.: "error: (message)"

Parameters:

lineNumber - the lineNumber of the line immediately below the diagnostic comment in the Java file

stringFromjavaFile - the string containing the diagnostic

fromJavaxToolsDiagnostic

public static TestDiagnostic fromJavaxToolsDiagnostic(String diagnosticString,
                                                      boolean noMsgText)

Instantiate a diagnostic using a diagnostic from the Java Compiler. The resulting diagnostic is never fixable and always has parentheses

fromPatternMatching

protected static TestDiagnostic fromPatternMatching(Pattern diagnosticPattern,
                                                    Pattern warningPattern,
                                                    String filename,
                                                    Long lineNumber,
                                                    String diagnosticString)

formatJavaxToolString

public static Pair<String,String> formatJavaxToolString(String original,
                                                        boolean noMsgText)

fromJavaSourceLine

public static TestDiagnosticLine fromJavaSourceLine(String filename,
                                                    String originalLine,
                                                    long lineNumber)

Convert a line in a JavaSource file to a (possibly empty) TestDiagnosticLine

fromDiagnosticFileLine

public static TestDiagnosticLine fromDiagnosticFileLine(String diagnosticLine)

Convert a line in a DiagnosticFile to a TestDiagnosticLine

fromJavaxDiagnosticList

public static Set<TestDiagnostic> fromJavaxDiagnosticList(List<Diagnostic<? extends JavaFileObject>> javaxDiagnostics,
                                                          boolean noMsgText)

diagnosticsToString

public static List<String> diagnosticsToString(List<TestDiagnostic> diagnostics)

Converts the given diagnostics to strings (as they would appear in a source file individually)

removeDiagnosticsOfKind

public static void removeDiagnosticsOfKind(DiagnosticKind kind,
                                           List<TestDiagnostic> expectedDiagnostics)