edu.umd.cs.findbugs

Class FindBugs

java.lang.Object

edu.umd.cs.findbugs.FindBugs

public abstract class FindBugs
extends Object

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.

Author:

Bill Pugh, David Hovemeyer

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG Debug tracing.
static AnalysisFeatureSetting[]	DEFAULT_EFFORT Analysis settings for -effort:default.
static Set<String>	knownURLProtocolSet Known URL protocols.
static AnalysisFeatureSetting[]	LESS_EFFORT Analysis settings for -effort:less.
static Logger	LOGGER
static AnalysisFeatureSetting[]	MAX_EFFORT Analysis settings for -effort:max.
static AnalysisFeatureSetting[]	MIN_EFFORT Analysis settings for -effort:min.
static long	MINIMUM_TIMESTAMP Date of release of Java 1.0
static AnalysisFeatureSetting[]	MORE_EFFORT Analysis settings for -effort:more.

Constructor Summary

Constructors

Constructor and Description
FindBugs()

Method Summary

Methods

Modifier and Type	Method and Description
static BugReporter	configureBaselineFilter(BugReporter bugReporter, 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 BugReporter	configureFilter(BugReporter bugReporter, String filterFileName, boolean include) Configure the (bug instance) Filter for the given DelegatingBugReporter.
static void	configureTrainingDatabases(IFindBugsEngine findBugs) Configure training databases.
static String	getHome() Get the FindBugs home directory.
static Set<String>	handleBugCategories(String categories) Process -bugCategories option.
static boolean	isDetectorEnabled(IFindBugsEngine findBugs, DetectorFactory factory, int rankThreshold) Determines whether or not given DetectorFactory should be enabled.
static boolean	isNoAnalysis()
static boolean	isNoMains()
static void	processCommandLine(TextUICommandLine commandLine, 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(String home) Set the FindBugs home directory.
static void	setNoAnalysis() Disable analysis within FindBugs.
static void	setNoMains() Disable loading of FindBugsMain classes.
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.
static boolean	validTimestamp(long timestamp)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_EFFORT

public static final AnalysisFeatureSetting[] MIN_EFFORT

Analysis settings for -effort:min.

LESS_EFFORT

public static final AnalysisFeatureSetting[] LESS_EFFORT

Analysis settings for -effort:less.

DEFAULT_EFFORT

public static final AnalysisFeatureSetting[] DEFAULT_EFFORT

Analysis settings for -effort:default.

MORE_EFFORT

public static final AnalysisFeatureSetting[] MORE_EFFORT

Analysis settings for -effort:more.

MAX_EFFORT

public static final AnalysisFeatureSetting[] MAX_EFFORT

Analysis settings for -effort:max.

DEBUG

public static final boolean DEBUG

Debug tracing.

LOGGER

public static final Logger LOGGER

knownURLProtocolSet

@StaticConstant
public static final Set<String> knownURLProtocolSet

Known URL protocols. Filename URLs that do not have an explicit protocol are assumed to be files.

MINIMUM_TIMESTAMP

public static final long MINIMUM_TIMESTAMP

Date of release of Java 1.0

Constructor Detail

FindBugs

public FindBugs()

Method Detail

setNoAnalysis

public static void setNoAnalysis()

Disable analysis within FindBugs. Turns off loading of bug detectors.

isNoAnalysis

public static boolean isNoAnalysis()

Returns:

Returns the noAnalysis.

setNoMains

public static void setNoMains()

Disable loading of FindBugsMain classes.

isNoMains

public static boolean isNoMains()

Returns:

Returns the noMains.

setHome

public static void setHome(String home)

Set the FindBugs home directory.

getHome

public static String getHome()

Get the FindBugs home directory.

configureTrainingDatabases

public static void configureTrainingDatabases(IFindBugsEngine findBugs)
                                       throws IOException

Configure training databases.

Parameters:

findBugs - the IFindBugsEngine to configure

Throws:

IOException

isDetectorEnabled

public static boolean isDetectorEnabled(IFindBugsEngine findBugs,
                        DetectorFactory factory,
                        int rankThreshold)

Determines whether or not given DetectorFactory should be enabled.

Parameters:

findBugs - the IFindBugsEngine

factory - the DetectorFactory

rankThreshold - TODO

Returns:

true if the DetectorFactory should be enabled, false otherwise

handleBugCategories

public static Set<String> handleBugCategories(String categories)

Process -bugCategories option.

Parameters:

categories - comma-separated list of bug categories

Returns:

Set of categories to be used

processCommandLine

public static void processCommandLine(TextUICommandLine commandLine,
                      String[] argv,
                      IFindBugsEngine findBugs)
                               throws IOException,
                                      FilterException

Process the command line.

Parameters:

commandLine - the TextUICommandLine object which will parse the command line

argv - the command line arguments

findBugs - the IFindBugsEngine to configure

Throws:

IOException

FilterException

showHelp

public static void showHelp(TextUICommandLine commandLine)

Show -help message.

Parameters:

commandLine -

runMain

public static void runMain(IFindBugsEngine findBugs,
           TextUICommandLine commandLine)
                    throws IOException

Given a fully-configured IFindBugsEngine and the TextUICommandLine used to configure it, execute the analysis.

Parameters:

findBugs - a fully-configured IFindBugsEngine

commandLine - the TextUICommandLine used to configure the IFindBugsEngine

Throws:

IOException

showCommandLineOptions

public static void showCommandLineOptions()

Print command line options synopses to stdout.

showCommandLineOptions

public static void showCommandLineOptions(TextUICommandLine commandLine)

Print command line options synopses to stdout.

Parameters:

commandLine - the TextUICommandLine whose options should be printed

showSynopsis

public static void showSynopsis()

Show the overall FindBugs command synopsis.

configureFilter

public static BugReporter configureFilter(BugReporter bugReporter,
                          String filterFileName,
                          boolean include)
                                   throws IOException,
                                          FilterException

Configure the (bug instance) Filter for the given DelegatingBugReporter.

Parameters:

bugReporter - a DelegatingBugReporter

filterFileName - filter file name

include - true if the filter is an include filter, false if it's an exclude filter

Throws:

IOException

FilterException

configureBaselineFilter

public static BugReporter configureBaselineFilter(BugReporter bugReporter,
                                  String baselineFileName)
                                           throws IOException,
                                                  org.dom4j.DocumentException

Configure a baseline bug instance filter.

Parameters:

bugReporter - a DelegatingBugReporter

baselineFileName - filename of baseline Filter

Throws:

IOException

org.dom4j.DocumentException

configureBugCollection

public static void configureBugCollection(IFindBugsEngine findBugs)

Configure the BugCollection (if the BugReporter being used is constructing one).

Parameters:

findBugs - the IFindBugsEngine

validTimestamp

public static boolean validTimestamp(long timestamp)