SpotBugsAggregateMojo (spotbugs-maven-plugin Groovy Documentation)

org.codehaus.mojo.spotbugs.SpotBugsAggregateMojo

```
@org.apache.maven.plugins.annotations.Mojo(name: spotbugs-aggregate, aggregator: true, requiresDependencyResolution: ResolutionScope.TEST, requiresProject: true, threadSafe: true)
class SpotBugsAggregateMojo
extends AbstractMavenReport
```
Generates an aggregate SpotBugs report for multi-module projects when the site plugin is run. The HTML report is generated from the individual SpotBugs XML results of each module. Run spotbugs:spotbugs on each module before using this goal.
Since:
4.9.4.2

Properties Summary

Properties
Type	Name and description
`java.util.ResourceBundle`	`bundle` The resource bundle.
`boolean`	`debug` Turn on Spotbugs debugging.
`java.lang.String`	`effort` Effort of the bug finders.
`java.io.File`	`outputDirectory` Location where the generated HTML aggregate report will be created.
`java.lang.String`	`outputEncoding` The file encoding to use when creating the HTML reports.
`boolean`	`skip` Skip entire check.
`boolean`	`skipEmptyReport` Skip the Spotbugs HTML report generation if there are no violations found.
`java.lang.String`	`spotbugsXmlOutputFilename` Specifies the directory where the Spotbugs native XML output will be generated in each module.
`java.lang.String`	`threshold` Threshold of minimum bug severity to report.

Constructor Summary

