|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.AbstractBugReporter
edu.umd.cs.findbugs.TextUIBugReporter
public abstract class TextUIBugReporter
Base class for BugReporters which provides convenient formatting and reporting of warnings and analysis errors.
"TextUIBugReporter" is a bit of a misnomer, since this class is useful in GUIs, too.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class edu.umd.cs.findbugs.AbstractBugReporter |
---|
AbstractBugReporter.Error |
Field Summary | |
---|---|
protected java.io.PrintStream |
outputStream
|
Fields inherited from interface edu.umd.cs.findbugs.BugReporter |
---|
NORMAL, SILENT |
Constructor Summary | |
---|---|
TextUIBugReporter()
|
Method Summary | |
---|---|
protected void |
checkBugInstance(BugInstance bugInstance)
For debugging: check a BugInstance to make sure it is valid. |
protected void |
emitLine(java.lang.String line)
Emit one line of the error message report. |
BugReporter |
getRealBugReporter()
Get the real bug reporter at the end of a chain of delegating bug reporters. |
boolean |
getUseLongBugCodes()
|
boolean |
isApplySuppressions()
|
protected void |
printBug(BugInstance bugInstance)
Print bug in one-line format. |
void |
reportAnalysisError(AnalysisError error)
Report a queued error. |
void |
reportMissingClass(java.lang.String message)
Report a missing class. |
void |
reportQueuedErrors()
Report any accumulated error messages. |
void |
setApplySuppressions(boolean applySuppressions)
|
void |
setOutputStream(java.io.PrintStream outputStream)
Set the PrintStream to write bug output to. |
void |
setReportHistory(boolean reportHistory)
|
void |
setReportStackTrace(boolean reportStackTrace)
Set whether or not stack traces should be reported in error output. |
void |
setReportUserDesignations(boolean reportUserDesignations)
|
void |
setShowRank(boolean showRank)
|
void |
setUseLongBugCodes(boolean useLongBugCodes)
|
Methods inherited from class edu.umd.cs.findbugs.AbstractBugReporter |
---|
addObserver, doReportBug, getMissingClasses, getMissingClassName, getProjectStats, getQueuedErrors, isValidMissingClassMessage, logError, logError, notifyObservers, reportBug, reportBugsFromXml, reportMissingClass, reportMissingClass, reportSkippedAnalysis, setErrorVerbosity, setPriorityThreshold, setRankThreshold |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface edu.umd.cs.findbugs.BugReporter |
---|
finish |
Methods inherited from interface edu.umd.cs.findbugs.classfile.IClassObserver |
---|
observeClass |
Field Detail |
---|
protected java.io.PrintStream outputStream
Constructor Detail |
---|
public TextUIBugReporter()
Method Detail |
---|
public void setOutputStream(@WillClose java.io.PrintStream outputStream)
outputStream
- the PrintStream to write bug output topublic void setReportStackTrace(boolean reportStackTrace)
reportStackTrace
- true if stack traces should be reported, false if notprotected void printBug(BugInstance bugInstance)
bugInstance
- the bug to printpublic void reportQueuedErrors()
BugReporter
reportQueuedErrors
in interface BugReporter
reportQueuedErrors
in class AbstractBugReporter
public void reportAnalysisError(AnalysisError error)
AbstractBugReporter
reportAnalysisError
in class AbstractBugReporter
error
- the queued errorpublic void reportMissingClass(java.lang.String message)
AbstractBugReporter
reportMissingClass
in class AbstractBugReporter
message
- the name of the classprotected void emitLine(java.lang.String line)
line
- one line of the error reportpublic boolean getUseLongBugCodes()
public void setReportHistory(boolean reportHistory)
public void setUseLongBugCodes(boolean useLongBugCodes)
public void setShowRank(boolean showRank)
public void setApplySuppressions(boolean applySuppressions)
public void setReportUserDesignations(boolean reportUserDesignations)
public BugReporter getRealBugReporter()
BugReporter
protected void checkBugInstance(BugInstance bugInstance)
bugInstance
- the BugInstance to checkpublic boolean isApplySuppressions()
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |