edu.umd.cs.findbugs
public interface IFindBugsEngine
Method Summary | |
---|---|
void | addClassObserver(IClassObserver classObserver)
Add an IClassObserver.
|
void | addFilter(String filterFileName, boolean include)
Set filter of bug instances to include or exclude.
|
boolean | emitTrainingOutput()
Return whether or not training output should be emitted
after analysis completes.
|
void | enableTrainingInput(String trainingInputDir)
Set whether or not training input should be used to
make the analysis more precise.
|
void | enableTrainingOutput(String trainingOutputDir)
Set whether or not training output should be emitted.
|
void | execute()
Execute FindBugs on the Project.
|
int | getBugCount()
Get the number of bug instances that were reported during analysis. |
BugReporter | getBugReporter()
Get the BugReporter.
|
String | getCurrentClass()
Get the name of the most recent class to be analyzed.
|
int | getErrorCount()
Get the number of errors that occurred during analysis. |
int | getMissingClassCount()
Get the number of time missing classes were reported during analysis. |
Project | getProject()
Get the Project.
|
String | getProjectName() |
String | getReleaseName() |
String | getTrainingInputDir()
Get the training input database directory.
|
String | getTrainingOutputDir()
Get the training output directory.
|
UserPreferences | getUserPreferences()
Get the UserPreferences.
|
void | setAbridgedMessages(boolean xmlWithAbridgedMessages) |
void | setAnalysisFeatureSettings(AnalysisFeatureSetting[] settingList)
Set analysis feature settings.
|
void | setBugReporter(BugReporter bugReporter)
Set the BugReporter.
|
void | setClassScreener(IClassScreener classScreener)
Set the ClassScreener.
|
void | setDetectorFactoryCollection(DetectorFactoryCollection detectorFactoryCollection)
Set the DetectorFactoryCollection from which plugins/detectors
may be accessed.
|
void | setProgressCallback(FindBugsProgress progressCallback)
Set the progress callback that will be used to keep track
of the progress of the analysis.
|
void | setProject(Project project)
Set the Project.
|
void | setProjectName(String projectName) |
void | setRelaxedReportingMode(boolean relaxedReportingMode)
Set relaxed reporting mode.
|
void | setReleaseName(String releaseName) |
void | setScanNestedArchives(boolean scanNestedArchives)
Set whether or not nested archives should be scanned.
|
void | setSourceInfoFile(String sourceInfoFile)
Set the filename of the source info file containing line numbers for fields
and classes.
|
void | setUserPreferences(UserPreferences userPreferences)
Set the UserPreferences representing which Detectors
should be used. |
boolean | useTrainingInput()
Return whether or not we should make use of
training data.
|
Parameters: classObserver the IClassObserver
Parameters: filterFileName the name of the filter file include true if the filter specifies bug instances to include, false if it specifies bug instances to exclude
Returns: true if training output should be emitted, false if not
Parameters: trainingInputDir directory to load training input from
Parameters: trainingOutputDir directory to save training output in
Throws: java.io.IOException if an I/O exception occurs analyzing one of the files InterruptedException if the thread is interrupted while conducting the analysis CheckedAnalysisException if a fatal exception occurs
Returns: the BugReporter
Returns: the Project
Returns: Returns the projectName.
Returns: Returns the releaseName.
Returns: the training input database directory
Returns: the training output directory
Returns: the UserPreferences
Parameters: xmlWithAbridgedMessages
Parameters: settingList list of analysis feature settings
Parameters: bugReporter The BugReporter to set
Parameters: classScreener the ClassScreener to use
Parameters: detectorFactoryCollection the DetectorFactoryCollection
Parameters: progressCallback the progress callback
Parameters: project The Project to set
Parameters: projectName The project name to set.
Parameters: relaxedReportingMode true if relaxed reporting mode should be enabled, false if not
Parameters: releaseName The releaseName to set.
Parameters: scanNestedArchives true if nested archives should be scanned, false if not
Parameters: sourceInfoFile the source info filename
Parameters: userPreferences the UserPreferences
Returns: true if training data should be used, false if not