org.checkerframework.framework.test.diagnostics

Class JavaDiagnosticReader

java.lang.Object

org.checkerframework.framework.test.diagnostics.JavaDiagnosticReader

All Implemented Interfaces:

Iterator<TestDiagnosticLine>

public class JavaDiagnosticReader
extends Object
implements Iterator<TestDiagnosticLine>

Reads a file that has serialized javac diagnostics and returns either a list of TestDiagnosticLines or TestDiagnostics. This file might either:

• a Java file, which is read by creating a JavaDiagnosticReader with the JAVA_COMMENT_CODEC
• a "Diagnostic" file, which is read by creating a JavaDiagnosticReader with a DIAGNOSTIC_FILE_CODEC

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavaDiagnosticReader.DiagnosticCodec Instances of DiagnosticCodec represent the various formats diagnostic strings can take

Field Summary

Fields

Modifier and Type	Field and Description
JavaDiagnosticReader.DiagnosticCodec	codec
static JavaDiagnosticReader.DiagnosticCodec	DIAGNOSTIC_FILE_CODEC Interprets a string that was written as a line in a Diagnostic File
static JavaDiagnosticReader.DiagnosticCodec	JAVA_COMMENT_CODEC Interprets a string that was written as a comment in a Java file
String	nextLine
int	nextLineNumber
File	toRead
JavaFileObject	toReadFileObject

Constructor Summary

Constructors

Constructor and Description
JavaDiagnosticReader(File toRead, JavaDiagnosticReader.DiagnosticCodec codec)
JavaDiagnosticReader(JavaFileObject toRead, JavaDiagnosticReader.DiagnosticCodec codec)

Method Summary

Modifier and Type	Method and Description
protected void	advance()
void	close()
boolean	hasNext()
TestDiagnosticLine	next()
static List<TestDiagnosticLine>	readDiagnosticFile(File toRead, boolean omitEmptyDiagnostics) Reads diagnostic lines line-by-line from the input Diagnostic file.
static List<TestDiagnosticLine>	readDiagnosticFileLines(Iterable<? extends File> toRead, boolean omitEmptyDiagnostics) Reads diagnostic lines line-by-line from the input Diagnostic files.
static List<TestDiagnostic>	readDiagnosticFiles(Iterable<? extends File> toRead, boolean omitEmptyDiagnostics) Reads diagnostics line-by-line from the input Diagnostic files.
static List<TestDiagnosticLine>	readDiagnosticLines(Iterable<File> toRead, boolean omitEmptyDiagnostics) Reads diagnostic lines from the comments of a set of Java file.
static List<TestDiagnosticLine>	readDiagnostics(File toRead, boolean omitEmptyDiagnostics) Reads diagnostic lines from the comments of the input Java file.
static List<TestDiagnosticLine>	readDiagnostics(File toRead, JavaDiagnosticReader.DiagnosticCodec codec, boolean omitEmptyDiagnostics) Reads the entire input file using the given codec and returns the resulting line.
static List<TestDiagnostic>	readDiagnostics(Iterable<File> toRead, boolean omitEmptyDiagnostics) Reads diagnostics from the comments of a set of Java file.
static List<TestDiagnosticLine>	readDiagnosticsJfo(JavaFileObject toRead, boolean omitEmptyDiagnostics) Reads diagnostic lines from the comments of a set of Java file.
static List<TestDiagnosticLine>	readExpectedDiagnosticLinesJfo(Iterable<? extends JavaFileObject> toRead, boolean omitEmptyDiagnostics) Reads diagnostic lines from the comments of a set of Java file.
static List<TestDiagnostic>	readExpectedDiagnosticsJfo(Iterable<? extends JavaFileObject> toRead, boolean omitEmptyDiagnostics) Reads diagnostics from the comments of a set of Java file.
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

JAVA_COMMENT_CODEC

public static JavaDiagnosticReader.DiagnosticCodec JAVA_COMMENT_CODEC

Interprets a string that was written as a comment in a Java file

DIAGNOSTIC_FILE_CODEC

public static JavaDiagnosticReader.DiagnosticCodec DIAGNOSTIC_FILE_CODEC

Interprets a string that was written as a line in a Diagnostic File

toRead

public final File toRead

toReadFileObject

public final JavaFileObject toReadFileObject

codec

public final JavaDiagnosticReader.DiagnosticCodec codec

nextLine

public String nextLine

nextLineNumber

public int nextLineNumber

Constructor Detail

JavaDiagnosticReader

public JavaDiagnosticReader(File toRead,
                            JavaDiagnosticReader.DiagnosticCodec codec)

JavaDiagnosticReader

public JavaDiagnosticReader(JavaFileObject toRead,
                            JavaDiagnosticReader.DiagnosticCodec codec)

Method Detail

readDiagnostics

public static List<TestDiagnosticLine> readDiagnostics(File toRead,
                                                       JavaDiagnosticReader.DiagnosticCodec codec,
                                                       boolean omitEmptyDiagnostics)

Reads the entire input file using the given codec and returns the resulting line.

Parameters:

toRead - the file (Java or Diagnostics format) to read

codec - a codec corresponding to the file type being read

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input file

readDiagnostics

public static List<TestDiagnosticLine> readDiagnostics(File toRead,
                                                       boolean omitEmptyDiagnostics)

Reads diagnostic lines from the comments of the input Java file.

Parameters:

toRead - a Java File

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input file

readDiagnosticLines

public static List<TestDiagnosticLine> readDiagnosticLines(Iterable<File> toRead,
                                                           boolean omitEmptyDiagnostics)

Reads diagnostic lines from the comments of a set of Java file.

Parameters:

toRead - java files to read using the JAVA_COMMENT_CODEC

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input Jav afiles

readDiagnostics

public static List<TestDiagnostic> readDiagnostics(Iterable<File> toRead,
                                                   boolean omitEmptyDiagnostics)

Reads diagnostics from the comments of a set of Java file.

Parameters:

toRead - java files to read using the JAVA_COMMENT_CODEC

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnostics (not lines) from the files ToRead

readDiagnosticsJfo

public static List<TestDiagnosticLine> readDiagnosticsJfo(JavaFileObject toRead,
                                                          boolean omitEmptyDiagnostics)

Reads diagnostic lines from the comments of a set of Java file.

Parameters:

toRead - the Java files to read using the JAVA_COMMENT_CODEC

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnostics (not lines) from the files ToRead

readExpectedDiagnosticLinesJfo

public static List<TestDiagnosticLine> readExpectedDiagnosticLinesJfo(Iterable<? extends JavaFileObject> toRead,
                                                                      boolean omitEmptyDiagnostics)

Reads diagnostic lines from the comments of a set of Java file.

Parameters:

toRead - the Java files to read using the JAVA_COMMENT_CODEC

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input Jav afiles

readExpectedDiagnosticsJfo

public static List<TestDiagnostic> readExpectedDiagnosticsJfo(Iterable<? extends JavaFileObject> toRead,
                                                              boolean omitEmptyDiagnostics)

Reads diagnostics from the comments of a set of Java file.

Parameters:

toRead - the Java files to read using the JAVA_COMMENT_CODEC

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnostics (not lines)

readDiagnosticFile

public static List<TestDiagnosticLine> readDiagnosticFile(File toRead,
                                                          boolean omitEmptyDiagnostics)

Reads diagnostic lines line-by-line from the input Diagnostic file.

Parameters:

toRead - a Diagnostic File

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input file

readDiagnosticFileLines

public static List<TestDiagnosticLine> readDiagnosticFileLines(Iterable<? extends File> toRead,
                                                               boolean omitEmptyDiagnostics)

Reads diagnostic lines line-by-line from the input Diagnostic files.

Parameters:

toRead - a set of Diagnostic Files

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input files

readDiagnosticFiles

public static List<TestDiagnostic> readDiagnosticFiles(Iterable<? extends File> toRead,
                                                       boolean omitEmptyDiagnostics)

Reads diagnostics line-by-line from the input Diagnostic files.

Parameters:

toRead - a set of Diagnostic Files

omitEmptyDiagnostics - whether or not lines that do not contain any diagnostics should be reported as empty TestDiagnosticLines

Returns:

the List of TestDiagnosticLines from the input files

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<TestDiagnosticLine>

remove

public void remove()

Specified by:

remove in interface Iterator<TestDiagnosticLine>

next

public TestDiagnosticLine next()

Specified by:

next in interface Iterator<TestDiagnosticLine>

advance

protected void advance()
                throws IOException

Throws:

IOException

close

public void close()