Fork me on GitHub
Built by Maven

spotbugs:spotbugs

Note:

This goal should be used as a Maven report.

Full name:

com.github.spotbugs:spotbugs-maven-plugin:4.10.4.1:spotbugs

Description:

No description.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<classFilesDirectory> File - No description.
Default: ${project.build.outputDirectory}
<htmlOutput> boolean - No description.
Default: false
User Property: spotbugs.htmlOutput
<noClassOk> boolean - No description.
Default: false
User Property: spotbugs.noClassOk
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports
<sarifFullPath> boolean - No description.
Default: false
User Property: spotbugs.sarifFullPath
<sarifOutput> boolean - No description.
Default: false
User Property: spotbugs.sarifOutput
<sarifOutputDirectory> File - No description.
Default: ${project.build.directory}
User Property: spotbugs.sarifOutputDirectory
<sarifOutputFilename> String - No description.
Default: spotbugsSarif.json
User Property: spotbugs.sarifOutputFilename
<spotbugsXmlOutputDirectory> File - No description.
Default: ${project.build.directory}
<testClassFilesDirectory> File - No description.
Default: ${project.build.testOutputDirectory}
<xmlOutput> boolean - No description.
Default: false
User Property: spotbugs.xmlOutput
<xmlOutputDirectory> File - No description.
Default: ${project.build.directory}

Optional Parameters

Name Type Since Description
<addSourceDirs> boolean - No description.
Default: false
User Property: spotbugs.addSourceDirs
<chooseVisitors> String - No description.
User Property: spotbugs.chooseVisitors
<debug> boolean - No description.
Default: false
User Property: spotbugs.debug
<effort> String - No description.
Default: Default
User Property: spotbugs.effort
<excludeBugsFile> String - No description.
User Property: spotbugs.excludeBugsFile
<excludeBugsFiles> List<String> - No description.
User Property: spotbugs.excludeBugsFiles
<excludeFilterFile> String - No description.
User Property: spotbugs.excludeFilterFile
<excludeFilterFiles> List<String> - No description.
User Property: spotbugs.excludeFilterFiles
<failOnError> boolean - No description.
Default: true
User Property: spotbugs.failOnError
<includeFilterFile> String - No description.
User Property: spotbugs.includeFilterFile
<includeFilterFiles> List<String> - No description.
User Property: spotbugs.includeFilterFiles
<includeTests> boolean - No description.
Default: false
User Property: spotbugs.includeTests
<jvmArgs> String - No description.
User Property: spotbugs.jvmArgs
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
Default: default
<maxHeap> int - No description.
Default: 512
User Property: spotbugs.maxHeap
<maxRank> int - No description.
User Property: spotbugs.maxRank
<nested> boolean - No description.
Default: false
User Property: spotbugs.nested
<omitVisitors> String - No description.
User Property: spotbugs.omitVisitors
<onlyAnalyze> String - No description.
User Property: spotbugs.onlyAnalyze
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<pluginDocumentationUrls> Map<String,String> - No description.
<pluginList> String - No description.
User Property: spotbugs.pluginList
<plugins> List<PluginArtifact> - No description.
<relaxed> boolean - No description.
Default: false
User Property: spotbugs.relaxed
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean - No description.
Default: false
User Property: spotbugs.skip
<skipEmptyReport> boolean - No description.
Default: false
User Property: spotbugs.skipEmptyReport
<spotbugsXmlOutputFilename> String - No description.
Default: spotbugsXml.xml
User Property: spotbugs.outputXmlFilename
<systemPropertyVariables> Map<String,String> - No description.
User Property: spotbugs.systemPropertyVariables
<threshold> String - No description.
Default: Default
User Property: spotbugs.threshold
<timeout> int - No description.
Default: 600000
User Property: spotbugs.timeout
<trace> boolean - No description.
Default: false
User Property: spotbugs.trace
<userPrefs> String - No description.
User Property: spotbugs.userPrefs
<visitors> String - No description.
User Property: spotbugs.visitors
<xrefLocation> File - No description.
Default: ${project.reporting.outputDirectory}/xref
<xrefTestLocation> File - No description.
Default: ${project.reporting.outputDirectory}/xref-test

Parameter Details

<addSourceDirs>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.addSourceDirs
  • Default: false

<chooseVisitors>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.chooseVisitors

<classFilesDirectory>

No description.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}

<debug>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.debug
  • Default: false

<effort>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.effort
  • Default: Default

<excludeBugsFile>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.excludeBugsFile

<excludeBugsFiles>

No description.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: spotbugs.excludeBugsFiles

<excludeFilterFile>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.excludeFilterFile

<excludeFilterFiles>

No description.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: spotbugs.excludeFilterFiles

<failOnError>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.failOnError
  • Default: true

<htmlOutput>

No description.
  • Type: boolean
  • Required: Yes
  • User Property: spotbugs.htmlOutput
  • Default: false

<includeFilterFile>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.includeFilterFile

<includeFilterFiles>

No description.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: spotbugs.includeFilterFiles

<includeTests>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.includeTests
  • Default: false

<jvmArgs>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.jvmArgs

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<maxHeap>

No description.
  • Type: int
  • Required: No
  • User Property: spotbugs.maxHeap
  • Default: 512

<maxRank>

No description.
  • Type: int
  • Required: No
  • User Property: spotbugs.maxRank

<nested>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.nested
  • Default: false

<noClassOk>

No description.
  • Type: boolean
  • Required: Yes
  • User Property: spotbugs.noClassOk
  • Default: false

<omitVisitors>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.omitVisitors

<onlyAnalyze>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.onlyAnalyze

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<pluginDocumentationUrls>

No description.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<pluginList>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.pluginList

<plugins>

No description.
  • Type: java.util.List<org.codehaus.mojo.spotbugs.PluginArtifact>
  • Required: No

<relaxed>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.relaxed
  • Default: false

<sarifFullPath>

No description.
  • Type: boolean
  • Required: Yes
  • User Property: spotbugs.sarifFullPath
  • Default: false

<sarifOutput>

No description.
  • Type: boolean
  • Required: Yes
  • User Property: spotbugs.sarifOutput
  • Default: false

<sarifOutputDirectory>

No description.
  • Type: java.io.File
  • Required: Yes
  • User Property: spotbugs.sarifOutputDirectory
  • Default: ${project.build.directory}

<sarifOutputFilename>

No description.
  • Type: java.lang.String
  • Required: Yes
  • User Property: spotbugs.sarifOutputFilename
  • Default: spotbugsSarif.json

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<skip>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.skip
  • Default: false

<skipEmptyReport>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.skipEmptyReport
  • Default: false

<spotbugsXmlOutputDirectory>

No description.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

<spotbugsXmlOutputFilename>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.outputXmlFilename
  • Default: spotbugsXml.xml

<systemPropertyVariables>

No description.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No
  • User Property: spotbugs.systemPropertyVariables

<testClassFilesDirectory>

No description.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.testOutputDirectory}

<threshold>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.threshold
  • Default: Default

<timeout>

No description.
  • Type: int
  • Required: No
  • User Property: spotbugs.timeout
  • Default: 600000

<trace>

No description.
  • Type: boolean
  • Required: No
  • User Property: spotbugs.trace
  • Default: false

<userPrefs>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.userPrefs

<visitors>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.visitors

<xmlOutput>

No description.
  • Type: boolean
  • Required: Yes
  • User Property: spotbugs.xmlOutput
  • Default: false

<xmlOutputDirectory>

No description.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

<xrefLocation>

No description.
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}/xref

<xrefTestLocation>

No description.
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}/xref-test