Class Plugin

java.lang.Object

edu.umd.cs.findbugs.Plugin

All Implemented Interfaces:

AutoCloseable

public class Plugin
extends Object
implements AutoCloseable

A FindBugs plugin. A plugin contains executable Detector classes, as well as meta information describing those detectors (such as human-readable detector and bug descriptions).

See Also:

• PluginLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	Plugin.EnabledState
private static interface	Plugin.FactoryChooser

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static Map<URI,Plugin>	allPlugins
private final LinkedHashMap<String, BugCategory>	bugCategories
private final LinkedHashSet<BugCode>	bugCodeList
private final LinkedHashSet<BugPattern>	bugPatterns
private BugRanker	bugRanker
private final boolean	cannotDisable
private final DualKeyHashMap<Class<?>, String, ComponentPlugin<?>>	componentPlugins
private String	detailedDescription
private final List<DetectorFactory>	detectorFactoryList
private Plugin.EnabledState	enabled
private final boolean	enabledByDefault
private Class<? extends IAnalysisEngineRegistrar>	engineRegistrarClass
private final List<DetectorOrderingConstraint>	interPassConstraintList
private final List<DetectorOrderingConstraint>	intraPassConstraintList
private final Map<String, FindBugsMain>	mainPlugins
private final HashMap<String,String>	myGlobalOptions
private final String	pluginId
private final PluginLoader	pluginLoader
private String	provider
private final Date	releaseDate
private String	shortDescription
private @Nullable URI	updateUrl
private static final String	USE_FINDBUGS_VERSION
private final String	version
private URI	website

Constructor Summary

Constructors

Constructor	Description
Plugin(String pluginId, String version, Date releaseDate, @NonNull PluginLoader pluginLoader, boolean enabled, boolean cannotDisable)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addBugCategory(BugCategory bugCategory)	Add a BugCategory reported by the Plugin.
void	addBugCode(BugCode bugCode)	Add a BugCode reported by the Plugin.
void	addBugPattern(BugPattern bugPattern)	Add a BugPattern reported by the Plugin.
(package private) <T> void	addComponentPlugin(Class<T> componentKind, ComponentPlugin<T> plugin)
static @Nullable Plugin	addCustomPlugin(URI u)
static @Nullable Plugin	addCustomPlugin(URI u, ClassLoader parent)
static @Nullable Plugin	addCustomPlugin(URL u)
static @Nullable Plugin	addCustomPlugin(URL u, ClassLoader parent)
void	addDetectorFactory(DetectorFactory factory)	Add a DetectorFactory for a Detector implemented by the Plugin.
(package private) <T> void	addFindBugsMain(Class<?> mainClass, String cmd, String description, String kind, boolean analysis)
void	addInterPassOrderingConstraint(DetectorOrderingConstraint constraint)	Add an inter-pass Detector ordering constraint.
void	addIntraPassOrderingConstraint(DetectorOrderingConstraint constraint)	Add an intra-pass Detector ordering constraint.
BugCategory	addOrCreateBugCategory(String id)
boolean	cannotDisable()
void	close()	Closes the underlying PluginLoader, in turn this closes the URLClassLoader.
private @Nullable DetectorFactory	findFirstMatchingFactory(Plugin.FactoryChooser chooser)
Collection<FindBugsMain>	getAllFindBugsMain()
static Collection<String>	getAllPluginIds()
static Collection<Plugin>	getAllPlugins()
static Map<URI,Plugin>	getAllPluginsMap()
static Set<URI>	getAllPluginsURIs()
Collection<BugCategory>	getBugCategories()	Get Iterator over BugCategories objects in the Plugin.
@Nullable BugCategory	getBugCategory(String id)
Set<BugCode>	getBugCodes()	Get Iterator over BugCode objects in the Plugin.
Set<BugPattern>	getBugPatterns()	Get the set of BugPatterns
BugRanker	getBugRanker()
static @Nullable Plugin	getByPluginId(String name)
ClassLoader	getClassLoader()
<T> ComponentPlugin<T>	getComponentPlugin(Class<T> componentClass, String name)
<T> Iterable<ComponentPlugin<T>>	getComponentPlugins(Class<T> componentClass)
String	getDetailedDescription()
Collection<DetectorFactory>	getDetectorFactories()	Get Iterator over DetectorFactory objects in the Plugin.
Class<? extends IAnalysisEngineRegistrar>	getEngineRegistrarClass()	Get the analysis engine registrar class that, when instantiated, can be used to register the plugin's analysis engines with the analysis cache.
DetectorFactory	getFactoryByFullName(String fullName)	Look up a DetectorFactory by full name.
DetectorFactory	getFactoryByShortName(String shortName)	Look up a DetectorFactory by short name.
@Nullable FindBugsMain	getFindBugsMain(String cmd)
(package private) Map<String,String>	getMyGlobalOptions()
@Nullable Plugin	getParentPlugin()
(package private) static @Nullable Plugin	getPlugin(URI uri)
String	getPluginId()
PluginLoader	getPluginLoader()
@Nullable String	getProvider()	Get the plugin provider.
Date	getReleaseDate()
URL	getResource(String name)
String	getShortDescription()
String	getShortPluginId()
@Nullable URI	getUpdateUrl()
String	getVersion()
@Nullable String	getWebsite()	Get the plugin website.
@Nullable URI	getWebsiteURI()
Iterator<DetectorOrderingConstraint>	interPassConstraintIterator()	Return an Iterator over the inter-pass Detector ordering constraints.
Iterator<DetectorOrderingConstraint>	intraPassConstraintIterator()	Return an Iterator over the intra-pass Detector ordering constraints.
boolean	isCorePlugin()
boolean	isEnabledByDefault()	Return whether or not the Plugin is enabled.
boolean	isGloballyEnabled()
boolean	isInitialPlugin()
static Plugin	loadCustomPlugin(File f, @Nullable Project project)	Loads the given plugin and enables it for the given project.
static Plugin	loadCustomPlugin(URL urlString, @Nullable Project project)	Loads the given plugin and enables it for the given project.
(package private) static @Nullable Plugin	putPlugin(URI uri, Plugin plugin)
static void	removeCustomPlugin(Plugin plugin)
static void	removePlugin(URI uri)
void	setBugRanker(BugRanker ranker)
void	setDetailedDescription(String detailedDescription)
void	setEngineRegistrarClass(Class<? extends IAnalysisEngineRegistrar> engineRegistrarClass)	Set the analysis engine registrar class that, when instantiated, can be used to register the plugin's analysis engines with the analysis cache.
void	setGloballyEnabled(boolean enabled)
void	setMyGlobalOption(String key, String value)
void	setProvider(String provider)	Set plugin provider.
void	setShortDescription(String shortDescription)
void	setUpdateUrl(String url)
void	setWebsite(String website)	Set plugin website.
String	toString()

