Package edu.umd.cs.findbugs

Class TextUIProgressCallback

java.lang.Object
edu.umd.cs.findbugs.TextUIProgressCallback
All Implemented Interfaces:
IClassPathBuilderProgress, FindBugsProgress
public class TextUIProgressCallback extends Object implements FindBugsProgress
Display FindBugs progress in the terminal window using ASCII codes. We assume that the terminal window is at least 80 characters wide.
Author:
David Hovemeyer

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextUIProgressCallback(PrintStream out)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    finishArchive()
    Report that FindBugs has finished scanning an archive in order to add its classes to the repository.
    void
    finishClass()
    Report that FindBugs has finished analyzing a class.
    void
    finishPerClassAnalysis()
    Called to indicate that the per-class analysis is finished, and that the whole program analysis is taking place.
    void
    predictPassCount(int[] classesPerPass)
    Provide an array that predicts the number of classes in each pass
    void
    reportNumberOfArchives(int numArchives)
    Report the total number of archives (Jar or zip files) that will be analyzed.
    void
    startAnalysis(int numClasses)
    Report that FindBugs has finished scanning the archives and will start analysing the classes contained therein.
    void
    startArchive(String name)
    Report that FindBugs has started scanning an archive in order to add its classes to the repository.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • TextUIProgressCallback

      public TextUIProgressCallback(PrintStream out)

  • Method Details

    • reportNumberOfArchives

      public void reportNumberOfArchives(int numArchives)
      Description copied from interface: FindBugsProgress
      Report the total number of archives (Jar or zip files) that will be analyzed.
      Specified by:
      reportNumberOfArchives in interface FindBugsProgress
      Parameters:
      numArchives - the number of archives

    • finishArchive

      public void finishArchive()
      Description copied from interface: FindBugsProgress
      Report that FindBugs has finished scanning an archive in order to add its classes to the repository.
      Specified by:
      finishArchive in interface FindBugsProgress
      Specified by:
      finishArchive in interface IClassPathBuilderProgress

    • predictPassCount

      public void predictPassCount(int[] classesPerPass)
      Description copied from interface: FindBugsProgress
      Provide an array that predicts the number of classes in each pass
      Specified by:
      predictPassCount in interface FindBugsProgress

    • startAnalysis

      public void startAnalysis(int numClasses)
      Description copied from interface: FindBugsProgress
      Report that FindBugs has finished scanning the archives and will start analysing the classes contained therein.
      Specified by:
      startAnalysis in interface FindBugsProgress
      Parameters:
      numClasses - number of classes found in all of the archives

    • finishClass

      public void finishClass()
      Description copied from interface: FindBugsProgress
      Report that FindBugs has finished analyzing a class.
      Specified by:
      finishClass in interface FindBugsProgress

    • finishPerClassAnalysis

      public void finishPerClassAnalysis()
      Description copied from interface: FindBugsProgress
      Called to indicate that the per-class analysis is finished, and that the whole program analysis is taking place.
      Specified by:
      finishPerClassAnalysis in interface FindBugsProgress

    • startArchive

      public void startArchive(String name)
      Description copied from interface: FindBugsProgress
      Report that FindBugs has started scanning an archive in order to add its classes to the repository.
      Specified by:
      startArchive in interface FindBugsProgress
      Specified by:
      startArchive in interface IClassPathBuilderProgress