edu.umd.cs.findbugs

Class DetectorFactoryCollection

java.lang.Object

edu.umd.cs.findbugs.DetectorFactoryCollection

All Implemented Interfaces:

GlobalOptions, UpdateCheckCallback

public class DetectorFactoryCollection
extends java.lang.Object
implements UpdateCheckCallback

The DetectorFactoryCollection stores all of the DetectorFactory objects used to create the Detectors which implement the various analyses. It is a singleton class.

Author:

David Hovemeyer

See Also:

DetectorFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,BugCode>	bugCodeMap
protected java.util.Map<java.lang.String,BugPattern>	bugPatternMap
protected java.util.Map<java.lang.String,BugCategory>	categoryDescriptionMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetectorFactoryCollection()
protected	DetectorFactoryCollection(java.util.Collection<Plugin> enabled)
protected	DetectorFactoryCollection(Plugin onlyPlugin)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPluginUpdateListener(PluginUpdateListener listener)
java.util.Iterator<BugPattern>	bugPatternIterator() Get an Iterator over all registered bug patterns.
void	checkForUpdates(boolean force)
java.util.Iterator<DetectorFactory>	factoryIterator() Return an Iterator over the DetectorFactory objects for all registered Detectors.
java.util.Collection<java.lang.String>	getBugCategories() Get a Collection containing all known bug category keys.
BugCategory	getBugCategory(java.lang.String category) Get the BugCategory object for a category key.
java.util.Collection<BugCategory>	getBugCategoryObjects()
BugCode	getBugCode(java.lang.String shortBugType) Get a description for given "bug type".
java.util.Collection<BugCode>	getBugCodes()
java.util.Collection<BugPattern>	getBugPatterns() Get an Iterator over all registered bug patterns.
Plugin	getCorePlugin()
static java.net.URL	getCoreResource(java.lang.String name)
java.lang.Iterable<DetectorFactory>	getFactories() Return an Iterable over the DetectorFactory objects for all registered Detectors.
DetectorFactory	getFactory(java.lang.String name) Look up a DetectorFactory by its short name.
DetectorFactory	getFactoryByClassName(java.lang.String className) Look up a DetectorFactory by its class name.
static java.lang.String	getFindBugsHome()
java.lang.String	getGlobalOption(java.lang.String key)
Plugin	getGlobalOptionSetter(java.lang.String key)
Plugin	getPluginById(java.lang.String pluginId) Get a Plugin by its unique id.
java.util.Map<java.lang.String,CloudPlugin>	getRegisteredClouds()
UpdateChecker	getUpdateChecker()
FutureValue<java.util.Collection<UpdateChecker.PluginUpdate>>	getUpdates()
static DetectorFactoryCollection	instance() Get the single instance of DetectorFactoryCollection, which knows each and every loaded plugin, independently of it's enablement
boolean	isDisabledByDefault(java.lang.String bugPatternOrCode)
static void	jawsDebugMessage(java.lang.String message)
BugCode	lookupBugCode(java.lang.String shortBugType)
BugPattern	lookupBugPattern(java.lang.String bugType) Look up bug pattern.
java.util.Iterator<Plugin>	pluginIterator() Return an Iterator over all available Plugin objects.
java.util.Collection<Plugin>	plugins() Return an Collection of all available Plugin objects.
void	pluginUpdateCheckComplete(java.util.List<UpdateChecker.PluginUpdate> newUpdates, boolean force)
boolean	registerBugCategory(BugCategory bc) Set the metadata for a bug category.
void	registerBugCode(BugCode bugCode)
void	registerBugPattern(BugPattern bugPattern) Register a BugPattern.
static void	resetInstance(DetectorFactoryCollection instance) Reset the factory singleton.
protected boolean	unRegisterBugCategory(BugCategory bc)
protected void	unRegisterBugCode(BugCode bugCode)
protected void	unRegisterBugPattern(BugPattern bugPattern)

Methods inherited from class java.lang.Object

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

Field Detail

categoryDescriptionMap

protected final java.util.Map<java.lang.String,BugCategory> categoryDescriptionMap

bugPatternMap

protected final java.util.Map<java.lang.String,BugPattern> bugPatternMap

bugCodeMap

protected final java.util.Map<java.lang.String,BugCode> bugCodeMap

Constructor Detail

DetectorFactoryCollection

protected DetectorFactoryCollection()

DetectorFactoryCollection

protected DetectorFactoryCollection(Plugin onlyPlugin)

DetectorFactoryCollection

protected DetectorFactoryCollection(java.util.Collection<Plugin> enabled)

Method Detail

checkForUpdates

public void checkForUpdates(boolean force)

Parameters:

force - whether the updates should be shown to the user no matter what - even if the updates have been seen before

resetInstance

public static void resetInstance(@CheckForNull
                 DetectorFactoryCollection instance)

Reset the factory singleton.

Implementation note: This method is public for tests only!

Parameters:

instance - use null to clear the instance

instance

public static DetectorFactoryCollection instance()

Get the single instance of DetectorFactoryCollection, which knows each and every loaded plugin, independently of it's enablement

getGlobalOption

