|
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.DetectorFactory
public class DetectorFactory
A DetectorFactory is responsible for creating instances of Detector objects and for maintaining meta-information about the detector class.
Detector
Constructor Summary | |
---|---|
DetectorFactory(Plugin plugin,
java.lang.Class<?> detectorClass,
boolean enabled,
java.lang.String speed,
java.lang.String reports,
java.lang.String requireJRE)
Constructor. |
Method Summary | |
---|---|
Detector |
create(BugReporter bugReporter)
Deprecated. Use createDetector2 in new code |
Detector2 |
createDetector2(BugReporter bugReporter)
Create a Detector2 instance. |
java.lang.String |
getDetailHTML()
Get an HTML document describing the Detector. |
java.lang.String |
getFullName()
Get the full name of the detector. |
Plugin |
getPlugin()
Get the Plugin that this Detector is part of. |
int |
getPositionSpecifiedInPluginDescriptor()
Get the overall position in which this detector was specified in the plugin descriptor. |
int |
getPriorityAdjustment()
Get the priority adjustment for the detector produced by this factory. |
java.lang.String |
getReportedBugPatternCodes()
Get list of bug pattern codes reported by the detector: blank if unknown. |
java.util.Set<BugPattern> |
getReportedBugPatterns()
Get set of all BugPatterns this detector reports. |
java.lang.String |
getShortName()
Get the short name of the Detector. |
java.lang.String |
getSpeed()
Get the speed of the Detector produced by this factory. |
boolean |
isDefaultEnabled()
Is this factory enabled by default |
boolean |
isDetectorClassSubtypeOf(java.lang.Class<?> otherClass)
Determine whether the detector class is a subtype of the given class (or interface). |
boolean |
isEnabledForCurrentJRE()
Check to see if we are running on a recent-enough JRE for this detector to be enabled. |
boolean |
isHidden()
Get visibility of the factory (to GUI dialogs to configure detectors). |
boolean |
isReportingDetector()
Return whether or not this DetectorFactory produces detectors which report warnings. |
void |
setDetailHTML(java.lang.String detailHTML)
Set the HTML document describing the Detector. |
void |
setEnabledButNonReporting(boolean notReporting)
|
void |
setHidden(boolean hidden)
Set visibility of the factory (to GUI dialogs to configure detectors). |
void |
setPositionSpecifiedInPluginDescriptor(int positionSpecifiedInPluginDescriptor)
Set the overall position in which this detector was specified in the plugin descriptor. |
void |
setPriorityAdjustment(int priorityAdjustment)
Set the priority adjustment for the detector produced by this factory. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DetectorFactory(Plugin plugin, java.lang.Class<?> detectorClass, boolean enabled, java.lang.String speed, java.lang.String reports, java.lang.String requireJRE)
plugin
- the Plugin the Detector is part ofdetectorClass
- the Class object of the Detectorenabled
- true if the Detector is enabled by default, false if disabledspeed
- a string describing roughly how expensive the analysis performed
by the detector is; suggested values are "fast", "moderate", and "slow"reports
- comma separated list of bug pattern codes reported
by the detector; empty if unknownrequireJRE
- string describing JRE version required to run the
the detector: e.g., "1.5"Method Detail |
---|
public void setPositionSpecifiedInPluginDescriptor(int positionSpecifiedInPluginDescriptor)
positionSpecifiedInPluginDescriptor
- position in plugin descriptorpublic int getPositionSpecifiedInPluginDescriptor()
public Plugin getPlugin()
public boolean isDetectorClassSubtypeOf(java.lang.Class<?> otherClass)
otherClass
- a class or interface
public boolean isReportingDetector()
public boolean isEnabledForCurrentJRE()
public void setHidden(boolean hidden)
hidden
- true if this factory should be hidden, false if notpublic boolean isHidden()
public boolean isDefaultEnabled()
public void setPriorityAdjustment(int priorityAdjustment)
priorityAdjustment
- the priority adjustmentpublic void setEnabledButNonReporting(boolean notReporting)
public int getPriorityAdjustment()
public java.lang.String getSpeed()
public java.lang.String getReportedBugPatternCodes()
public java.util.Set<BugPattern> getReportedBugPatterns()
public java.lang.String getDetailHTML()
public void setDetailHTML(java.lang.String detailHTML)
@Deprecated public Detector create(BugReporter bugReporter)
bugReporter
- the BugReporter to be used to report bugs
public Detector2 createDetector2(BugReporter bugReporter)
bugReporter
- the BugReporter to be used to report bugs
public java.lang.String getShortName()
public java.lang.String getFullName()
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |