edu.umd.cs.findbugs

Class TextUIBugReporter

public abstract class TextUIBugReporter extends AbstractBugReporter

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.

Author: David Hovemeyer

Field Summary
protected PrintStream	outputStream

Constructor Summary
	TextUIBugReporter()

Method Summary
protected void	checkBugInstance(BugInstance bugInstance) For debugging: check a BugInstance to make sure it is valid.
protected void	emitLine(String line) Emit one line of the error message report.
BugReporter	getRealBugReporter()
boolean	getUseLongBugCodes()
protected void	printBug(BugInstance bugInstance) Print bug in one-line format.
void	setOutputStream(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	setUseLongBugCodes(boolean useLongBugCodes)

Field Detail

outputStream

protected PrintStream outputStream

Constructor Detail

TextUIBugReporter

public TextUIBugReporter()

Method Detail

checkBugInstance

protected void checkBugInstance(BugInstance bugInstance)

For debugging: check a BugInstance to make sure it is valid.

Parameters: bugInstance the BugInstance to check

emitLine

protected void emitLine(String line)

Emit one line of the error message report. By default, error messages are printed to System.err. Subclasses may override.

Parameters: line one line of the error report

getRealBugReporter

public BugReporter getRealBugReporter()

getUseLongBugCodes

public boolean getUseLongBugCodes()

printBug

protected void printBug(BugInstance bugInstance)

Print bug in one-line format.

Parameters: bugInstance the bug to print

setOutputStream

public void setOutputStream(PrintStream outputStream)

Set the PrintStream to write bug output to.

Parameters: outputStream the PrintStream to write bug output to

setReportHistory

public void setReportHistory(boolean reportHistory)

setReportStackTrace

public void setReportStackTrace(boolean reportStackTrace)

Set whether or not stack traces should be reported in error output.

Parameters: reportStackTrace true if stack traces should be reported, false if not

setReportUserDesignations

public void setReportUserDesignations(boolean reportUserDesignations)

setUseLongBugCodes

public void setUseLongBugCodes(boolean useLongBugCodes)

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.