FindBugsProgress (FindBugs 3.0.1-dev-20240220 API)

All Superinterfaces:

IClassPathBuilderProgress

All Known Implementing Classes:

AnalyzingDialog, NoOpFindBugsProgress, TextUIProgressCallback
```
public interface FindBugsProgress
extends IClassPathBuilderProgress
```
A callback that may be installed in a FindBugs instance to asynchronously keep track of its progress.

Author:

David Hovemeyer

See Also:

FindBugs

Method Summary

All Methods Instance Methods Abstract Methods
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(java.lang.String name)`	Report that FindBugs has started scanning an archive in order to add its classes to the repository.

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