Class BugReportDispatcher

java.lang.Object
edu.umd.cs.findbugs.BugReportDispatcher
All Implemented Interfaces:
RepositoryLookupFailureCallback, BugReporter, IClassObserver, IErrorLogger, ConfigurableBugReporter
public class BugReportDispatcher extends Object implements ConfigurableBugReporter
Bug reporter delegate actual operation to each bug reporter in the list. It is designed to output multiple reports in batch.

  • Field Details

  • Constructor Details

  • Method Details

    • setErrorVerbosity

      public void setErrorVerbosity(int level)
      Description copied from interface: BugReporter
      Set the error-reporting verbosity level.
      Specified by:
      setErrorVerbosity in interface BugReporter
      Parameters:
      level - the verbosity level

    • setPriorityThreshold

      public void setPriorityThreshold(int threshold)
      Description copied from interface: BugReporter
      Set the priority threshold.
      Specified by:
      setPriorityThreshold in interface BugReporter
      Parameters:
      threshold - bug instances must be at least as important as this priority to be reported

    • setPriorityAdjuster

      public void setPriorityAdjuster(PriorityAdjuster priorityAdjuster)
      Description copied from interface: BugReporter
      Set an optional priority adjuster.
      Specified by:
      setPriorityAdjuster in interface BugReporter
      Parameters:
      priorityAdjuster - the priority adjuster

    • 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

    • reportQueuedErrors

      public void reportQueuedErrors()
      Description copied from interface: BugReporter
      Report any accumulated error messages.
      Specified by:
      reportQueuedErrors in interface BugReporter

    • addObserver

      public void addObserver(BugReporterObserver observer)
      Description copied from interface: BugReporter
      Add an observer.
      Specified by:
      addObserver in interface BugReporter
      Parameters:
      observer - the observer

    • getProjectStats

      public ProjectStats getProjectStats()
      Description copied from interface: BugReporter
      Get ProjectStats object used to store statistics about the overall project being analyzed.
      Specified by:
      getProjectStats in interface BugReporter

    • reportBug

      public void reportBug(@NonNull BugInstance bugInstance)
      Description copied from interface: BugReporter
      Report a bug. The implementation may report the bug immediately, or queue it for later.
      Specified by:
      reportBug in interface BugReporter
      Parameters:
      bugInstance - object describing the bug instance

    • getBugCollection

      @CheckForNull public BugCollection getBugCollection()
      Description copied from interface: BugReporter
      Get the bug collection (if any) associated with this bug reporter
      Specified by:
      getBugCollection in interface BugReporter

    • 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

    • reportMissingClass

      public void reportMissingClass(ClassNotFoundException ex)
      Description copied from interface: IErrorLogger
      Called to report a class lookup failure.
      Specified by:
      reportMissingClass in interface IErrorLogger
      Parameters:
      ex - a ClassNotFoundException resulting from the class lookup failure

    • reportMissingClass

      public void reportMissingClass(ClassDescriptor classDescriptor)
      Description copied from interface: IErrorLogger
      Called to report a class lookup failure.
      Specified by:
      reportMissingClass in interface IErrorLogger
      Parameters:
      classDescriptor - ClassDescriptor of a missing class

    • logError

      public void logError(String message)
      Description copied from interface: IErrorLogger
      Log an error that occurs while performing analysis.
      Specified by:
      logError in interface IErrorLogger
      Parameters:
      message - the error message

    • logError

      public void logError(String message, Throwable e)
      Description copied from interface: IErrorLogger
      Log an error that occurs while performing analysis.
      Specified by:
      logError in interface IErrorLogger
      Parameters:
      message - the error message
      e - the exception which is the underlying cause of the error

    • reportSkippedAnalysis

      public void reportSkippedAnalysis(MethodDescriptor method)
      Description copied from interface: IErrorLogger
      Report that we skipped some analysis of a method
      Specified by:
      reportSkippedAnalysis in interface IErrorLogger
      Parameters:
      method - the method we skipped

    • setRankThreshold

      public void setRankThreshold(int threshold)
      Specified by:
      setRankThreshold in interface ConfigurableBugReporter

    • setUseLongBugCodes

      public void setUseLongBugCodes(boolean useLongBugCodes)
      Specified by:
      setUseLongBugCodes in interface ConfigurableBugReporter

    • setOutputStream

      public void setOutputStream(PrintStream outputStream)
      Specified by:
      setOutputStream in interface ConfigurableBugReporter

    • forEach

      private void forEach(Consumer<TextUIBugReporter> consumer)
      Consume each reporter one by one, and throw an exception if some of them.
      Parameters:
      consumer - Operation to handle each reporter.