Interface BugReporter

All Superinterfaces:
IClassObserver, IErrorLogger, RepositoryLookupFailureCallback
All Known Subinterfaces:
ConfigurableBugReporter
All Known Implementing Classes:
AbstractBugReporter, BugCollectionBugReporter, BugReportDispatcher, BugReporterDecorator, CategoryFilteringBugReporter, DelegatingBugReporter, EmacsBugReporter, ErrorCountingBugReporter, ExcludingHashesBugReporter, FilterBugReporter, HTMLBugReporter, MaxRankDecorator, PrintingBugReporter, SarifBugReporter, SortingBugReporter, SuppressionDecorator, SuppressionMatcherBugReporter, SynchronizedBugReporter, 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.

  • Field Details

    • SILENT

      static final int SILENT
      Silent error-reporting verbosity level.
      See Also:

    • NORMAL

      static final int NORMAL
      Normal error-reporting verbosity level.
      See Also:

  • 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

    • setPriorityAdjuster

      void setPriorityAdjuster(PriorityAdjuster priorityAdjuster)
      Set an optional priority adjuster.
      Parameters:
      priorityAdjuster - the priority adjuster

    • 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

      @Nullable BugCollection getBugCollection()
      Get the bug collection (if any) associated with this bug reporter

    • getPriorityAdjuster

      default @Nullable PriorityAdjuster getPriorityAdjuster()
      Returns:
      the PriorityAdjuster set for this BugReporter, or null if none was set