Methods inherited from class Object

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

Field Details

USE_FINDBUGS_VERSION

private static final String USE_FINDBUGS_VERSION

See Also:

• Constant Field Values

allPlugins

static Map<URI,Plugin> allPlugins

pluginId

private final String pluginId

version

private final String version

releaseDate

private final Date releaseDate

provider

private String provider

website

private URI website

updateUrl

private @Nullable URI updateUrl

shortDescription

private String shortDescription

detailedDescription

private String detailedDescription

detectorFactoryList

private final List<DetectorFactory> detectorFactoryList

mainPlugins

private final Map<String, FindBugsMain> mainPlugins

bugPatterns

private final LinkedHashSet<BugPattern> bugPatterns

bugCodeList

private final LinkedHashSet<BugCode> bugCodeList

bugCategories

private final LinkedHashMap<String, BugCategory> bugCategories

myGlobalOptions

private final HashMap<String,String> myGlobalOptions

componentPlugins

private final DualKeyHashMap<Class<?>, String, ComponentPlugin<?>> componentPlugins

bugRanker

private BugRanker bugRanker

interPassConstraintList

private final List<DetectorOrderingConstraint> interPassConstraintList

intraPassConstraintList

private final List<DetectorOrderingConstraint> intraPassConstraintList

engineRegistrarClass

private Class<? extends IAnalysisEngineRegistrar> engineRegistrarClass

pluginLoader

private final PluginLoader pluginLoader

enabledByDefault

private final boolean enabledByDefault

cannotDisable

private final boolean cannotDisable

enabled

private Plugin.EnabledState enabled

Constructor Details

Plugin

public Plugin(String pluginId,
 String version,
 Date releaseDate,
 @NonNull PluginLoader pluginLoader,
 boolean enabled,
 boolean cannotDisable)

