Package edu.umd.cs.findbugs

Interface BugReporter

All Superinterfaces:

IClassObserver, IErrorLogger, RepositoryLookupFailureCallback

All Known Implementing Classes:

AbstractBugReporter, BugCollectionBugReporter, BugReportDispatcher, BugReporterDecorator, CategoryFilteringBugReporter, DelegatingBugReporter, EmacsBugReporter, ErrorCountingBugReporter, ExcludingHashesBugReporter, FilterBugReporter, HTMLBugReporter, MaxRankDecorator, PrintingBugReporter, SarifBugReporter, SortingBugReporter, SuppressionDecorator, TextUIBugReporter, XDocsBugReporter, XMLBugReporter

public interface BugReporter
extends RepositoryLookupFailureCallback, IClassObserver

Generic interface for bug reporter objects. A BugReporter accumulates all of the information reported by the analysis, which includes bug reports, and also auxiliary information such as analysis errors, missing classes, and class to source file mapping.

Author:

David Hovemeyer

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NORMAL	Normal error-reporting verbosity level.
static final int	SILENT	Silent error-reporting verbosity level.

Method Summary

Modifier and Type	Method	Description
void	addObserver(BugReporterObserver observer)	Add an observer.
void	finish()	Finish reporting bugs.
BugCollection	getBugCollection()	Get the bug collection (if any) associated with this bug reporter
ProjectStats	getProjectStats()	Get ProjectStats object used to store statistics about the overall project being analyzed.
void	reportBug(BugInstance bugInstance)	Report a bug.
void	reportQueuedErrors()	Report any accumulated error messages.
void	setErrorVerbosity(int level)	Set the error-reporting verbosity level.
void	setPriorityThreshold(int threshold)	Set the priority threshold.

Methods inherited from interface edu.umd.cs.findbugs.classfile.IClassObserver

observeClass

Methods inherited from interface edu.umd.cs.findbugs.classfile.IErrorLogger

logError, logError, reportMissingClass, reportMissingClass, reportSkippedAnalysis

Field Details

SILENT

static final int SILENT

Silent error-reporting verbosity level.

See Also:

• Constant Field Values

NORMAL

static final int NORMAL

Normal error-reporting verbosity level.

See Also:

• Constant Field Values

Method Details

setErrorVerbosity

void setErrorVerbosity(int level)

Set the error-reporting verbosity level.

Parameters:

level - the verbosity level

setPriorityThreshold

void setPriorityThreshold(int threshold)

Set the priority threshold.

Parameters:

threshold - bug instances must be at least as important as this priority to be reported

reportBug

void reportBug(@Nonnull
 BugInstance bugInstance)

Report a bug. The implementation may report the bug immediately, or queue it for later.

Parameters:

bugInstance - object describing the bug instance

finish

void finish()

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

reportQueuedErrors

void reportQueuedErrors()

Report any accumulated error messages.

addObserver

void addObserver(BugReporterObserver observer)

Add an observer.

Parameters:

observer - the observer

getProjectStats

ProjectStats getProjectStats()

Get ProjectStats object used to store statistics about the overall project being analyzed.

getBugCollection

@CheckForNull
BugCollection getBugCollection()

Get the bug collection (if any) associated with this bug reporter