org.incava.analysis

Class Report

Known Direct Subclasses:
ContextReport, TerseReport

public abstract class Report
extends java.lang.Object

Reports errors (violations), in a format that is determined by the subclass.

Field Summary

protected String
fileName
The file to which this report currently applies.

Constructor Summary

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.

Method Summary

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.

Field Details

fileName

protected String fileName
The file to which this report currently applies. By default, this is '-', denoting standard output.

Constructor Details

Report

public Report(OutputStream os)
Creates a report for the given output stream.
Parameters:
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.
Parameters:
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.
Parameters:
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.
Parameters:
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.
Parameters:
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.
Parameters:
writer - The writer associated with this report.
source - The source code to which this report applies.

Method Details

addViolation

public void addViolation(Violation v)
Adds the given violation.
Parameters:
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.
Parameters:
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.
Parameters:
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.
Parameters:
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.
Parameters:
str - The string to be written.