Constructor. Creates an empty plugin object.

Parameters:

pluginId - the plugin's unique identifier

Method Details

toString

public String toString()

Overrides:

toString in class Object

isEnabledByDefault

public boolean isEnabledByDefault()

Return whether or not the Plugin is enabled.

Returns:

true if the Plugin is enabled, false if not

setProvider

public void setProvider(String provider)

Set plugin provider.

Parameters:

provider - the plugin provider

getProvider

public @Nullable String getProvider()

Get the plugin provider.

Returns:

the provider, or null if the provider was not specified

setUpdateUrl

public void setUpdateUrl(String url)
                  throws URISyntaxException

Throws:

URISyntaxException

getUpdateUrl

public @Nullable URI getUpdateUrl()

setMyGlobalOption

public void setMyGlobalOption(String key,
 String value)

getMyGlobalOptions

Map<String,String> getMyGlobalOptions()

setWebsite

public void setWebsite(String website)
                throws URISyntaxException

Set plugin website.

Parameters:

website - the plugin website

Throws:

URISyntaxException

getWebsite

public @Nullable String getWebsite()

Get the plugin website.

Returns:

the website, or null if the was not specified

getWebsiteURI

public @Nullable URI getWebsiteURI()

getVersion

public String getVersion()

getReleaseDate

public Date getReleaseDate()

setShortDescription

public void setShortDescription(String shortDescription)

getShortDescription

public String getShortDescription()

getDetailedDescription

public String getDetailedDescription()

setDetailedDescription

public void setDetailedDescription(String detailedDescription)

addDetectorFactory

public void addDetectorFactory(DetectorFactory factory)

Add a DetectorFactory for a Detector implemented by the Plugin.

Parameters:

factory - the DetectorFactory

addBugPattern

public void addBugPattern(BugPattern bugPattern)

Add a BugPattern reported by the Plugin.

Parameters:

bugPattern -

addBugCode

public void addBugCode(BugCode bugCode)

Add a BugCode reported by the Plugin.

Parameters:

bugCode -

addBugCategory

public void addBugCategory(BugCategory bugCategory)

Add a BugCategory reported by the Plugin.

Parameters:

bugCategory -

addOrCreateBugCategory

public BugCategory addOrCreateBugCategory(String id)

addInterPassOrderingConstraint

public void addInterPassOrderingConstraint(DetectorOrderingConstraint constraint)

Add an inter-pass Detector ordering constraint.

Parameters:

constraint - the inter-pass Detector ordering constraint

addIntraPassOrderingConstraint

public void addIntraPassOrderingConstraint(DetectorOrderingConstraint constraint)

Add an intra-pass Detector ordering constraint.

Parameters:

constraint - the intra-pass Detector ordering constraint

getFactoryByShortName

public DetectorFactory getFactoryByShortName(String shortName)

Look up a DetectorFactory by short name.

Parameters:

shortName - the short name

Returns:

the DetectorFactory

getFactoryByFullName

public DetectorFactory getFactoryByFullName(String fullName)

Look up a DetectorFactory by full name.

Parameters:

fullName - the full name

Returns:

the DetectorFactory

getDetectorFactories

public Collection<DetectorFactory> getDetectorFactories()

Get Iterator over DetectorFactory objects in the Plugin.

Returns:

Iterator over DetectorFactory objects

getBugPatterns

public Set<BugPattern> getBugPatterns()

Get the set of BugPatterns

getBugCodes

public Set<BugCode> getBugCodes()

Get Iterator over BugCode objects in the Plugin.

Returns:

Iterator over BugCode objects

getBugCategories

public Collection<BugCategory> getBugCategories()

Get Iterator over BugCategories objects in the Plugin.

Returns:

Iterator over BugCategory objects

getBugCategory

public @Nullable BugCategory getBugCategory(String id)

Parameters:

id - may be null

Returns:

return bug category with given id, may return null if the bug category is unknown

interPassConstraintIterator

public Iterator<DetectorOrderingConstraint> interPassConstraintIterator()

Return an Iterator over the inter-pass Detector ordering constraints.

intraPassConstraintIterator

public Iterator<DetectorOrderingConstraint> intraPassConstraintIterator()

Return an Iterator over the intra-pass Detector ordering constraints.

getPluginId

public String getPluginId()

getShortPluginId

public String getShortPluginId()

setEngineRegistrarClass

public void setEngineRegistrarClass(Class<? extends IAnalysisEngineRegistrar> engineRegistrarClass)

Set the analysis engine registrar class that, when instantiated, can be used to register the plugin's analysis engines with the analysis cache.

Parameters:

engineRegistrarClass - The engine registrar class to set.

getEngineRegistrarClass

public Class<? extends IAnalysisEngineRegistrar> getEngineRegistrarClass()

Get the analysis engine registrar class that, when instantiated, can be used to register the plugin's analysis engines with the analysis cache.

Returns:

Returns the engine registrar class.

getPluginLoader

public PluginLoader getPluginLoader()

findFirstMatchingFactory

private @Nullable DetectorFactory findFirstMatchingFactory(Plugin.FactoryChooser chooser)

setBugRanker

public void setBugRanker(BugRanker ranker)

getBugRanker

public BugRanker getBugRanker()

addFindBugsMain

<T> void addFindBugsMain(Class<?> mainClass,
 String cmd,
 String description,
 String kind,
 boolean analysis)
                  throws SecurityException,
NoSuchMethodException

Throws:

SecurityException

NoSuchMethodException

getFindBugsMain

public @Nullable FindBugsMain getFindBugsMain(String cmd)

getAllFindBugsMain

public Collection<FindBugsMain> getAllFindBugsMain()

addComponentPlugin

<T> void addComponentPlugin(Class<T> componentKind,
 ComponentPlugin<T> plugin)

getComponentPlugins

public <T> Iterable<ComponentPlugin<T>> getComponentPlugins(Class<T> componentClass)

getComponentPlugin

public <T> ComponentPlugin<T> getComponentPlugin(Class<T> componentClass,
 String name)

getByPluginId

public static @Nullable Plugin getByPluginId(String name)

removePlugin

public static void removePlugin(URI uri)

getAllPlugins

public static Collection<Plugin> getAllPlugins()

Returns:

a copy of the internal plugins collection

getAllPluginIds

public static Collection<String> getAllPluginIds()

getAllPluginsMap

public static Map<URI,Plugin> getAllPluginsMap()

Returns:

a copy of the internal plugins collection

getAllPluginsURIs

public static Set<URI> getAllPluginsURIs()

getPlugin

static @Nullable Plugin getPlugin(URI uri)

Returns:

may return null

putPlugin

static @Nullable Plugin putPlugin(URI uri,
 Plugin plugin)

Returns:

may return null

isCorePlugin

public boolean isCorePlugin()

cannotDisable

public boolean cannotDisable()

isGloballyEnabled

public boolean isGloballyEnabled()

setGloballyEnabled

public void setGloballyEnabled(boolean enabled)

isInitialPlugin

public boolean isInitialPlugin()

getResource

public URL getResource(String name)

getClassLoader

public ClassLoader getClassLoader()

getParentPlugin

public @Nullable Plugin getParentPlugin()

loadCustomPlugin

public static Plugin loadCustomPlugin(File f,
 @Nullable Project project)
                               throws PluginException

Loads the given plugin and enables it for the given project.

Parameters:

f - A non-null jar file of custom plugin.

project - A nullable target project

Throws:

PluginException

loadCustomPlugin

public static Plugin loadCustomPlugin(URL urlString,
 @Nullable Project project)
                               throws PluginException

Loads the given plugin and enables it for the given project.

Throws:

PluginException

addCustomPlugin

public static @Nullable Plugin addCustomPlugin(URL u)
                                        throws PluginException

Throws:

PluginException

addCustomPlugin

public static @Nullable Plugin addCustomPlugin(URI u)
                                        throws PluginException

Throws:

PluginException

addCustomPlugin

public static @Nullable Plugin addCustomPlugin(URL u,
 ClassLoader parent)
                                        throws PluginException

Throws:

PluginException

addCustomPlugin

public static @Nullable Plugin addCustomPlugin(URI u,
 ClassLoader parent)
                                        throws PluginException

Throws:

PluginException

removeCustomPlugin

public static void removeCustomPlugin(Plugin plugin)

close

public void close()
           throws IOException

Closes the underlying PluginLoader, in turn this closes the URLClassLoader. When loading a custom plugin from a .jar file this method needs to be called to release the reference on that file.

Specified by:

close in interface AutoCloseable

Throws:

IOException