Package edu.umd.cs.findbugs

Class BugCollectionBugReporter

java.lang.Object

edu.umd.cs.findbugs.AbstractBugReporter

edu.umd.cs.findbugs.TextUIBugReporter

edu.umd.cs.findbugs.BugCollectionBugReporter

All Implemented Interfaces:

Debug, RepositoryLookupFailureCallback, BugReporter, IClassObserver, IErrorLogger

Direct Known Subclasses:

HTMLBugReporter, XMLBugReporter

public class BugCollectionBugReporter
extends TextUIBugReporter
implements Debug

Nested Class Summary

Nested classes/interfaces inherited from class edu.umd.cs.findbugs.AbstractBugReporter

AbstractBugReporter.Error

Field Summary

Fields inherited from interface edu.umd.cs.findbugs.BugReporter

NORMAL, SILENT

Fields inherited from interface edu.umd.cs.findbugs.ba.Debug

VERIFY_INTEGRITY

Fields inherited from class edu.umd.cs.findbugs.TextUIBugReporter

outputStream

Constructor Summary

Constructors

Constructor	Description
BugCollectionBugReporter(Project project)

Method Summary

Modifier and Type	Method	Description
void	doReportBug(BugInstance bugInstance)	Subclasses must override this.
void	finish()	Finish reporting bugs.
BugCollection	getBugCollection()
Project	getProject()
BugReporter	getRealBugReporter()	Get the real bug reporter at the end of a chain of delegating bug reporters.
void	logError(java.lang.String message)	Log an error that occurs while performing analysis.
void	logError(java.lang.String message, java.lang.Throwable e)	Log an error that occurs while performing analysis.
void	observeClass(ClassDescriptor classDescriptor)	Observe a class being visited.
void	reportMissingClass(java.lang.ClassNotFoundException ex)	Called to report a class lookup failure.

Methods inherited from class edu.umd.cs.findbugs.AbstractBugReporter

addObserver, getMissingClasses, getMissingClassName, getProjectStats, getQueuedErrors, isValidMissingClassMessage, notifyObservers, reportBug, reportBugsFromXml, 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 class edu.umd.cs.findbugs.TextUIBugReporter

checkBugInstance, emitLine, getUseLongBugCodes, isApplySuppressions, printBug, reportAnalysisError, reportMissingClass, reportQueuedErrors, setApplySuppressions, setOutputStream, setReportHistory, setReportStackTrace, setReportUserDesignations, setShowRank, setUseLongBugCodes

Constructor Detail

BugCollectionBugReporter

public BugCollectionBugReporter(Project project)

Method Detail

getProject

public Project getProject()

getBugCollection

public BugCollection getBugCollection()

observeClass

public void observeClass(ClassDescriptor classDescriptor)

Description copied from interface: IClassObserver

Observe a class being visited.

Specified by:

observeClass in interface IClassObserver

Parameters:

classDescriptor - class being visited

logError

public void logError(java.lang.String message)

Description copied from interface: IErrorLogger

Log an error that occurs while performing analysis.

Specified by:

logError in interface IErrorLogger

Overrides:

logError in class AbstractBugReporter

Parameters:

message - the error message

logError

public void logError(java.lang.String message,
                     java.lang.Throwable e)

Description copied from interface: IErrorLogger

Log an error that occurs while performing analysis.

Specified by:

logError in interface IErrorLogger

Overrides:

logError in class AbstractBugReporter

Parameters:

message - the error message

e - the exception which is the underlying cause of the error

reportMissingClass

public void reportMissingClass(java.lang.ClassNotFoundException ex)

Description copied from interface: IErrorLogger

Called to report a class lookup failure.

Specified by:

reportMissingClass in interface IErrorLogger

Overrides:

reportMissingClass in class AbstractBugReporter

Parameters:

ex - a ClassNotFoundException resulting from the class lookup failure

doReportBug

public void doReportBug(BugInstance bugInstance)

Description copied from class: AbstractBugReporter

Subclasses must override this. It will be called only for bugs which meet the priority threshold.

Specified by:

doReportBug in class AbstractBugReporter

Parameters:

bugInstance - the bug to report

getRealBugReporter

public BugReporter getRealBugReporter()

Description copied from interface: BugReporter

Get the real bug reporter at the end of a chain of delegating bug reporters. All non-delegating bug reporters should simply "return this".

Specified by:

getRealBugReporter in interface BugReporter

Overrides:

getRealBugReporter in class TextUIBugReporter

Returns:

the real bug reporter at the end of the chain, or this object if there is no delegation

finish

public void finish()

Description copied from interface: BugReporter

Finish reporting bugs. If any bug reports have been queued, calling this method will flush them.

Specified by:

finish in interface BugReporter