edu.umd.cs.findbugs
public class Plugin extends Object
See Also: PluginLoader
Constructor Summary | |
---|---|
Plugin(String pluginId)
Constructor.
|
Method Summary | |
---|---|
void | addBugCode(BugCode bugCode)
Add a BugCode reported by the Plugin.
|
void | addBugPattern(BugPattern bugPattern)
Add a BugPattern reported by the Plugin.
|
void | addDetectorFactory(DetectorFactory factory)
Add a DetectorFactory for a Detector implemented by the Plugin.
|
void | addInterPassOrderingConstraint(DetectorOrderingConstraint constraint)
Add an inter-pass Detector ordering constraint.
|
void | addIntraPassOrderingConstraint(DetectorOrderingConstraint constraint)
Add an intra-pass Detector ordering constraint.
|
Iterator<BugCode> | bugCodeIterator()
Get Iterator over BugCode objects in the Plugin.
|
Iterator<BugPattern> | bugPatternIterator()
Get Iterator over BugPattern objects in the Plugin.
|
Iterator<DetectorFactory> | detectorFactoryIterator()
Get Iterator over DetectorFactory objects in the Plugin.
|
DetectorFactory | getFactoryByFullName(String fullName)
Look up a DetectorFactory by full name.
|
DetectorFactory | getFactoryByShortName(String shortName)
Look up a DetectorFactory by short name.
|
String | getPluginId() |
String | getProvider()
Get the plugin provider.
|
String | getShortDescription()
Get the plugin short (one-line) description.
|
String | getWebsite()
Get the plugin website.
|
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 | isEnabled()
Return whether or not the Plugin is enabled.
|
void | setEnabled(boolean enabled)
Set whether or not this Plugin is enabled.
|
void | setProvider(String provider)
Set plugin provider.
|
void | setShortDescription(String shortDescription)
Set plugin short (one-line) text description.
|
void | setWebsite(String website)
Set plugin website.
|
Parameters: pluginId the plugin's unique identifier
Parameters: bugCode
Parameters: bugPattern
Parameters: factory the DetectorFactory
Parameters: constraint the inter-pass Detector ordering constraint
Parameters: constraint the intra-pass Detector ordering constraint
Returns: Iterator over BugCode objects
Returns: Iterator over BugPattern objects
Returns: Iterator over DetectorFactory objects
Parameters: fullName the full name
Returns: the DetectorFactory
Parameters: shortName the short name
Returns: the DetectorFactory
Returns: Returns the pluginId.
Returns: the provider, or null if the provider was not specified
Returns: the short description, or null if the short description was not specified
Returns: the website, or null if the was not specified
Returns: true if the Plugin is enabled, false if not
Parameters: enabled true if the Plugin is enabled, false if not
Parameters: provider the plugin provider
Parameters: shortDescription the plugin short text description
Parameters: website the plugin website