@CheckForNull
public java.lang.String getGlobalOption(java.lang.String key)

Specified by:

getGlobalOption in interface GlobalOptions

getGlobalOptionSetter

@CheckForNull
public Plugin getGlobalOptionSetter(java.lang.String key)

Specified by:

getGlobalOptionSetter in interface GlobalOptions

pluginIterator

public java.util.Iterator<Plugin> pluginIterator()

Return an Iterator over all available Plugin objects.

plugins

public java.util.Collection<Plugin> plugins()

Return an Collection of all available Plugin objects.

getCorePlugin

@Nonnull
public Plugin getCorePlugin()

getPluginById

public Plugin getPluginById(java.lang.String pluginId)

Get a Plugin by its unique id.

Parameters:

pluginId - the unique id

Returns:

the Plugin with that id, or null if no such Plugin is found

factoryIterator

public java.util.Iterator<DetectorFactory> factoryIterator()

Return an Iterator over the DetectorFactory objects for all registered Detectors.

getFactories

public java.lang.Iterable<DetectorFactory> getFactories()

Return an Iterable over the DetectorFactory objects for all registered Detectors.

isDisabledByDefault

public boolean isDisabledByDefault(java.lang.String bugPatternOrCode)

getFactory

public DetectorFactory getFactory(java.lang.String name)

Look up a DetectorFactory by its short name.

Parameters:

name - the short name

Returns:

the DetectorFactory, or null if there is no factory with that short name

getFactoryByClassName

public DetectorFactory getFactoryByClassName(java.lang.String className)

Look up a DetectorFactory by its class name.

Parameters:

className - the class name

Returns:

the DetectoryFactory, or null if there is no factory with that class name

getFindBugsHome

public static java.lang.String getFindBugsHome()

getCoreResource

@CheckForNull
public static java.net.URL getCoreResource(java.lang.String name)

jawsDebugMessage

public static void jawsDebugMessage(java.lang.String message)

pluginUpdateCheckComplete

public void pluginUpdateCheckComplete(java.util.List<UpdateChecker.PluginUpdate> newUpdates,
                             boolean force)

Specified by:

pluginUpdateCheckComplete in interface UpdateCheckCallback

addPluginUpdateListener

public void addPluginUpdateListener(PluginUpdateListener listener)

getUpdates

public FutureValue<java.util.Collection<UpdateChecker.PluginUpdate>> getUpdates()

getRegisteredClouds

public java.util.Map<java.lang.String,CloudPlugin> getRegisteredClouds()

registerBugCategory

public boolean registerBugCategory(BugCategory bc)

Set the metadata for a bug category. If the category's metadata has already been set, this does nothing.

Parameters:

bc - the BugCategory object holding the metadata for the category

Returns:

false if the category's metadata has already been set, true otherwise

unRegisterBugCategory

protected boolean unRegisterBugCategory(BugCategory bc)

registerBugPattern

public void registerBugPattern(BugPattern bugPattern)

Register a BugPattern.

Parameters:

bugPattern - the BugPattern

unRegisterBugPattern

protected void unRegisterBugPattern(BugPattern bugPattern)

bugPatternIterator

public java.util.Iterator<BugPattern> bugPatternIterator()

Get an Iterator over all registered bug patterns.

getBugPatterns

public java.util.Collection<BugPattern> getBugPatterns()

Get an Iterator over all registered bug patterns.

lookupBugPattern

@CheckForNull
public BugPattern lookupBugPattern(java.lang.String bugType)

Look up bug pattern.

Parameters:

bugType - the bug type for the bug pattern

Returns:

the BugPattern, or null if it can't be found

registerBugCode

public void registerBugCode(BugCode bugCode)

unRegisterBugCode

protected void unRegisterBugCode(BugCode bugCode)

getBugCodes

public java.util.Collection<BugCode> getBugCodes()

getBugCode

@Nonnull
public BugCode getBugCode(java.lang.String shortBugType)

Get a description for given "bug type". FIXME: this is referred to elsewhere as the "bug code" or "bug abbrev". Should make the terminology consistent everywhere. In this case, the bug type refers to the short prefix code prepended to the long and short bug messages.

Parameters:

shortBugType - the short bug type code

Returns:

the description of that short bug type code means

lookupBugCode

@CheckForNull
public BugCode lookupBugCode(java.lang.String shortBugType)

Parameters:

shortBugType - the short bug type code

Returns:

the description of that short bug type code means

getBugCategory

public BugCategory getBugCategory(java.lang.String category)

Get the BugCategory object for a category key. Returns null if no BugCategory object can be found.

Parameters:

category - the category key

Returns:

the BugCategory object (may be null)

getBugCategories

public java.util.Collection<java.lang.String> getBugCategories()

Get a Collection containing all known bug category keys. E.g., "CORRECTNESS", "MT_CORRECTNESS", "PERFORMANCE", etc. Excludes hidden bug categories

Returns:

Collection of bug category keys.

getBugCategoryObjects

public java.util.Collection<BugCategory> getBugCategoryObjects()

getUpdateChecker

public UpdateChecker getUpdateChecker()