|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.AbstractBugReporter
edu.umd.cs.findbugs.TextUIBugReporter
org.codehaus.mojo.findbugs.XDocsReporter
public class XDocsReporter
The reporter controls the generation of the FindBugs report. It contains call back methods which gets called by FindBugs if a bug is found.
Field Summary |
---|
Fields inherited from class edu.umd.cs.findbugs.TextUIBugReporter |
---|
outputStream |
Fields inherited from interface edu.umd.cs.findbugs.BugReporter |
---|
NORMAL, SILENT |
Constructor Summary | |
---|---|
XDocsReporter(org.apache.maven.project.MavenProject mavenProject)
Default constructor. |
Method Summary | |
---|---|
protected void |
closeClassReportSection()
Closes the class report section. |
protected void |
doReportBug(edu.umd.cs.findbugs.BugInstance bugInstance)
|
protected String |
evaluateThresholdParameter(int thresholdValue)
Returns the threshold string value for the integer input. |
void |
finish()
|
edu.umd.cs.findbugs.SortedBugCollection |
getBugCollection()
|
int |
getBugCount()
|
String |
getCurrentClassName()
|
EffortParameter |
getEffort()
|
int |
getFileCount()
|
protected String |
getFindBugsVersion()
Gets the Findbugs Version of the report. |
boolean |
getIsCurrentClassReportOpened()
|
org.apache.maven.plugin.logging.Log |
getLog()
|
org.apache.maven.project.MavenProject |
getMavenProject()
|
groovy.lang.MetaClass |
getMetaClass()
|
int |
getMissingClassCount()
|
static String |
getNOLINE_KEY()
|
Writer |
getOutputWriter()
|
Object |
getProperty(String name)
|
ResourceBundle |
getResourceBundle()
|
FindbugsXdocSink |
getSink()
|
ThresholdParameter |
getThreshold()
|
Object |
invokeMethod(String name,
Object args)
|
boolean |
isIsCurrentClassReportOpened()
|
void |
logError(String message)
|
void |
logError(String message,
Throwable e)
|
void |
observeClass(edu.umd.cs.findbugs.classfile.ClassDescriptor classDescriptor)
Observe a class. |
protected void |
printBug(edu.umd.cs.findbugs.BugInstance bugInstance)
Print the bug collection to a line in the table |
protected void |
printErrors()
Closes the class report section. |
protected void |
printSource()
Output Source Directories. |
void |
reportMissingClass(edu.umd.cs.findbugs.classfile.ClassDescriptor classDescriptor)
|
void |
reportMissingClass(ClassNotFoundException ex)
|
void |
setBugCollection(edu.umd.cs.findbugs.SortedBugCollection value)
|
void |
setBugCount(int value)
|
void |
setCurrentClassName(String value)
|
void |
setEffort(EffortParameter value)
|
void |
setFileCount(int value)
|
void |
setIsCurrentClassReportOpened(boolean value)
|
void |
setLog(org.apache.maven.plugin.logging.Log value)
|
void |
setMavenProject(org.apache.maven.project.MavenProject value)
|
void |
setMetaClass(groovy.lang.MetaClass metaClass)
|
void |
setMissingClassCount(int value)
|
void |
setOutputWriter(Writer value)
|
void |
setProperty(String name,
Object value)
|
void |
setResourceBundle(ResourceBundle resourceBundle)
|
void |
setSink(FindbugsXdocSink value)
|
void |
setThreshold(ThresholdParameter value)
|
protected String |
valueForLine(edu.umd.cs.findbugs.SourceLineAnnotation line)
Return the value to display. |
Methods inherited from class edu.umd.cs.findbugs.TextUIBugReporter |
---|
checkBugInstance, emitLine, getRealBugReporter, getUseLongBugCodes, reportAnalysisError, reportMissingClass, reportQueuedErrors, setOutputStream, setReportHistory, setReportStackTrace, setReportUserDesignations, setUseLongBugCodes |
Methods inherited from class edu.umd.cs.findbugs.AbstractBugReporter |
---|
addObserver, getMissingClassName, getProjectStats, notifyObservers, reportBug, reportBugsFromXml, reportSkippedAnalysis, setErrorVerbosity, setPriorityThreshold |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XDocsReporter(org.apache.maven.project.MavenProject mavenProject)
realBugReporter
- the BugReporter to DelegateMethod Detail |
---|
public static final String getNOLINE_KEY()
public void setSink(FindbugsXdocSink value)
public ResourceBundle getResourceBundle()
public org.apache.maven.plugin.logging.Log getLog()
public void setLog(org.apache.maven.plugin.logging.Log value)
public ThresholdParameter getThreshold()
public void setThreshold(ThresholdParameter value)
public EffortParameter getEffort()
public void setEffort(EffortParameter value)
public String getCurrentClassName()
public void setCurrentClassName(String value)
public boolean getIsCurrentClassReportOpened()
public boolean isIsCurrentClassReportOpened()
public void setIsCurrentClassReportOpened(boolean value)
public int getBugCount()
public void setBugCount(int value)
public int getMissingClassCount()
public void setMissingClassCount(int value)
public int getFileCount()
public void setFileCount(int value)
public edu.umd.cs.findbugs.SortedBugCollection getBugCollection()
public void setBugCollection(edu.umd.cs.findbugs.SortedBugCollection value)
public Writer getOutputWriter()
public void setOutputWriter(Writer value)
public org.apache.maven.project.MavenProject getMavenProject()
public void setMavenProject(org.apache.maven.project.MavenProject value)
public void finish()
BugReporter.finish()
public FindbugsXdocSink getSink()
public void logError(String message)
logError
in interface edu.umd.cs.findbugs.classfile.IErrorLogger
logError
in class edu.umd.cs.findbugs.AbstractBugReporter
public void logError(String message, Throwable e)
logError
in interface edu.umd.cs.findbugs.classfile.IErrorLogger
logError
in class edu.umd.cs.findbugs.AbstractBugReporter
public void observeClass(edu.umd.cs.findbugs.classfile.ClassDescriptor classDescriptor)
classDescriptor
- The Class to Observe#observeClass(edu.umd.cs.findbugs.classfile.ClassDescriptor)
public void reportMissingClass(edu.umd.cs.findbugs.classfile.ClassDescriptor classDescriptor)
reportMissingClass
in interface edu.umd.cs.findbugs.classfile.IErrorLogger
reportMissingClass
in class edu.umd.cs.findbugs.AbstractBugReporter
public void reportMissingClass(ClassNotFoundException ex)
reportMissingClass
in interface edu.umd.cs.findbugs.classfile.IErrorLogger
reportMissingClass
in class edu.umd.cs.findbugs.AbstractBugReporter
public void setResourceBundle(ResourceBundle resourceBundle)
resourceBundle
- the resourceBundle to setprotected void printBug(edu.umd.cs.findbugs.BugInstance bugInstance)
printBug
in class edu.umd.cs.findbugs.TextUIBugReporter
bugInstance
- the bug to printprotected void closeClassReportSection()
protected String evaluateThresholdParameter(int thresholdValue)
thresholdValue
- The ThresholdValue integer to evaluate.
protected String getFindBugsVersion()
protected void printErrors()
protected void printSource()
protected String valueForLine(edu.umd.cs.findbugs.SourceLineAnnotation line)
line
- The line to get the value from.
protected void doReportBug(edu.umd.cs.findbugs.BugInstance bugInstance)
doReportBug
in class edu.umd.cs.findbugs.AbstractBugReporter
bugInstance
- The bug to report#doReportBug(edu.umd.cs.findbugs.BugInstance)
public groovy.lang.MetaClass getMetaClass()
public void setMetaClass(groovy.lang.MetaClass metaClass)
public Object invokeMethod(String name, Object args)
public Object getProperty(String name)
public void setProperty(String name, Object value)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |