|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.Plugin
public class Plugin
A FindBugs plugin. A plugin contains executable Detector classes, as well as meta information decribing those detectors (such as human-readable detector and bug descriptions).
PluginLoader
Constructor Summary | |
---|---|
Plugin(java.lang.String pluginId,
PluginLoader pluginLoader)
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. |
java.util.Iterator<BugCode> |
bugCodeIterator()
Get Iterator over BugCode objects in the Plugin. |
java.util.Iterator<BugPattern> |
bugPatternIterator()
Get Iterator over BugPattern objects in the Plugin. |
java.util.Iterator<DetectorFactory> |
detectorFactoryIterator()
Get Iterator over DetectorFactory objects in the Plugin. |
BugRanker |
getBugRanker()
|
java.lang.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(java.lang.String fullName)
Look up a DetectorFactory by full name. |
DetectorFactory |
getFactoryByShortName(java.lang.String shortName)
Look up a DetectorFactory by short name. |
java.lang.String |
getPluginId()
|
PluginLoader |
getPluginLoader()
|
java.lang.String |
getProvider()
Get the plugin provider. |
java.lang.String |
getShortDescription()
Get the plugin short (one-line) description. |
java.lang.String |
getWebsite()
Get the plugin website. |
java.util.Iterator<DetectorOrderingConstraint> |
interPassConstraintIterator()
Return an Iterator over the inter-pass Detector ordering constraints. |
java.util.Iterator<DetectorOrderingConstraint> |
intraPassConstraintIterator()
Return an Iterator over the intra-pass Detector ordering constraints. |
boolean |
isEnabled()
Return whether or not the Plugin is enabled. |
int |
rankBug(BugInstance bug)
|
void |
setBugRanker(BugRanker ranker)
|
void |
setEnabled(boolean enabled)
Set whether or not this Plugin is enabled. |
void |
setEngineRegistrarClass(java.lang.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 |
setProvider(java.lang.String provider)
Set plugin provider. |
void |
setShortDescription(java.lang.String shortDescription)
Set plugin short (one-line) text description. |
void |
setWebsite(java.lang.String website)
Set plugin website. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Plugin(java.lang.String pluginId, PluginLoader pluginLoader)
pluginId
- the plugin's unique identifierMethod Detail |
---|
public void setEnabled(boolean enabled)
enabled
- true if the Plugin is enabled, false if notpublic boolean isEnabled()
public void setProvider(java.lang.String provider)
provider
- the plugin providerpublic java.lang.String getProvider()
public void setWebsite(java.lang.String website)
website
- the plugin websitepublic java.lang.String getWebsite()
public void setShortDescription(java.lang.String shortDescription)
shortDescription
- the plugin short text descriptionpublic java.lang.String getShortDescription()
public void addDetectorFactory(DetectorFactory factory)
factory
- the DetectorFactorypublic void addBugPattern(BugPattern bugPattern)
bugPattern
- public void addBugCode(BugCode bugCode)
bugCode
- public void addInterPassOrderingConstraint(DetectorOrderingConstraint constraint)
constraint
- the inter-pass Detector ordering constraintpublic void addIntraPassOrderingConstraint(DetectorOrderingConstraint constraint)
constraint
- the intra-pass Detector ordering constraintpublic DetectorFactory getFactoryByShortName(java.lang.String shortName)
shortName
- the short name
public DetectorFactory getFactoryByFullName(java.lang.String fullName)
fullName
- the full name
public java.util.Iterator<DetectorFactory> detectorFactoryIterator()
public java.util.Iterator<BugPattern> bugPatternIterator()
public java.util.Iterator<BugCode> bugCodeIterator()
public java.util.Iterator<DetectorOrderingConstraint> interPassConstraintIterator()
public java.util.Iterator<DetectorOrderingConstraint> intraPassConstraintIterator()
public java.lang.String getPluginId()
public void setEngineRegistrarClass(java.lang.Class<? extends IAnalysisEngineRegistrar> engineRegistrarClass)
engineRegistrarClass
- The engine registrar class to set.public java.lang.Class<? extends IAnalysisEngineRegistrar> getEngineRegistrarClass()
public PluginLoader getPluginLoader()
public void setBugRanker(BugRanker ranker)
ranker
- public BugRanker getBugRanker()
public int rankBug(BugInstance bug)
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |