|
|||||||||
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
Field Summary | |
---|---|
private static java.lang.Class[] |
constructorArgTypes
|
private boolean |
defEnabled
|
private java.lang.String |
detailHTML
|
private java.lang.Class |
detectorClass
|
private boolean |
enabled
|
private boolean |
firstInPass
|
private boolean |
hidden
|
private Plugin |
plugin
|
private int |
priorityAdjustment
|
private java.lang.String |
reports
|
private java.lang.String |
requireJRE
|
private java.lang.String |
speed
|
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)
Create a Detector 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 |
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.Collection<BugPattern> |
getReportedBugPatterns()
Get Collection 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 |
isEnabled()
Return whether the factory is enabled. |
boolean |
isFirstInPass()
Return whether or not this detector needs to be first in its analysis pass. |
boolean |
isHidden()
Get visibility of the factory (to GUI dialogs to configure detectors). |
void |
setDetailHTML(java.lang.String detailHTML)
Set the HTML document describing the Detector. |
void |
setEnabled(boolean enabled)
Set the enabled status of the factory. |
void |
setFirstInPass(boolean firstInPass)
Mark whether or not this detector needs to be first in its analysis pass. |
void |
setHidden(boolean hidden)
Set visibility of the factory (to GUI dialogs to configure detectors). |
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 |
Field Detail |
---|
private Plugin plugin
private final java.lang.Class detectorClass
private boolean enabled
private boolean defEnabled
private final java.lang.String speed
private final java.lang.String reports
private final java.lang.String requireJRE
private java.lang.String detailHTML
private int priorityAdjustment
private boolean hidden
private boolean firstInPass
private static final java.lang.Class[] constructorArgTypes
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 Plugin getPlugin()
public boolean isEnabled()
public void setHidden(boolean hidden)
hidden
- true if this factory should be hidden, false if notpublic boolean isHidden()
public void setEnabled(boolean enabled)
public boolean isDefaultEnabled()
public void setPriorityAdjustment(int priorityAdjustment)
priorityAdjustment
- the priority adjustmentpublic int getPriorityAdjustment()
public void setFirstInPass(boolean firstInPass)
firstInPass
- true if the detector should be first in its pass,
false if it does notpublic boolean isFirstInPass()
public java.lang.String getSpeed()
public java.lang.String getReportedBugPatternCodes()
public java.util.Collection<BugPattern> getReportedBugPatterns()
public java.lang.String getDetailHTML()
public void setDetailHTML(java.lang.String detailHTML)
public Detector create(BugReporter bugReporter)
bugReporter
- the BugReported to be used to report bugs
public java.lang.String getShortName()
public java.lang.String getFullName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |