public class FindbugsReportGenerator extends Object implements groovy.lang.GroovyObject, FindBugsInfo
BUNDLE_NAME, DESCRIPTION_KEY, findbugsEfforts, findbugsPriority, findbugsThresholds, JAVA_REGEX_PATTERN, JAVA_SOURCES_KEY, PLUGIN_NAME, SOURCE_ROOT_KEY, TEST_SOURCE_ROOT_KEY
Constructor and Description |
---|
FindbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink,
ResourceBundle bundle,
File basedir,
org.apache.maven.doxia.tools.SiteTool siteTool)
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected String |
assembleJxrHyperlink(groovy.util.slurpersupport.GPathResult line)
Assembles the hyperlink to point to the source code.
|
void |
generateReport() |
File |
getBasedir() |
List |
getBugClasses() |
int |
getBugCount() |
ResourceBundle |
getBundle() |
static String |
getCOLUMN_BUG_KEY() |
static String |
getCOLUMN_BUGS_KEY() |
static String |
getCOLUMN_CATEGORY_KEY() |
static String |
getCOLUMN_CLASS_KEY() |
static String |
getCOLUMN_CLASSES_KEY() |
static String |
getCOLUMN_DETAILS_KEY() |
static String |
getCOLUMN_ERRORS_KEY() |
static String |
getCOLUMN_FILES_KEY() |
static String |
getCOLUMN_LINE_KEY() |
static String |
getCOLUMN_MISSINGCLASSES_KEY() |
static String |
getCOLUMN_PRIORITY_KEY() |
List |
getCompileSourceRoots() |
String |
getCurrentClassName() |
static String |
getDETAILSLINK_KEY() |
static String |
getEFFORT_KEY() |
String |
getEffort() |
int |
getErrorCount() |
int |
getFileCount() |
static String |
getFILES_KEY() |
groovy.util.slurpersupport.GPathResult |
getFindbugsResults() |
boolean |
getIncludeTests() |
boolean |
getIsJXRReportEnabled() |
static String |
getLINK_KEY() |
static String |
getLINKTITLE_KEY() |
org.apache.maven.plugin.logging.Log |
getLog() |
groovy.lang.MetaClass |
getMetaClass() |
boolean |
getMIsCurrentClassReportOpened() |
int |
getMissingClassCount() |
Set |
getMissingClassSet() |
static String |
getNAME_KEY() |
static String |
getNOLINE_KEY() |
File |
getOutputDirectory() |
Object |
getProperty(String name) |
static String |
getREPORT_TITLE_KEY() |
protected String |
getReportTitle()
Gets the report title.
|
org.apache.maven.doxia.sink.Sink |
getSink() |
org.apache.maven.doxia.tools.SiteTool |
getSiteTool() |
static String |
getSUMMARY_KEY() |
List |
getTestSourceRoots() |
static String |
getTHRESHOLD_KEY() |
String |
getThreshold() |
static String |
getURL_SEPARATOR() |
static String |
getVERSIONTITLE_KEY() |
File |
getXrefLocation() |
File |
getXrefTestLocation() |
Object |
invokeMethod(String name,
Object args) |
boolean |
isIncludeTests() |
boolean |
isIsJXRReportEnabled() |
boolean |
isMIsCurrentClassReportOpened() |
protected void |
openClassReportSection(String bugClass)
Initialised a bug report section in the report for a particular class.
|
void |
printBody() |
protected void |
printBug(String bugClass)
Print the bug collection to a line in the table
|
protected void |
printFilesSummary()
Print the File Summary Section.
|
protected void |
printSummary()
Print the Summary Section.
|
void |
setBasedir(File value) |
void |
setBugClasses(List value) |
void |
setBugCount(int value) |
void |
setBundle(ResourceBundle value) |
void |
setCompileSourceRoots(List value) |
void |
setCurrentClassName(String value) |
void |
setEffort(String value) |
void |
setErrorCount(int value) |
void |
setFileCount(int value) |
void |
setFindbugsResults(groovy.util.slurpersupport.GPathResult value) |
void |
setIncludeTests(boolean value) |
void |
setIsJXRReportEnabled(boolean value) |
void |
setLog(org.apache.maven.plugin.logging.Log value) |
void |
setMetaClass(groovy.lang.MetaClass metaClass) |
void |
setMIsCurrentClassReportOpened(boolean value) |
void |
setMissingClassCount(int value) |
void |
setMissingClassSet(Set value) |
void |
setOutputDirectory(File value) |
void |
setProperty(String name,
Object value) |
void |
setSink(org.apache.maven.doxia.sink.Sink value) |
void |
setSiteTool(org.apache.maven.doxia.tools.SiteTool value) |
void |
setTestSourceRoots(List value) |
void |
setThreshold(String value) |
void |
setXrefLocation(File value) |
void |
setXrefTestLocation(File value) |
protected String |
valueForLine(groovy.util.slurpersupport.GPathResult line)
Return the value to display.
|
public FindbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, File basedir, org.apache.maven.doxia.tools.SiteTool siteTool)
sink
- The sink to generate the report.bundle
- The resource bundle to get the messages from.basedir
- The project base directory.siteTool
- Doxia SiteTool Handle.public static final String getNOLINE_KEY()
public static final String getCOLUMN_LINE_KEY()
public static final String getCOLUMN_BUG_KEY()
public static final String getCOLUMN_BUGS_KEY()
public static final String getCOLUMN_CATEGORY_KEY()
public static final String getCOLUMN_PRIORITY_KEY()
public static final String getCOLUMN_DETAILS_KEY()
public static final String getREPORT_TITLE_KEY()
public static final String getLINKTITLE_KEY()
public static final String getLINK_KEY()
public static final String getNAME_KEY()
public static final String getFILES_KEY()
public static final String getTHRESHOLD_KEY()
public static final String getURL_SEPARATOR()
public static final String getEFFORT_KEY()
public static final String getDETAILSLINK_KEY()
public static final String getVERSIONTITLE_KEY()
public static final String getSUMMARY_KEY()
public static final String getCOLUMN_CLASS_KEY()
public static final String getCOLUMN_CLASSES_KEY()
public static final String getCOLUMN_ERRORS_KEY()
public static final String getCOLUMN_FILES_KEY()
public static final String getCOLUMN_MISSINGCLASSES_KEY()
public org.apache.maven.doxia.sink.Sink getSink()
public void setSink(org.apache.maven.doxia.sink.Sink value)
public ResourceBundle getBundle()
public void setBundle(ResourceBundle value)
public org.apache.maven.plugin.logging.Log getLog()
public void setLog(org.apache.maven.plugin.logging.Log value)
public String getThreshold()
public void setThreshold(String value)
public String getEffort()
public void setEffort(String value)
public String getCurrentClassName()
public void setCurrentClassName(String value)
public boolean getMIsCurrentClassReportOpened()
public boolean isMIsCurrentClassReportOpened()
public void setMIsCurrentClassReportOpened(boolean value)
public boolean getIsJXRReportEnabled()
public boolean isIsJXRReportEnabled()
public void setIsJXRReportEnabled(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 Set getMissingClassSet()
public void setMissingClassSet(Set value)
public int getErrorCount()
public void setErrorCount(int value)
public File getOutputDirectory()
public void setOutputDirectory(File value)
public File getXrefLocation()
public void setXrefLocation(File value)
public File getXrefTestLocation()
public void setXrefTestLocation(File value)
public List getCompileSourceRoots()
public void setCompileSourceRoots(List value)
public List getTestSourceRoots()
public void setTestSourceRoots(List value)
public boolean getIncludeTests()
public boolean isIncludeTests()
public void setIncludeTests(boolean value)
public org.apache.maven.doxia.tools.SiteTool getSiteTool()
public void setSiteTool(org.apache.maven.doxia.tools.SiteTool value)
public File getBasedir()
public void setBasedir(File value)
public groovy.util.slurpersupport.GPathResult getFindbugsResults()
public void setFindbugsResults(groovy.util.slurpersupport.GPathResult value)
public List getBugClasses()
public void setBugClasses(List value)
public void printBody()
edu.umd.cs.findbugs.BugReporter#finish()
protected void printBug(String bugClass)
bugInstance
- the bug to printprotected String assembleJxrHyperlink(groovy.util.slurpersupport.GPathResult line)
line
- The line number object with the bug.lineNumber
- The line number to show in the hyperlink.protected String getReportTitle()
protected void openClassReportSection(String bugClass)
protected void printSummary()
protected void printFilesSummary()
public void generateReport()
protected String valueForLine(groovy.util.slurpersupport.GPathResult line)
line
- The line to get the value from.public groovy.lang.MetaClass getMetaClass()
getMetaClass
in interface groovy.lang.GroovyObject
public void setMetaClass(groovy.lang.MetaClass metaClass)
setMetaClass
in interface groovy.lang.GroovyObject
public Object invokeMethod(String name, Object args)
invokeMethod
in interface groovy.lang.GroovyObject
public Object getProperty(String name)
getProperty
in interface groovy.lang.GroovyObject
Copyright © 2005-2012 Codehaus. All Rights Reserved.