Fork me on GitHub
Built by Maven

spotbugs:check

Full name:

com.github.spotbugs:spotbugs-maven-plugin:4.8.2.0:check

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.
  • Binds by default to the lifecycle phase: verify.
  • Invokes the execution of the following plugin's goal prior to executing itself: spotbugs.

Required Parameters

Name Type Since Description
<classFilesDirectory> File - No description.
Default: ${project.build.outputDirectory}
<outputDirectory> File - No description.
Default: ${project.reporting.outputDirectory}
<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
<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
<excludeFilterFile> String - No description.
User Property: spotbugs.excludeFilterFile
<failOnError> boolean - No description.
Default: true
User Property: spotbugs.failOnError
<failThreshold> String - No description.
User Property: spotbugs.failThreshold
<fork> boolean - No description.
Default: true
User Property: spotbugs.fork
<includeFilterFile> String - No description.
User Property: spotbugs.includeFilterFile
<includeTests> boolean - No description.
Default: false
User Property: spotbugs.includeTests
<jvmArgs> String - No description.
User Property: spotbugs.jvmArgs
<maxAllowedViolations> int - No description.
Default: 0
User Property: spotbugs.maxAllowedViolations
<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
<outputEncoding> String - No description.
Default: ${project.reporting.outputEncoding}
User Property: outputEncoding
<pluginList> String - No description.
User Property: spotbugs.pluginList
<relaxed> Boolean - No description.
Default: false
User Property: spotbugs.relaxed
<skip> boolean - No description.
Default: false
User Property: spotbugs.skip
<sourceEncoding> String - No description.
Default: ${project.build.sourceEncoding}
User Property: encoding
<spotbugsXmlOutput> boolean - Deprecated.
Default: true
<spotbugsXmlOutputFilename> String - No description.
Default: spotbugsXml.xml
User Property: spotbugs.outputXmlFilename
<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
<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

<classFilesDirectory>

No description.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • Default: ${project.build.outputDirectory}

<debug>

No description.
  • Type: java.lang.Boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.debug
  • Default: false

<effort>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.effort
  • Default: Default

<excludeBugsFile>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.excludeBugsFile

<excludeFilterFile>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.excludeFilterFile

<failOnError>

No description.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.failOnError
  • Default: true

<failThreshold>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.failThreshold

<fork>

No description.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.fork
  • Default: true

<includeFilterFile>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.includeFilterFile

<includeTests>

No description.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.includeTests
  • Default: false

<jvmArgs>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.jvmArgs

<maxAllowedViolations>

No description.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: spotbugs.maxAllowedViolations
  • Default: 0

<maxHeap>

No description.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: spotbugs.maxHeap
  • Default: 512

<maxRank>

No description.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: spotbugs.maxRank

<nested>

No description.
  • Type: java.lang.Boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.nested
  • Default: false

<omitVisitors>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.omitVisitors

<onlyAnalyze>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.onlyAnalyze

<outputDirectory>

No description.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • Default: ${project.reporting.outputDirectory}

<outputEncoding>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

<pluginList>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.pluginList

<relaxed>

No description.
  • Type: java.lang.Boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.relaxed
  • Default: false

<skip>

No description.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.skip
  • Default: false

<sourceEncoding>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<spotbugsXmlOutput>

Deprecated. No reason given
No description.
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: true

<spotbugsXmlOutputDirectory>

No description.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • Default: ${project.build.directory}

<spotbugsXmlOutputFilename>

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

<testClassFilesDirectory>

No description.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • Default: ${project.build.testOutputDirectory}

<threshold>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.threshold
  • Default: Default

<timeout>

No description.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: spotbugs.timeout
  • Default: 600000

<trace>

No description.
  • Type: java.lang.Boolean
  • Required: report.plugin.goal.no
  • User Property: spotbugs.trace
  • Default: false

<visitors>

No description.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: spotbugs.visitors

<xmlOutput>

No description.
  • Type: boolean
  • Required: report.plugin.goal.yes
  • User Property: spotbugs.xmlOutput
  • Default: false

<xmlOutputDirectory>

No description.
  • Type: java.io.File
  • Required: report.plugin.goal.yes
  • Default: ${project.build.directory}

<xrefLocation>

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

<xrefTestLocation>

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