SpotBugsMojo (spotbugs-maven-plugin Groovy Documentation)

org.codehaus.mojo.spotbugs.SpotBugsMojo

All Implemented Interfaces and Traits:: SpotBugsPluginsTrait

@org.apache.maven.plugins.annotations.Mojo(name: spotbugs, requiresDependencyResolution: ResolutionScope.TEST, requiresProject: true, threadSafe: true)
class SpotBugsMojo
extends AbstractMavenReport
implements SpotBugsPluginsTrait

Generates a SpotBugs Report when the site plugin is run. The HTML report is generated for site commands only.

Properties Summary

Properties
Type	Name and description
`boolean`	`addSourceDirs` Run Spotbugs with -sourcepath parameter populated with the known source roots.
`org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver`	`artifactResolver` Artifact resolver, needed to download the coreplugin jar.
`int`	`bugCount` The bug count.
`java.util.ResourceBundle`	`bundle` The resource bundle.
`java.io.File`	`classFilesDirectory` Directory containing the class files for Spotbugs to analyze.
`boolean`	`debug` Turn on Spotbugs debugging.
`java.lang.String`	`effort` Effort of the bug finders.
`int`	`errorCount` The error count.
`java.lang.String`	`excludeBugsFile` File names of the baseline files.
`java.util.List`	`excludeBugsFiles` File names of the baseline files.
`java.lang.String`	`excludeFilterFile` File name of the exclude filter.
`java.util.List`	`excludeFilterFiles` File name for exclude filter files.
`RepositorySystem`	`factory` Used to look up Artifacts in the remote repository.
`boolean`	`failOnError` Fail the build on an error.
`boolean`	`fork` Fork a VM for Spotbugs analysis.
`boolean`	`htmlOutput` Turn on and off HTML output of the Spotbugs report.
`java.lang.String`	`includeFilterFile` File name of the include filter.
`java.util.List`	`includeFilterFiles` File name for include filter files.
`boolean`	`includeTests` Run Spotbugs on the tests.
`java.lang.String`	`jvmArgs` The arguments to pass to the forked VM (ignored if fork is disabled).
`int`	`maxHeap` Maximum Java heap size in megabytes (default=512).
`int`	`maxRank` Maximum bug ranking to record.
`boolean`	`nested` This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.
`boolean`	`noClassOk` Output empty warning file if no classes are specified.
`java.lang.String`	`omitVisitors` The visitor list to omit.
`java.lang.String`	`onlyAnalyze` Restrict analysis to the given comma-separated list of classes and packages.
`java.io.File`	`outputDirectory` Location where generated html will be created allowed to be not read only as defined in AbstractMavenParent.
`java.lang.String`	`outputEncoding` The file encoding to use when creating the HTML reports.
`java.io.File`	`outputSpotbugsFile` The output spotbugs file.
`java.util.List`	`pluginArtifacts` List of artifacts this plugin depends on.
`java.lang.String`	`pluginList` The plugin list to include in the report.
`PluginArtifact[]`	`plugins` Collection of PluginArtifact to work on.
`boolean`	`relaxed` Relaxed reporting mode.
`org.codehaus.plexus.resource.ResourceManager`	`resourceManager` Resource Manager.
`boolean`	`sarifFullPath` Sarif full Path used with sarif.
`boolean`	`sarifOutput` Turn on and off SARIF output of the Spotbugs report.
`java.io.File`	`sarifOutputDirectory` Specifies the directory where the sarif output will be generated.
`java.lang.String`	`sarifOutputFilename` Set the name of the output SARIF file produced.
`MavenSession`	`session` Maven Session.
`org.apache.maven.doxia.siterenderer.Renderer`	`siteRenderer` Doxia Site Renderer.
`org.apache.maven.doxia.tools.SiteTool`	`siteTool` SiteTool.
`boolean`	`skip` Skip entire check.
`boolean`	`skipEmptyReport` Skip the Spotbugs HTML report generation if there are no violations found.
`java.lang.String`	`sourceEncoding` The file encoding to use when reading the source files.
`java.io.File`	`spotbugsXmlOutputDirectory` Specifies the directory where the Spotbugs native xml output will be generated.
`java.lang.String`	`spotbugsXmlOutputFilename` Set the name of the output XML file produced
`java.util.Map<java.lang.String, java.lang.String>`	`systemPropertyVariables` System properties to set in the VM (or the forked VM if fork is enabled).
`java.io.File`	`testClassFilesDirectory` Directory containing the test class files for Spotbugs to analyze.
`java.lang.String`	`threshold` Threshold of minimum bug severity to report.
`int`	`timeout` Specifies the amount of time, in milliseconds, that Spotbugs may run before it is assumed to be hung and is terminated.
`boolean`	`trace` Prints a trace of detectors run and classes analyzed to standard output.
`java.lang.String`	`userPrefs` Set the path of the user preferences file to use.
`java.lang.String`	`visitors` The visitor list to run.
`boolean`	`xmlOutput` Turn on and off xml output of the Spotbugs report.
`java.io.File`	`xmlOutputDirectory` Specifies the directory where the xml output will be generated.
`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
`SpotBugsMojo()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`canGenerateReport()` Checks whether prerequisites for generating this report are given.
	`private java.io.File`	`createSpotbugsAuxClasspathFile()` Create the Spotbugs AuxClasspath file.
	`void`	`execute()`
	`private void`	`executeCheck()`
	`void`	`executeReport(java.util.Locale locale)` Executes the generation of the report.
	`private void`	`executeSpotbugs(java.io.File outputFile)` Set up and run the Spotbugs engine.
	`private void`	`forceFileCreation(java.io.File file)` For the file creation by creating the file AND folder if needed.
	`private void`	`generateXDoc(java.util.Locale locale)`
	`java.util.ResourceBundle`	`getBundle(java.lang.Object 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 allowed to be not read only as defined in AbstractMavenParent.
	`java.lang.String`	`getOutputName()` Returns report output file name, without the extension.
	`protected org.apache.maven.doxia.siterenderer.Renderer`	`getSiteRenderer()` Return the Site Renderer.
	`private java.util.ArrayList<java.lang.String>`	`getSpotbugsArgs(java.io.File htmlTempFile, java.io.File xmlTempFile, java.io.File sarifTempFile)` Get the Spotbugs command line arguments.
	`protected java.lang.String`	`getThresholdParameter()` Returns the threshold parameter to use.
	`protected boolean`	`isJxrPluginEnabled()` Determines if the JXR-Plugin is included in the report section of the POM.
	`void`	`setReportOutputDirectory(java.io.File reportOutputDirectory)` Set report output directory, allowed to be not read only as defined in AbstractMavenParent.

- Property Detail
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.addSourceDirs)
    boolean addSourceDirs
    
    Run Spotbugs with -sourcepath parameter populated with the known source roots.
  - @javax.inject.Inject
    org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver
    
    Artifact resolver, needed to download the coreplugin jar.
  - int bugCount
    
    The bug count.
  - java.util.ResourceBundle bundle
    
    The resource bundle.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.outputDirectory}, required: true)
    java.io.File classFilesDirectory
    
    Directory containing the class files for Spotbugs to analyze.
  - @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:
    1.0-beta-1
  - int errorCount
    
    The error count.
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeBugsFile)
    java.lang.String excludeBugsFile
    
    File names of the baseline files. Bugs found in the baseline files won't be reported.
    Potential values are a filesystem path, a URL, or a classpath resource.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a filter file.
    This is a comma-delimited list.
    Since:
    2.4.1
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeBugsFiles)
    java.util.List excludeBugsFiles
    
    File names of the baseline files. Bugs found in the baseline files won't be reported.
    Potential values are a filesystem path, a URL, or a classpath resource.
    This is an alternative to <excludeBugsFile> which allows multiple files to be specified as separate elements in a pom.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a filter file.
    Since:
    4.7.1.0
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeFilterFile)
    java.lang.String excludeFilterFile
    
    File name of the exclude filter. Bugs matching the filters are not reported.
    Potential values are a filesystem path, a URL, or a classpath resource.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a filter file. It supports multiple files separated by a comma
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeFilterFiles)
    java.util.List excludeFilterFiles
    
    File name for exclude filter files. Bugs matching the filters are not reported.
    This is an alternative to <excludeFilterFile> which allows multiple files to be specified as separate elements in a pom.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a filter file.
    Since:
    4.7.1.0
  - @javax.inject.Inject
    RepositorySystem factory
    
    Used to look up Artifacts in the remote repository.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: true, property: spotbugs.failOnError)
    boolean failOnError
    
    Fail the build on an error.
    Since:
    2.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: true, property: spotbugs.fork)
    boolean fork
    
    Fork a VM for Spotbugs analysis. This will allow you to set timeouts and heap size.
    Since:
    2.3.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.htmlOutput, required: true)
    boolean htmlOutput
    
    Turn on and off HTML output of the Spotbugs report.
    Since:
    4.7.3.1
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.includeFilterFile)
    java.lang.String includeFilterFile
    
    File name of the include filter. Only bugs in matching the filters are reported.
    Potential values are a filesystem path, a URL, or a classpath resource.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a filter file. It supports multiple files separated by a comma
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.includeFilterFiles)
    java.util.List includeFilterFiles
    
    File name for include filter files. Only bugs in matching the filters are reported.
    Potential values are a filesystem path, a URL, or a classpath resource.
    This is an alternative to <includeFilterFile> which allows multiple files to be specified as separate elements in a pom.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a filter file.
    Since:
    4.7.1.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.includeTests)
    boolean includeTests
    
    Run Spotbugs on the tests.
    Since:
    2.0
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.jvmArgs)
    java.lang.String jvmArgs
    
    The arguments to pass to the forked VM (ignored if fork is disabled).
    Since:
    2.4.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)
    int maxHeap
    
    Maximum Java heap size in megabytes (default=512). This only works if the fork parameter is set true.
    Since:
    2.2
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.maxRank)
    int maxRank
    
    Maximum bug ranking to record.
    Since:
    2.4.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.nested)
    boolean nested
    
    This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.
    Since:
    2.3.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.noClassOk, required: true)
    boolean noClassOk
    
    Output empty warning file if no classes are specified.
    Since:
    4.8.3.0
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.omitVisitors)
    java.lang.String omitVisitors
    
    The visitor list to omit. This is a comma-delimited list.
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.onlyAnalyze)
    java.lang.String onlyAnalyze
    
    Restrict analysis to the given comma-separated list of classes and packages.
    Since:
    1.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}, required: true)
    java.io.File outputDirectory
    
    Location where generated html will be created allowed to be not read only as defined in AbstractMavenParent.
  - @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, the platform default encoding is used.
    Since:
    2.2
  - java.io.File outputSpotbugsFile
    
    The output spotbugs file.
  - @org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, readonly: true, required: true)
    java.util.List pluginArtifacts
    
    List of artifacts this plugin depends on. Used for resolving the Spotbugs core plugin.
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)
    java.lang.String pluginList
    
    The plugin list to include in the report. This is a comma-delimited list.
    Potential values are a filesystem path, a URL, or a classpath resource.
    This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory} directory before being passed to Spotbugs as a plugin file.
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter
    PluginArtifact[] plugins
    
    Collection of PluginArtifact to work on. (PluginArtifact contains groupId, artifactId, version, type, classifier.) See Usage for details.
    Since:
    2.4.1
    4.8.3.0 includes classifier
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.relaxed)
    boolean relaxed
    
    Relaxed reporting mode. For many detectors, this option suppresses the heuristics used to avoid reporting false positives.
    Since:
    1.1
  - @javax.inject.Inject
    org.codehaus.plexus.resource.ResourceManager resourceManager
    
    Resource Manager.
    Since:
    2.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.sarifFullPath, required: true)
    boolean sarifFullPath
    
    Sarif full Path used with sarif.
    Since:
    4.3.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.sarifOutput, required: true)
    boolean sarifOutput
    
    Turn on and off SARIF output of the Spotbugs report. SARIF is a JSON format standardize for all code scanning tools. https://docs.github.com/en/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning
    Since:
    4.3.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.directory}, property: spotbugs.sarifOutputDirectory, required: true)
    java.io.File sarifOutputDirectory
    
    Specifies the directory where the sarif output will be generated.
    Since:
    4.7.2.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsSarif.json, property: spotbugs.sarifOutputFilename, required: true)
    java.lang.String sarifOutputFilename
    
    Set the name of the output SARIF file produced.
    Since:
    4.7.2.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)
    MavenSession session
    
    Maven Session.
  - @javax.inject.Inject
    org.apache.maven.doxia.siterenderer.Renderer siteRenderer
    
    Doxia Site Renderer.
  - @javax.inject.Inject
    org.apache.maven.doxia.tools.SiteTool siteTool
    
    SiteTool.
    Since:
    2.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.skip)
    boolean skip
    
    Skip entire check.
    Since:
    1.1
  - @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:
    3.0.1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.sourceEncoding}, property: encoding)
    java.lang.String sourceEncoding
    
    The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.
    Since:
    2.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.directory}, required: true)
    java.io.File spotbugsXmlOutputDirectory
    
    Specifies the directory where the Spotbugs native xml output will be generated.
    Since:
    1.2.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
    java.lang.String spotbugsXmlOutputFilename
    
    Set the name of the output XML file produced
    Since:
    3.1.12.2
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.systemPropertyVariables)
    java.util.Map<java.lang.String, java.lang.String> systemPropertyVariables
    
    System properties to set in the VM (or the forked VM if fork is enabled).
    Since:
    4.3.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.testOutputDirectory}, required: true)
    java.io.File testClassFilesDirectory
    
    Directory containing the test class files for Spotbugs to analyze.
  - @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).
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: 600000, property: spotbugs.timeout)
    int timeout
    
    Specifies the amount of time, in milliseconds, that Spotbugs may run before it is assumed to be hung and is terminated. The default is 600,000 milliseconds, which is ten minutes. This only works if the fork parameter is set true.
    Since:
    2.2
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.trace)
    boolean trace
    
    Prints a trace of detectors run and classes analyzed to standard output. Useful for troubleshooting unexpected analysis failures.
    Since:
    2.3.2
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.userPrefs)
    java.lang.String userPrefs
    
    Set the path of the user preferences file to use. Will try to read the path as a resource before treating it as a local path. This will read in a configuration file to set up Spotbugs. The parameters in the POM file will override anything in the config file
    Since:
    3.0.2
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.visitors)
    java.lang.String visitors
    
    The visitor list to run. This is a comma-delimited list.
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.xmlOutput, required: true)
    boolean xmlOutput
    
    Turn on and off xml output of the Spotbugs report.
    Since:
    1.0.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.directory}, required: true)
    java.io.File xmlOutputDirectory
    
    Specifies the directory where the xml output will be generated.
    Since:
    1.0.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}/xref)
    java.io.File xrefLocation
    
    Location of the Xrefs to link to.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}/xref-test)
    java.io.File xrefTestLocation
    
    Location of the Test Xrefs to link to.
- Constructor Detail
  - SpotBugsMojo()
- Method Detail
  - @java.lang.Override
    boolean canGenerateReport()
    
    Checks whether prerequisites for generating this report are given.
    Returns:
    true if report can be generated, otherwise false
    See Also:
    AbstractMavenReport#canGenerateReport()#canGenerateReport()
  - private java.io.File createSpotbugsAuxClasspathFile()
    
    Create the Spotbugs AuxClasspath file.
  - @java.lang.Override
    void execute()
  - private void executeCheck()
  - @java.lang.Override
    void executeReport(java.util.Locale locale)
    
    Executes the generation of the report. Callback from Maven Site Plugin.
    Parameters:
    locale - the wanted locale to generate the report, could be null.
    See Also:
    AbstractMavenReport#executeReport(Locale)#executeReport(Locale)
  - private void executeSpotbugs(java.io.File outputFile)
    
    Set up and run the Spotbugs engine.
    Parameters:
    outputFile - the outputFile
  - private void forceFileCreation(java.io.File file)
    
    For the file creation by creating the file AND folder if needed. The file created will be empty.
    Parameters:
    file - Destination file to create.
  - private void generateXDoc(java.util.Locale locale)
  - java.util.ResourceBundle getBundle(java.lang.Object 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 allowed to be not read only as defined in AbstractMavenParent. Called by AbstractMavenReport.execute() for creating the sink.
    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.String getOutputName()
    
    Returns report output file name, without the extension. Called by AbstractMavenReport.execute() for creating the sink.
    Returns:
    name of the generated page
    See Also:
    org.apache.maven.reporting.MavenReport#getOutputName()
  - @java.lang.Override
    protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
    
    Return the Site Renderer.
  - private java.util.ArrayList<java.lang.String> getSpotbugsArgs(java.io.File htmlTempFile, java.io.File xmlTempFile, java.io.File sarifTempFile)
    
    Get the Spotbugs command line arguments.
    Parameters:
    htmlTempFile - Spotbugs html temp output file
    xmlTempFile - Spotbugs xml temp output file
    sarifTempFile - Spotbugs sarif temp output file
    Returns:
    Spotbugs command line arguments.
  - protected java.lang.String getThresholdParameter()
    
    Returns the threshold parameter to use.
    Returns:
    A valid threshold parameter.
  - protected boolean isJxrPluginEnabled()
    
    Determines if the JXR-Plugin is included in the report section of the POM.
    Parameters:
    bundle - The bundle to load the artifactIf of the jxr plugin.
    Returns:
    True if the JXR-Plugin is included in the POM, false otherwise.
  - @java.lang.Override
    void setReportOutputDirectory(java.io.File reportOutputDirectory)
    
    Set report output directory, allowed to be not read only as defined in AbstractMavenParent.
    See Also:
    AbstractMavenReport#setReportOutputDirectory(File)#setReportOutputDirectory(File)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

spotbugs-maven-plugin Groovy Documentation

[Groovy] Class SpotBugsMojo

Properties Summary

Constructor Summary

Methods Summary

Property Detail

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

@javax.inject.Injectorg.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver

int bugCount

java.util.ResourceBundle bundle

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

@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

int errorCount

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeBugsFile)java.lang.String excludeBugsFile

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeBugsFiles)java.util.List excludeBugsFiles

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeFilterFile)java.lang.String excludeFilterFile

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeFilterFiles)java.util.List excludeFilterFiles

@javax.inject.InjectRepositorySystem factory

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

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

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.includeFilterFile)java.lang.String includeFilterFile

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.includeFilterFiles)java.util.List includeFilterFiles

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.jvmArgs)java.lang.String jvmArgs

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)int maxHeap

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.maxRank)int maxRank

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

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.omitVisitors)java.lang.String omitVisitors

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.onlyAnalyze)java.lang.String onlyAnalyze

@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

java.io.File outputSpotbugsFile

@org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, readonly: true, required: true)java.util.List pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)java.lang.String pluginList

@org.apache.maven.plugins.annotations.ParameterPluginArtifact[] plugins

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

@javax.inject.Injectorg.codehaus.plexus.resource.ResourceManager resourceManager

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

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.directory}, property: spotbugs.sarifOutputDirectory, required: true)java.io.File sarifOutputDirectory

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsSarif.json, property: spotbugs.sarifOutputFilename, required: true)java.lang.String sarifOutputFilename

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)MavenSession session

@javax.inject.Injectorg.apache.maven.doxia.siterenderer.Renderer siteRenderer

@javax.inject.Injectorg.apache.maven.doxia.tools.SiteTool siteTool

@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: ${project.build.sourceEncoding}, property: encoding)java.lang.String sourceEncoding

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

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.systemPropertyVariables)java.util.Map<java.lang.String, java.lang.String> systemPropertyVariables

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

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 600000, property: spotbugs.timeout)int timeout

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.userPrefs)java.lang.String userPrefs

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.visitors)java.lang.String visitors

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

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}/xref)java.io.File xrefLocation

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}/xref-test)java.io.File xrefTestLocation

Constructor Detail

SpotBugsMojo()

Method Detail

@java.lang.Overrideboolean canGenerateReport()

private java.io.File createSpotbugsAuxClasspathFile()

@java.lang.Overridevoid execute()

private void executeCheck()

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

private void executeSpotbugs(java.io.File outputFile)

private void forceFileCreation(java.io.File file)

private void generateXDoc(java.util.Locale locale)

java.util.ResourceBundle getBundle(java.lang.Object 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.Overridejava.lang.String getOutputName()

@java.lang.Overrideprotected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

private java.util.ArrayList<java.lang.String> getSpotbugsArgs(java.io.File htmlTempFile, java.io.File xmlTempFile, java.io.File sarifTempFile)

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

@javax.inject.Inject
org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver

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

@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(property: spotbugs.excludeBugsFile)
java.lang.String excludeBugsFile

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeBugsFiles)
java.util.List excludeBugsFiles

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeFilterFile)
java.lang.String excludeFilterFile

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.excludeFilterFiles)
java.util.List excludeFilterFiles

@javax.inject.Inject
RepositorySystem factory

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

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

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.includeFilterFile)
java.lang.String includeFilterFile

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.includeFilterFiles)
java.util.List includeFilterFiles

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.jvmArgs)
java.lang.String jvmArgs

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)
int maxHeap

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.maxRank)
int maxRank

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

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.omitVisitors)
java.lang.String omitVisitors

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.onlyAnalyze)
java.lang.String onlyAnalyze

@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(property: plugin.artifacts, readonly: true, required: true)
java.util.List pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)
java.lang.String pluginList

@org.apache.maven.plugins.annotations.Parameter
PluginArtifact[] plugins

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

@javax.inject.Inject
org.codehaus.plexus.resource.ResourceManager resourceManager

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

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.directory}, property: spotbugs.sarifOutputDirectory, required: true)
java.io.File sarifOutputDirectory

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsSarif.json, property: spotbugs.sarifOutputFilename, required: true)
java.lang.String sarifOutputFilename

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)
MavenSession session

@javax.inject.Inject
org.apache.maven.doxia.siterenderer.Renderer siteRenderer

@javax.inject.Inject
org.apache.maven.doxia.tools.SiteTool siteTool

@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: ${project.build.sourceEncoding}, property: encoding)
java.lang.String sourceEncoding

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

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.systemPropertyVariables)
java.util.Map<java.lang.String, java.lang.String> systemPropertyVariables

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

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 600000, property: spotbugs.timeout)
int timeout

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

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.userPrefs)
java.lang.String userPrefs

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.visitors)
java.lang.String visitors

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

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}/xref)
java.io.File xrefLocation

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.reporting.outputDirectory}/xref-test)
java.io.File xrefTestLocation

@java.lang.Override
boolean canGenerateReport()

@java.lang.Override
void execute()

@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.String getOutputName()

@java.lang.Override
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

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