org.incava.analysis
Class Report
java.lang.Object
org.incava.analysis.Report
public abstract class Report
extends java.lang.Object
Reports errors (violations), in a format that is determined by the subclass.
protected String | fileName - The file to which this report currently applies.
|
Report(OutputStream os) - Creates a report for the given output stream.
|
Report(OutputStream os, File file) - Creates a report for the given output stream, and file.
|
Report(OutputStream os, String source) - Creates a report for the given output stream, and string source.
|
Report(Writer writer) - Creates a report for the given writer.
|
Report(Writer writer, File file) - Creates a report for the given writer, and a file source.
|
Report(Writer writer, String source) - Creates a report for the given writer, and a string source.
|
void | addViolation(Violation v) - Adds the given violation.
|
void | flush() - Writes all violations, and clears the list.
|
Set | getViolations() - Exists only for testing.
|
void | reset(File file) - Associates the given file with the list of violations, including that are
adding to this report later, i.e., prior to
flush .
|
void | reset(String source) - Associates the given string source with the list of violations, including
that are adding to this report later, i.e., prior to
flush .
|
protected abstract String | toString(Violation violation) - Returns a string representing the given violation, consistent with the
format of the Report subclass.
|
protected void | write(String str) - Sends the given string to the writer associated with this Report.
|
fileName
protected String fileName
The file to which this report currently applies. By default, this is '-',
denoting standard output.
Report
public Report(OutputStream os)
Creates a report for the given output stream.
os
- The output stream associated with this report.
Report
public Report(OutputStream os,
File file)
Creates a report for the given output stream, and file.
os
- The output stream associated with this report.file
- The file, containing source code, to which this report applies.
Report
public Report(OutputStream os,
String source)
Creates a report for the given output stream, and string source.
os
- The output stream associated with this report.source
- The source code to which this report applies.
Report
public Report(Writer writer)
Creates a report for the given writer.
writer
- The writer associated with this report.
Report
public Report(Writer writer,
File file)
Creates a report for the given writer, and a file source.
writer
- The writer associated with this report.file
- The file, containing source code, to which this report applies.
Report
public Report(Writer writer,
String source)
Creates a report for the given writer, and a string source.
writer
- The writer associated with this report.source
- The source code to which this report applies.
addViolation
public void addViolation(Violation v)
Adds the given violation.
v
- The violation being added.
flush
public void flush()
Writes all violations, and clears the list.
getViolations
public Set getViolations()
Exists only for testing.
reset
public void reset(File file)
Associates the given file with the list of violations, including that are
adding to this report later, i.e., prior to flush
.
file
- The file associated with the set of violations.
reset
public void reset(String source)
Associates the given string source with the list of violations, including
that are adding to this report later, i.e., prior to flush
.
source
- The source code associated with the set of violations.
toString
protected abstract String toString(Violation violation)
Returns a string representing the given violation, consistent with the
format of the Report subclass.
violation
- The violation to represent as a string.
write
protected void write(String str)
Sends the given string to the writer associated with this Report.
str
- The string to be written.