Constructors
Constructor and description
`SpotBugsAggregateMojo()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`private java.io.File`	`buildAggregatedXml(java.nio.charset.Charset effectiveEncoding)` Collects and merges SpotBugs XML files from all reactor projects into a single aggregate XML file.
	`boolean`	`canGenerateReport()` Checks whether prerequisites for generating this report are given.
	`void`	`executeReport(java.util.Locale locale)` Executes the generation of the aggregate report.
	`java.util.ResourceBundle`	`getBundle(java.util.Locale locale)`
	`java.lang.String`	`getDescription(java.util.Locale locale)` Returns the plugins description for the "generated reports" overview page.
	`java.lang.String`	`getName(java.util.Locale locale)` Returns the plugins name for the "generated reports" overview page and the menu.
	`protected java.lang.String`	`getOutputDirectory()` Returns the report output directory.
	`java.lang.String`	`getOutputName()` Returns report output file name, without the extension.
	`java.lang.String`	`getOutputPath()` Returns report output file name, without the extension.
	`void`	`setReportOutputDirectory(java.io.File reportOutputDirectory)` Sets the report output directory.

- Property Detail
  - java.util.ResourceBundle bundle
    
    The resource bundle.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.debug)
    boolean debug
    
    Turn on Spotbugs debugging.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)
    java.lang.String effort
    
    Effort of the bug finders. Valid values are Min, Default and Max.
    Since:
    4.9.4.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}, required: true)
    java.io.File outputDirectory
    
    Location where the generated HTML aggregate report will be created.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputEncoding}, property: outputEncoding)
    java.lang.String outputEncoding
    
    The file encoding to use when creating the HTML reports. If the property project.reporting.outputEncoding is not set, utf-8 is used.
    Since:
    4.9.4.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skip)
    boolean skip
    
    Skip entire check.
    Since:
    4.9.4.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skipEmptyReport)
    boolean skipEmptyReport
    
    Skip the Spotbugs HTML report generation if there are no violations found. Defaults to false.
    Since:
    4.9.4.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
    java.lang.String spotbugsXmlOutputFilename
    
    Specifies the directory where the Spotbugs native XML output will be generated in each module. The aggregate mojo looks for this filename in each reactor project's build directory.
    Since:
    4.9.4.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.threshold)
    java.lang.String threshold
    
    Threshold of minimum bug severity to report. Valid values are High, Default, Low, Ignore, and Exp (for experimental).
- Constructor Detail
  - SpotBugsAggregateMojo()
- Method Detail
  - private java.io.File buildAggregatedXml(java.nio.charset.Charset effectiveEncoding)
    
    Collects and merges SpotBugs XML files from all reactor projects into a single aggregate XML file.
    Parameters:
    effectiveEncoding - the charset to use for writing the output file
    Returns:
    the merged XML file, or null if no XML files were found
  - @java.lang.Override
    boolean canGenerateReport()
    
    Checks whether prerequisites for generating this report are given.
    Returns:
    true if the report can be generated, otherwise false
    See Also:
    AbstractMavenReport#canGenerateReport()#canGenerateReport()
  - @java.lang.Override
    void executeReport(java.util.Locale locale)
    
    Executes the generation of the aggregate report.
    Parameters:
    locale - the wanted locale to generate the report, could be null.
    See Also:
    AbstractMavenReport#executeReport(Locale)#executeReport(Locale)
  - java.util.ResourceBundle getBundle(java.util.Locale locale)
  - @java.lang.Override
    java.lang.String getDescription(java.util.Locale locale)
    
    Returns the plugins description for the "generated reports" overview page.
    Parameters:
    locale - the locale the report should be generated for
    Returns:
    description of the report
    See Also:
    org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
  - @java.lang.Override
    java.lang.String getName(java.util.Locale locale)
    
    Returns the plugins name for the "generated reports" overview page and the menu.
    Parameters:
    locale - the locale the report should be generated for
    Returns:
    name of the report
    See Also:
    org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
  - @java.lang.Override
    protected java.lang.String getOutputDirectory()
    
    Returns the report output directory.
    Returns:
    full path to the directory where the files in the site get copied to
    See Also:
    AbstractMavenReport#getOutputDirectory()#getOutputDirectory()
  - @java.lang.Override
    @java.lang.Deprecated
    java.lang.String getOutputName()
    
    Returns report output file name, without the extension.
    deprecated:
    Method name does not properly reflect its purpose. Implement and use getOutputPath() instead. This is waiting on maven to switch in report plugin before we can remove it.
    
    Returns:
    name of the generated page
    See Also:
    org.apache.maven.reporting.MavenReport#getOutputName()
  - @java.lang.Override
    java.lang.String getOutputPath()
    
    Returns report output file name, without the extension.
    Returns:
    name of the generated page
    See Also:
    org.apache.maven.reporting.MavenReport#getOutputPath()
  - @java.lang.Override
    void setReportOutputDirectory(java.io.File reportOutputDirectory)
    
    Sets the report output directory.
    See Also:
    AbstractMavenReport#setReportOutputDirectory(File)#setReportOutputDirectory(File)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

spotbugs-maven-plugin Groovy Documentation

[Groovy] Class SpotBugsAggregateMojo

Properties Summary

Constructor Summary

Methods Summary

Property Detail

java.util.ResourceBundle bundle

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.debug)
boolean debug

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)
java.lang.String effort

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}, required: true)
java.io.File outputDirectory

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputEncoding}, property: outputEncoding)
java.lang.String outputEncoding

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skip)
boolean skip

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skipEmptyReport)
boolean skipEmptyReport

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
java.lang.String spotbugsXmlOutputFilename

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.threshold)
java.lang.String threshold

Constructor Detail

SpotBugsAggregateMojo()

Method Detail

private java.io.File buildAggregatedXml(java.nio.charset.Charset effectiveEncoding)

@java.lang.Override
boolean canGenerateReport()

@java.lang.Override
void executeReport(java.util.Locale locale)

java.util.ResourceBundle getBundle(java.util.Locale locale)

@java.lang.Override
java.lang.String getDescription(java.util.Locale locale)

@java.lang.Override
java.lang.String getName(java.util.Locale locale)

@java.lang.Override
protected java.lang.String getOutputDirectory()

@java.lang.Override
@java.lang.Deprecated
java.lang.String getOutputName()

@java.lang.Override
java.lang.String getOutputPath()

@java.lang.Override
void setReportOutputDirectory(java.io.File reportOutputDirectory)

[Groovy] Class SpotBugsAggregateMojo

Properties Summary

Constructor Summary

Methods Summary

Property Detail

java.util.ResourceBundle bundle

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.debug)boolean debug

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)java.lang.String effort

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}, required: true)java.io.File outputDirectory

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputEncoding}, property: outputEncoding)java.lang.String outputEncoding

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skip)boolean skip

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skipEmptyReport)boolean skipEmptyReport

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)java.lang.String spotbugsXmlOutputFilename

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.threshold)java.lang.String threshold

Constructor Detail

SpotBugsAggregateMojo()

Method Detail

private java.io.File buildAggregatedXml(java.nio.charset.Charset effectiveEncoding)

@java.lang.Overrideboolean canGenerateReport()

@java.lang.Overridevoid executeReport(java.util.Locale locale)

java.util.ResourceBundle getBundle(java.util.Locale locale)

@java.lang.Overridejava.lang.String getDescription(java.util.Locale locale)

@java.lang.Overridejava.lang.String getName(java.util.Locale locale)

@java.lang.Overrideprotected java.lang.String getOutputDirectory()

@java.lang.Override@java.lang.Deprecatedjava.lang.String getOutputName()

@java.lang.Overridejava.lang.String getOutputPath()

@java.lang.Overridevoid setReportOutputDirectory(java.io.File reportOutputDirectory)

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.debug)
boolean debug

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)
java.lang.String effort

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}, required: true)
java.io.File outputDirectory

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputEncoding}, property: outputEncoding)
java.lang.String outputEncoding

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skip)
boolean skip

@org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skipEmptyReport)
boolean skipEmptyReport

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
java.lang.String spotbugsXmlOutputFilename

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.threshold)
java.lang.String threshold

@java.lang.Override
boolean canGenerateReport()

@java.lang.Override
void executeReport(java.util.Locale locale)

@java.lang.Override
java.lang.String getDescription(java.util.Locale locale)

@java.lang.Override
java.lang.String getName(java.util.Locale locale)

@java.lang.Override
protected java.lang.String getOutputDirectory()

@java.lang.Override
@java.lang.Deprecated
java.lang.String getOutputName()

@java.lang.Override
java.lang.String getOutputPath()

@java.lang.Override
void setReportOutputDirectory(java.io.File reportOutputDirectory)