org.codehaus.mojo.spotbugs

Class SpotbugsReportGenerator

java.lang.Object

org.codehaus.mojo.spotbugs.SpotbugsReportGenerator

All Implemented Interfaces:

groovy.lang.GroovyObject, SpotBugsInfo

public class SpotbugsReportGenerator
extends Object
implements SpotBugsInfo, groovy.lang.GroovyObject

Field Summary

Fields inherited from interface org.codehaus.mojo.spotbugs.SpotBugsInfo

BLANK, BUNDLE_NAME, CLASS_SUFFIX, COMMA, DESCRIPTION_KEY, EOL, FORWARD_SLASH, JAVA_REGEX_PATTERN, JAVA_SOURCES_KEY, NAME_KEY, PERIOD, PLUGIN_NAME, SOURCE_ROOT_KEY, spotbugsEfforts, spotbugsPriority, spotbugsThresholds, TEST_SOURCE_ROOT_KEY, URL, URL_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SpotbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, File basedir, org.apache.maven.doxia.tools.SiteTool siteTool)

Method Summary

Modifier and Type	Method and Description
protected String	assembleJxrHyperlink(groovy.util.slurpersupport.GPathResult line)
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()
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	getNOLINE_KEY()
File	getOutputDirectory()
Object	getProperty(String property)
static String	getREPORT_TITLE_KEY()
protected String	getReportTitle()
org.apache.maven.doxia.sink.Sink	getSink()
org.apache.maven.doxia.tools.SiteTool	getSiteTool()
groovy.util.slurpersupport.GPathResult	getSpotbugsResults()
static String	getSUMMARY_KEY()
List	getTestSourceRoots()
static String	getTHRESHOLD_KEY()
String	getThreshold()
static String	getVERSIONTITLE_KEY()
File	getXrefLocation()
File	getXrefTestLocation()
Object	invokeMethod(String method, Object arguments)
boolean	isIncludeTests()
boolean	isIsJXRReportEnabled()
boolean	ismIsCurrentClassReportOpened()
protected void	openClassReportSection(String bugClass)
void	printBody()
protected void	printBug(String bugClass)
protected void	printFilesSummary()
protected void	printSummary()
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	setIncludeTests(boolean value)
void	setIsJXRReportEnabled(boolean value)
void	setLog(org.apache.maven.plugin.logging.Log value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setmIsCurrentClassReportOpened(boolean value)
void	setMissingClassCount(int value)
void	setMissingClassSet(Set value)
void	setOutputDirectory(File value)
void	setProperty(String property, Object value)
void	setSink(org.apache.maven.doxia.sink.Sink value)
void	setSiteTool(org.apache.maven.doxia.tools.SiteTool value)
void	setSpotbugsResults(groovy.util.slurpersupport.GPathResult 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpotbugsReportGenerator

public SpotbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink,
                               ResourceBundle bundle,
                               File basedir,
                               org.apache.maven.doxia.tools.SiteTool siteTool)

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

getNOLINE_KEY

public static String getNOLINE_KEY()

getCOLUMN_LINE_KEY

public static String getCOLUMN_LINE_KEY()

getCOLUMN_BUG_KEY

public static String getCOLUMN_BUG_KEY()

getCOLUMN_BUGS_KEY

public static String getCOLUMN_BUGS_KEY()

getCOLUMN_CATEGORY_KEY

public static String getCOLUMN_CATEGORY_KEY()

getCOLUMN_PRIORITY_KEY

public static String getCOLUMN_PRIORITY_KEY()

getCOLUMN_DETAILS_KEY

public static String getCOLUMN_DETAILS_KEY()

getREPORT_TITLE_KEY

public static String getREPORT_TITLE_KEY()

getLINKTITLE_KEY

public static String getLINKTITLE_KEY()

getLINK_KEY

public static String getLINK_KEY()

getFILES_KEY

public static String getFILES_KEY()

getTHRESHOLD_KEY

public static String getTHRESHOLD_KEY()

getEFFORT_KEY

public static String getEFFORT_KEY()

getDETAILSLINK_KEY

public static String getDETAILSLINK_KEY()

getVERSIONTITLE_KEY

public static String getVERSIONTITLE_KEY()

getSUMMARY_KEY

public static String getSUMMARY_KEY()

getCOLUMN_CLASS_KEY

public static String getCOLUMN_CLASS_KEY()

getCOLUMN_CLASSES_KEY

public static String getCOLUMN_CLASSES_KEY()

getCOLUMN_ERRORS_KEY

public static String getCOLUMN_ERRORS_KEY()

getCOLUMN_FILES_KEY

public static String getCOLUMN_FILES_KEY()

getCOLUMN_MISSINGCLASSES_KEY

public static String getCOLUMN_MISSINGCLASSES_KEY()

getSink

public org.apache.maven.doxia.sink.Sink getSink()

setSink

public void setSink(org.apache.maven.doxia.sink.Sink value)

getBundle

public ResourceBundle getBundle()

setBundle

public void setBundle(ResourceBundle value)

getLog

public org.apache.maven.plugin.logging.Log getLog()

setLog

public void setLog(org.apache.maven.plugin.logging.Log value)

getThreshold

public String getThreshold()

setThreshold

public void setThreshold(String value)

getEffort

public String getEffort()

setEffort

public void setEffort(String value)

getCurrentClassName

public String getCurrentClassName()

setCurrentClassName

public void setCurrentClassName(String value)

getmIsCurrentClassReportOpened

public boolean getmIsCurrentClassReportOpened()

ismIsCurrentClassReportOpened

public boolean ismIsCurrentClassReportOpened()

setmIsCurrentClassReportOpened

public void setmIsCurrentClassReportOpened(boolean value)

getIsJXRReportEnabled

public boolean getIsJXRReportEnabled()

isIsJXRReportEnabled

public boolean isIsJXRReportEnabled()

setIsJXRReportEnabled

public void setIsJXRReportEnabled(boolean value)

getBugCount

public int getBugCount()

setBugCount

public void setBugCount(int value)

getMissingClassCount

public int getMissingClassCount()

setMissingClassCount

public void setMissingClassCount(int value)

getFileCount

public int getFileCount()

setFileCount

public void setFileCount(int value)

getMissingClassSet

public Set getMissingClassSet()

setMissingClassSet

public void setMissingClassSet(Set value)

getErrorCount

public int getErrorCount()

setErrorCount

public void setErrorCount(int value)

getOutputDirectory

public File getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(File value)

getXrefLocation

public File getXrefLocation()

setXrefLocation

public void setXrefLocation(File value)

getXrefTestLocation

public File getXrefTestLocation()

setXrefTestLocation

public void setXrefTestLocation(File value)

getCompileSourceRoots

public List getCompileSourceRoots()

setCompileSourceRoots

public void setCompileSourceRoots(List value)

getTestSourceRoots

public List getTestSourceRoots()

setTestSourceRoots

public void setTestSourceRoots(List value)

getIncludeTests

public boolean getIncludeTests()

isIncludeTests

public boolean isIncludeTests()

setIncludeTests

public void setIncludeTests(boolean value)

getSiteTool

public org.apache.maven.doxia.tools.SiteTool getSiteTool()

setSiteTool

public void setSiteTool(org.apache.maven.doxia.tools.SiteTool value)

getBasedir

public File getBasedir()

setBasedir

public void setBasedir(File value)

getSpotbugsResults

public groovy.util.slurpersupport.GPathResult getSpotbugsResults()

setSpotbugsResults

public void setSpotbugsResults(groovy.util.slurpersupport.GPathResult value)

getBugClasses

public List getBugClasses()

setBugClasses

public void setBugClasses(List value)

printBody

public void printBody()

printBug

protected void printBug(String bugClass)

assembleJxrHyperlink

protected String assembleJxrHyperlink(groovy.util.slurpersupport.GPathResult line)

getReportTitle

protected String getReportTitle()

openClassReportSection

protected void openClassReportSection(String bugClass)

printSummary

protected void printSummary()

printFilesSummary

protected void printFilesSummary()

generateReport

public void generateReport()

valueForLine

protected String valueForLine(groovy.util.slurpersupport.GPathResult line)