|
FindBugs™ 1.3.8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.FindBugs
public abstract class FindBugs
Static methods and fields useful for working with instances of
IFindBugsEngine.
This class was previously the main driver for FindBugs analyses,
but has been replaced by FindBugs2
.
Field Summary | |
---|---|
static boolean |
DEBUG
Debug tracing. |
static AnalysisFeatureSetting[] |
DEFAULT_EFFORT
Analysis settings for -effort:default. |
static java.util.Set<java.lang.String> |
knownURLProtocolSet
Known URL protocols. |
static AnalysisFeatureSetting[] |
LESS_EFFORT
Analysis settings for -effort:less. |
static AnalysisFeatureSetting[] |
MAX_EFFORT
Analysis settings for -effort:max. |
static AnalysisFeatureSetting[] |
MIN_EFFORT
Analysis settings for -effort:min. |
static AnalysisFeatureSetting[] |
MORE_EFFORT
Analysis settings for -effort:more. |
Constructor Summary | |
---|---|
FindBugs()
|
Method Summary | |
---|---|
static void |
configureBaselineFilter(DelegatingBugReporter bugReporter,
java.lang.String baselineFileName)
Configure a baseline bug instance filter. |
static void |
configureBugCollection(IFindBugsEngine findBugs)
Configure the BugCollection (if the BugReporter being used is constructing one). |
static void |
configureFilter(DelegatingBugReporter bugReporter,
java.lang.String filterFileName,
boolean include)
Configure the (bug instance) Filter for the given DelegatingBugReporter. |
static void |
configureTrainingDatabases(IFindBugsEngine findBugs)
Configure training databases. |
static java.lang.String |
getHome()
Get the FindBugs home directory. |
static java.util.Set<java.lang.String> |
handleBugCategories(UserPreferences userPreferences,
java.lang.String categories)
Process -bugCategories option. |
static boolean |
isDetectorEnabled(IFindBugsEngine findBugs,
DetectorFactory factory)
Determing whether or not given DetectorFactory should be enabled. |
static void |
processCommandLine(TextUICommandLine commandLine,
java.lang.String[] argv,
IFindBugsEngine findBugs)
Process the command line. |
static void |
runMain(IFindBugsEngine findBugs,
TextUICommandLine commandLine)
Given a fully-configured IFindBugsEngine and the TextUICommandLine used to configure it, execute the analysis. |
static void |
setHome(java.lang.String home)
Set the FindBugs home directory. |
static void |
showCommandLineOptions()
Print command line options synopses to stdout. |
static void |
showCommandLineOptions(TextUICommandLine commandLine)
Print command line options synopses to stdout. |
static void |
showHelp(TextUICommandLine commandLine)
Show -help message. |
static void |
showSynopsis()
Show the overall FindBugs command synopsis. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final AnalysisFeatureSetting[] MIN_EFFORT
public static final AnalysisFeatureSetting[] LESS_EFFORT
public static final AnalysisFeatureSetting[] DEFAULT_EFFORT
public static final AnalysisFeatureSetting[] MORE_EFFORT
public static final AnalysisFeatureSetting[] MAX_EFFORT
public static final boolean DEBUG
public static final java.util.Set<java.lang.String> knownURLProtocolSet
Constructor Detail |
---|
public FindBugs()
Method Detail |
---|
public static void setHome(java.lang.String home)
public static java.lang.String getHome()
public static void configureTrainingDatabases(IFindBugsEngine findBugs) throws java.io.IOException
findBugs
- the IFindBugsEngine to configure
java.io.IOException
public static boolean isDetectorEnabled(IFindBugsEngine findBugs, DetectorFactory factory)
findBugs
- the IFindBugsEnginefactory
- the DetectorFactory
public static java.util.Set<java.lang.String> handleBugCategories(UserPreferences userPreferences, java.lang.String categories)
userPreferences
- UserPreferences representing which Detectors are enabledcategories
- comma-separated list of bug categories
public static void processCommandLine(TextUICommandLine commandLine, java.lang.String[] argv, IFindBugsEngine findBugs) throws java.io.IOException, FilterException
commandLine
- the TextUICommandLine object which will parse the command lineargv
- the command line argumentsfindBugs
- the IFindBugsEngine to configure
java.io.IOException
FilterException
public static void showHelp(TextUICommandLine commandLine)
commandLine
- public static void runMain(IFindBugsEngine findBugs, TextUICommandLine commandLine) throws java.io.IOException, java.lang.RuntimeException
findBugs
- a fully-configured IFindBugsEnginecommandLine
- the TextUICommandLine used to configure the IFindBugsEngine
java.io.IOException
java.lang.RuntimeException
public static void showCommandLineOptions()
public static void showCommandLineOptions(TextUICommandLine commandLine)
commandLine
- the TextUICommandLine whose options should be printedpublic static void showSynopsis()
public static void configureFilter(DelegatingBugReporter bugReporter, java.lang.String filterFileName, boolean include) throws java.io.IOException, FilterException
bugReporter
- a DelegatingBugReporterfilterFileName
- filter file nameinclude
- true if the filter is an include filter, false if it's an exclude filter
java.io.IOException
FilterException
public static void configureBaselineFilter(DelegatingBugReporter bugReporter, java.lang.String baselineFileName) throws java.io.IOException, org.dom4j.DocumentException
bugReporter
- a DelegatingBugReporterbaselineFileName
- filename of baseline Filter
java.io.IOException
org.dom4j.DocumentException
public static void configureBugCollection(IFindBugsEngine findBugs)
findBugs
- the IFindBugsEngine
|
FindBugs™ 1.3.8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |