|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.incava.analysis.Report
org.incava.analysis.ContextReport
public class ContextReport
Reports errors in multiple lines, displaying the contextual code, and denoting the code to which a violation applies.
Field Summary | |
---|---|
static int |
tabWidth
The number of spaces a tab is equivalent to. |
Fields inherited from class org.incava.analysis.Report |
---|
fileName |
Constructor Summary | |
---|---|
ContextReport(java.io.OutputStream os)
Creates a context report for the given output stream. |
|
ContextReport(java.io.OutputStream os,
java.io.File file)
Creates a context report for the given output stream, and file. |
|
ContextReport(java.io.OutputStream os,
java.lang.String source)
Creates a context report for the given output stream, and string source. |
|
ContextReport(java.io.Writer writer)
Creates a context report for the given writer. |
|
ContextReport(java.io.Writer writer,
java.io.File file)
Creates a context report for the given writer, and a file source. |
|
ContextReport(java.io.Writer writer,
java.lang.String source)
Creates a context report for the given writer, and a string source. |
Method Summary | |
---|---|
protected void |
indent(java.lang.StringBuffer buf,
int line,
int column,
char ch)
Adds indentation to the buffer, replacing spacing and tabs. |
protected void |
markToEndOfLine(java.lang.StringBuffer buf,
int line,
int column)
Marks the given line with leading spaces to the column position (inclusive), and from there marking to the end of the line with "<---...". |
protected void |
markToStartPosition(java.lang.StringBuffer buf,
int line,
int column)
Marks the given line with "...--->" leading to the column position (inclusive). |
void |
reset(java.io.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(java.lang.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 java.lang.String |
toString(Violation violation)
Returns a string representing the given violation, consistent with the format of the Report subclass. |
protected void |
underline(java.lang.StringBuffer buf,
int line,
int beginColumn,
int endColumn)
Underlines ("<--...-->") from beginColumn to
endColumn in the given line. |
protected void |
writeLine(java.lang.StringBuffer buf,
int line)
Writes the given line, adding the line number, right-aligned. |
Methods inherited from class org.incava.analysis.Report |
---|
addViolation, flush, getViolations, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static int tabWidth
Constructor Detail |
---|
public ContextReport(java.io.Writer writer)
writer
- The writer associated with this report.public ContextReport(java.io.OutputStream os)
os
- The output stream associated with this report.public ContextReport(java.io.Writer writer, java.lang.String source)
writer
- The writer associated with this report.source
- The source code to which this report applies.public ContextReport(java.io.Writer writer, java.io.File file)
writer
- The writer associated with this report.file
- The file, containing source code, to which this report applies.public ContextReport(java.io.OutputStream os, java.lang.String source)
os
- The output stream associated with this report.source
- The source code to which this report applies.public ContextReport(java.io.OutputStream os, java.io.File file)
os
- The output stream associated with this report.file
- The file, containing source code, to which this report applies.Method Detail |
---|
public void reset(java.io.File file)
flush
.
reset
in class Report
file
- The file associated with the set of violations.public void reset(java.lang.String source)
flush
.
reset
in class Report
source
- The source code associated with the set of violations.protected java.lang.String toString(Violation violation)
toString
in class Report
violation
- The violation to represent as a string.protected void indent(java.lang.StringBuffer buf, int line, int column, char ch)
tabWidth
occurrences of ch
.
buf
- The buffer to be written to.line
- The current line number.column
- The column to indent to.ch
- The character with which to replace spaces and tabs.protected void markToEndOfLine(java.lang.StringBuffer buf, int line, int column)
buf
- The buffer to be written to.line
- The current line number.column
- The column to mark to/from.protected void markToStartPosition(java.lang.StringBuffer buf, int line, int column)
buf
- The buffer to be written to.line
- The current line number.column
- The column to mark to.protected void underline(java.lang.StringBuffer buf, int line, int beginColumn, int endColumn)
beginColumn
to
endColumn
in the given line. If the columns are equal, a
single caret is shown.
buf
- The buffer to be written to.line
- The current line number.beginColumn
- The column to mark from.endColumn
- The column to mark to.protected void writeLine(java.lang.StringBuffer buf, int line)
buf
- The buffer to be written to.line
- The current line number.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |