SpotbugsReportGenerator (spotbugs-maven-plugin Groovy Documentation)

org.codehaus.mojo.spotbugs.SpotbugsReportGenerator

All Implemented Interfaces and Traits:

SpotBugsInfo
```
class SpotbugsReportGenerator
extends java.lang.Object
implements SpotBugsInfo
```
The reporter controls the generation of the SpotBugs report. It contains call back methods which gets called by SpotBugs if a bug is found.

Field Summary

Fields
Modifiers	Name	Description
`private static java.util.regex.Pattern`	`INNER_CLASS_PATTERN`	Pre-compiled pattern for removing inner class suffixes.

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`COLUMN_BUGS_KEY` The key to get the column title for the bugs.
`static java.lang.String`	`COLUMN_BUG_KEY` The key to get the column title for the bug.
`static java.lang.String`	`COLUMN_CATEGORY_KEY` The key to get the column title for the category.
`static java.lang.String`	`COLUMN_CLASSES_KEY` The key to column title for the Classes.
`static java.lang.String`	`COLUMN_CLASS_KEY` The key to column title for the Class.
`static java.lang.String`	`COLUMN_DETAILS_KEY` The key to get the column title for the details.
`static java.lang.String`	`COLUMN_ERRORS_KEY` The key to column title for the errors.
`static java.lang.String`	`COLUMN_FILES_KEY` The key to column title for the files.
`static java.lang.String`	`COLUMN_LINE_KEY` The key to get the column title for the line.
`static java.lang.String`	`COLUMN_MISSINGCLASSES_KEY` The key to column title for the files.
`static java.lang.String`	`COLUMN_PRIORITY_KEY` The key to get the column title for the priority.
`static java.lang.String`	`DETAILSLINK_KEY` The key to get the link to SpotBugs description page from the bundle.
`static java.lang.String`	`EFFORT_KEY` The key to get the effort of the report from the bundle.
`static java.lang.String`	`FILES_KEY` The key to get the files title of the Plug-In from the bundle.
`static java.lang.String`	`LINKTITLE_KEY` The key to get the report link title of the Plug-In from the bundle.
`static java.lang.String`	`LINK_KEY` The key to get the report link of the Plug-In from the bundle.
`static java.lang.String`	`NOLINE_KEY` The key to get the value if the line number is not available.
`static java.lang.String`	`REPORT_TITLE_KEY` The key to get the report title of the Plug-In from the bundle.
`static java.lang.String`	`SUMMARY_KEY` The key to get the files title of the Plug-In from the bundle.
`static java.lang.String`	`THRESHOLD_KEY` The key to get the threshold of the report from the bundle.
`static java.lang.String`	`VERSIONTITLE_KEY` The key to get the version title for SpotBugs from the bundle.
`java.util.List<java.lang.String>`	`bugClasses` Bug classes.
`int`	`bugCount` The running total of bugs reported.
`java.util.ResourceBundle`	`bundle` The bundle to get the messages from.
`java.util.List<java.lang.String>`	`compileSourceRoots` The directories containing the sources to be compiled.
`java.lang.String`	`currentClassName` The name of the current class which is analysed by SpotBugs.
`java.lang.String`	`effort` The used effort for searching bugs.
`int`	`errorCount` The running total of errors reported.
`int`	`fileCount` The running total of files analyzed.
`boolean`	`includeTests` Run Spotbugs on the tests.
`boolean`	`isJXRReportEnabled` Signals if the jxr report plugin is enabled.
`Log`	`log` The logger to write logs to.
`int`	`missingClassCount` The running total of missing classes reported.
`java.util.Set`	`missingClassSet` The Set of missing classes names reported.
`java.io.File`	`outputDirectory` Location where generated html will be created.
`org.apache.maven.doxia.sink.Sink`	`sink` The sink to write the report to.
`groovy.xml.slurpersupport.GPathResult`	`spotbugsResults` Spotbugs results.
`java.util.List<java.lang.String>`	`testSourceRoots` The directories containing the test-sources to be compiled.
`java.lang.String`	`threshold` The threshold of bugs severity.
`java.io.File`	`xrefLocation` Location of the Xrefs to link to.
`java.io.File`	`xrefTestLocation` Location of the Test Xrefs to link to.

Constructor Summary

Constructors
Constructor and description
`SpotbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink, java.util.ResourceBundle bundle)` Default constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`assembleJxrHyperlink(groovy.xml.slurpersupport.GPathResult line)` Assembles the hyperlink to point to the source code.
	`private void`	`doHeading()` Prints the top header sections of the report.
	`void`	`generateReport()`
	`protected java.lang.String`	`getReportTitle()` Gets the report title.
	`protected void`	`openClassReportSection(java.lang.String bugClass)` Initialized a bug report section in the report for a particular class.
	`void`	`printBody()` See Also: edu.umd.cs.findbugs.BugReporter#finish()
	`protected void`	`printBug(java.lang.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.
	`protected java.lang.String`	`valueForLine(groovy.xml.slurpersupport.GPathResult line)` Return the value to display.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - private static final java.util.regex.Pattern INNER_CLASS_PATTERN
    
    Pre-compiled pattern for removing inner class suffixes.
- Property Detail
  - static final java.lang.String COLUMN_BUGS_KEY
    
    The key to get the column title for the bugs.
  - static final java.lang.String COLUMN_BUG_KEY
    
    The key to get the column title for the bug.
  - static final java.lang.String COLUMN_CATEGORY_KEY
    
    The key to get the column title for the category.
  - static final java.lang.String COLUMN_CLASSES_KEY
    
    The key to column title for the Classes.
  - static final java.lang.String COLUMN_CLASS_KEY
    
    The key to column title for the Class.
  - static final java.lang.String COLUMN_DETAILS_KEY
    
    The key to get the column title for the details.
  - static final java.lang.String COLUMN_ERRORS_KEY
    
    The key to column title for the errors.
  - static final java.lang.String COLUMN_FILES_KEY
    
    The key to column title for the files. note: not used but throughout properties
  - static final java.lang.String COLUMN_LINE_KEY
    
    The key to get the column title for the line.
  - static final java.lang.String COLUMN_MISSINGCLASSES_KEY
    
    The key to column title for the files.
  - static final java.lang.String COLUMN_PRIORITY_KEY
    
    The key to get the column title for the priority.
  - static final java.lang.String DETAILSLINK_KEY
    
    The key to get the link to SpotBugs description page from the bundle.
  - static final java.lang.String EFFORT_KEY
    
    The key to get the effort of the report from the bundle.
  - static final java.lang.String FILES_KEY
    
    The key to get the files title of the Plug-In from the bundle.
  - static final java.lang.String LINKTITLE_KEY
    
    The key to get the report link title of the Plug-In from the bundle.
  - static final java.lang.String LINK_KEY
    
    The key to get the report link of the Plug-In from the bundle.
  - static final java.lang.String NOLINE_KEY
    
    The key to get the value if the line number is not available.
  - static final java.lang.String REPORT_TITLE_KEY
    
    The key to get the report title of the Plug-In from the bundle.
  - static final java.lang.String SUMMARY_KEY
    
    The key to get the files title of the Plug-In from the bundle.
  - static final java.lang.String THRESHOLD_KEY
    
    The key to get the threshold of the report from the bundle.
  - static final java.lang.String VERSIONTITLE_KEY
    
    The key to get the version title for SpotBugs from the bundle.
  - java.util.List<java.lang.String> bugClasses
    
    Bug classes.
  - int bugCount
    
    The running total of bugs reported.
  - java.util.ResourceBundle bundle
    
    The bundle to get the messages from.
  - java.util.List<java.lang.String> compileSourceRoots
    
    The directories containing the sources to be compiled.
  - java.lang.String currentClassName
    
    The name of the current class which is analysed by SpotBugs.
  - java.lang.String effort
    
    The used effort for searching bugs.
  - int errorCount
    
    The running total of errors reported.
  - int fileCount
    
    The running total of files analyzed.
  - boolean includeTests
    
    Run Spotbugs on the tests.
  - boolean isJXRReportEnabled
    
    Signals if the jxr report plugin is enabled.
  - Log log
    
    The logger to write logs to.
  - int missingClassCount
    
    The running total of missing classes reported.
  - java.util.Set missingClassSet
    
    The Set of missing classes names reported.
  - java.io.File outputDirectory
    
    Location where generated html will be created.
  - org.apache.maven.doxia.sink.Sink sink
    
    The sink to write the report to.
  - groovy.xml.slurpersupport.GPathResult spotbugsResults
    
    Spotbugs results.
  - java.util.List<java.lang.String> testSourceRoots
    
    The directories containing the test-sources to be compiled.
  - java.lang.String threshold
    
    The threshold of bugs severity.
  - java.io.File xrefLocation
    
    Location of the Xrefs to link to.
  - java.io.File xrefTestLocation
    
    Location of the Test Xrefs to link to.
- Constructor Detail
  - SpotbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink, java.util.ResourceBundle bundle)
    
    Default constructor.
    Parameters:
    sink - The sink to generate the report.
    bundle - The resource bundle to get the messages from.
- Method Detail
  - protected java.lang.String assembleJxrHyperlink(groovy.xml.slurpersupport.GPathResult line)
    
    Assembles the hyperlink to point to the source code.
    Parameters:
    line - The line number object with the bug.
    lineNumber - The line number to show in the hyperlink.
    Returns:
    The hyperlink which points to the code.
  - private void doHeading()
    
    Prints the top header sections of the report.
  - void generateReport()
  - protected java.lang.String getReportTitle()
    
    Gets the report title.
    Returns:
    The report title.
  - protected void openClassReportSection(java.lang.String bugClass)
    
    Initialized a bug report section in the report for a particular class.
  - void printBody()
    
    See Also:
    edu.umd.cs.findbugs.BugReporter#finish()
  - protected void printBug(java.lang.String bugClass)
    
    Print the bug collection to a line in the table
    Parameters:
    bugInstance - the bug to print
  - protected void printFilesSummary()
    
    Print the File Summary Section.
  - protected void printSummary()
    
    Print the Summary Section.
  - protected java.lang.String valueForLine(groovy.xml.slurpersupport.GPathResult line)
    
    Return the value to display. If SpotBugs does not provide a line number, a default message is returned. The line number otherwise.
    Parameters:
    line - The line to get the value from.
    Returns:
    The line number the bug appears or a statement that there is no source line available.

Summary:
Field
Property
Constructor
Method

spotbugs-maven-plugin Groovy Documentation

[Groovy] Class SpotbugsReportGenerator

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final java.util.regex.Pattern INNER_CLASS_PATTERN

Property Detail

static final java.lang.String COLUMN_BUGS_KEY

static final java.lang.String COLUMN_BUG_KEY

static final java.lang.String COLUMN_CATEGORY_KEY

static final java.lang.String COLUMN_CLASSES_KEY

static final java.lang.String COLUMN_CLASS_KEY

static final java.lang.String COLUMN_DETAILS_KEY

static final java.lang.String COLUMN_ERRORS_KEY

static final java.lang.String COLUMN_FILES_KEY

static final java.lang.String COLUMN_LINE_KEY

static final java.lang.String COLUMN_MISSINGCLASSES_KEY

static final java.lang.String COLUMN_PRIORITY_KEY

static final java.lang.String DETAILSLINK_KEY

static final java.lang.String EFFORT_KEY

static final java.lang.String FILES_KEY

static final java.lang.String LINKTITLE_KEY

static final java.lang.String LINK_KEY

static final java.lang.String NOLINE_KEY

static final java.lang.String REPORT_TITLE_KEY

static final java.lang.String SUMMARY_KEY

static final java.lang.String THRESHOLD_KEY

static final java.lang.String VERSIONTITLE_KEY

java.util.List<java.lang.String> bugClasses

int bugCount

java.util.ResourceBundle bundle

java.util.List<java.lang.String> compileSourceRoots

java.lang.String currentClassName

java.lang.String effort

int errorCount

int fileCount

boolean includeTests

boolean isJXRReportEnabled

Log log

int missingClassCount

java.util.Set missingClassSet

java.io.File outputDirectory

org.apache.maven.doxia.sink.Sink sink

groovy.xml.slurpersupport.GPathResult spotbugsResults

java.util.List<java.lang.String> testSourceRoots

java.lang.String threshold

java.io.File xrefLocation

java.io.File xrefTestLocation

Constructor Detail

SpotbugsReportGenerator(org.apache.maven.doxia.sink.Sink sink, java.util.ResourceBundle bundle)

Method Detail

protected java.lang.String assembleJxrHyperlink(groovy.xml.slurpersupport.GPathResult line)

private void doHeading()

void generateReport()

protected java.lang.String getReportTitle()

protected void openClassReportSection(java.lang.String bugClass)

void printBody()

protected void printBug(java.lang.String bugClass)

protected void printFilesSummary()

protected void printSummary()

protected java.lang.String valueForLine(groovy.xml.slurpersupport.GPathResult line)