|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFindBugsEngine
Interface for a FindBugs engine class. An instance of this interface takes a project, user configuration options, orchestrates the analysis of the classes in the project, and reports the results to the configured BugReporter.
Method Summary | |
---|---|
void |
addClassObserver(IClassObserver classObserver)
Add an IClassObserver. |
void |
addFilter(java.lang.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(java.lang.String trainingInputDir)
Set whether or not training input should be used to make the analysis more precise. |
void |
enableTrainingOutput(java.lang.String trainingOutputDir)
Set whether or not training output should be emitted. |
void |
excludeBaselineBugs(java.lang.String baselineBugs)
Provide baseline of bugs not to report |
void |
execute()
Execute FindBugs on the Project. |
void |
finishSettings()
|
int |
getBugCount()
Get the number of bug instances that were reported during analysis. |
BugReporter |
getBugReporter()
Get the BugReporter. |
java.lang.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. |
java.lang.String |
getProjectName()
|
java.lang.String |
getReleaseName()
|
java.lang.String |
getTrainingInputDir()
Get the training input database directory. |
java.lang.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 |
setApplySuppression(boolean applySuppression)
|
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 |
setMergeSimilarWarnings(boolean mergeSimilarWarnings)
|
void |
setNoClassOk(boolean noClassOk)
Set whether or not to generate an empty output file if there were no class files specified. |
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(java.lang.String projectName)
|
void |
setRelaxedReportingMode(boolean relaxedReportingMode)
Set relaxed reporting mode. |
void |
setReleaseName(java.lang.String releaseName)
|
void |
setScanNestedArchives(boolean scanNestedArchives)
Set whether or not nested archives should be scanned. |
void |
setSourceInfoFile(java.lang.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. |
Method Detail |
---|
BugReporter getBugReporter()
void setBugReporter(BugReporter bugReporter)
bugReporter
- The BugReporter to setvoid setProject(Project project)
project
- The Project to setProject getProject()
void setProgressCallback(FindBugsProgress progressCallback)
progressCallback
- the progress callbackvoid addFilter(java.lang.String filterFileName, boolean include) throws java.io.IOException, FilterException
filterFileName
- the name of the filter fileinclude
- true if the filter specifies bug instances to include,
false if it specifies bug instances to exclude
java.io.IOException
FilterException
void excludeBaselineBugs(java.lang.String baselineBugs) throws java.io.IOException, org.dom4j.DocumentException
baselineBugs
- the name of the xml bug baseline file
org.dom4j.DocumentException
java.io.IOException
void setUserPreferences(UserPreferences userPreferences)
userPreferences
- the UserPreferencesvoid addClassObserver(IClassObserver classObserver)
classObserver
- the IClassObservervoid setClassScreener(IClassScreener classScreener)
classScreener
- the ClassScreener to usevoid setRelaxedReportingMode(boolean relaxedReportingMode)
relaxedReportingMode
- true if relaxed reporting mode should be enabled,
false if notvoid enableTrainingOutput(java.lang.String trainingOutputDir)
trainingOutputDir
- directory to save training output invoid enableTrainingInput(java.lang.String trainingInputDir)
trainingInputDir
- directory to load training input fromvoid setAnalysisFeatureSettings(AnalysisFeatureSetting[] settingList)
settingList
- list of analysis feature settingsjava.lang.String getReleaseName()
void setReleaseName(java.lang.String releaseName)
releaseName
- The releaseName to set.java.lang.String getProjectName()
void setProjectName(java.lang.String projectName)
projectName
- The project name to set.void setSourceInfoFile(java.lang.String sourceInfoFile)
sourceInfoFile
- the source info filenamevoid execute() throws java.io.IOException, java.lang.InterruptedException
java.io.IOException
- if an I/O exception occurs analyzing one of the files
java.lang.InterruptedException
- if the thread is interrupted while conducting the analysis
CheckedAnalysisException
- if a fatal exception occursjava.lang.String getCurrentClass()
int getBugCount()
int getErrorCount()
int getMissingClassCount()
UserPreferences getUserPreferences()
boolean emitTrainingOutput()
java.lang.String getTrainingOutputDir()
boolean useTrainingInput()
java.lang.String getTrainingInputDir()
void setScanNestedArchives(boolean scanNestedArchives)
scanNestedArchives
- true if nested archives should be scanned, false if notvoid setNoClassOk(boolean noClassOk)
noClassOk
- true if FindBugs should generate empty output filevoid setDetectorFactoryCollection(DetectorFactoryCollection detectorFactoryCollection)
detectorFactoryCollection
- the DetectorFactoryCollectionvoid setAbridgedMessages(boolean xmlWithAbridgedMessages)
xmlWithAbridgedMessages
- void setMergeSimilarWarnings(boolean mergeSimilarWarnings)
void setApplySuppression(boolean applySuppression)
void finishSettings()
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |