Fork me on GitHub
Built by Maven

spotbugs:check

Full name:

com.github.spotbugs:spotbugs-maven-plugin:4.7.3.4: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 this plugin's goal spotbugs prior to executing itself.

Required Parameters

Name Type Since Description
<classFilesDirectory> File - (no description)
Default value is: ${project.build.outputDirectory}.
<outputDirectory> File - (no description)
Default value is: ${project.reporting.outputDirectory}.
<spotbugsXmlOutputDirectory> File - (no description)
Default value is: ${project.build.directory}.
<testClassFilesDirectory> File - (no description)
Default value is: ${project.build.testOutputDirectory}.
<xmlOutput> boolean - (no description)
Default value is: false.
User property is: spotbugs.xmlOutput.
<xmlOutputDirectory> File - (no description)
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
<debug> Boolean - (no description)
Default value is: false.
User property is: spotbugs.debug.
<effort> String - (no description)
Default value is: Default.
User property is: spotbugs.effort.
<excludeBugsFile> String - (no description)
User property is: spotbugs.excludeBugsFile.
<excludeFilterFile> String - (no description)
User property is: spotbugs.excludeFilterFile.
<failOnError> boolean - (no description)
Default value is: true.
User property is: spotbugs.failOnError.
<failThreshold> String - (no description)
User property is: spotbugs.failThreshold.
<fork> boolean - (no description)
Default value is: true.
User property is: spotbugs.fork.
<includeFilterFile> String - (no description)
User property is: spotbugs.includeFilterFile.
<includeTests> boolean - (no description)
Default value is: false.
User property is: spotbugs.includeTests.
<jvmArgs> String - (no description)
User property is: spotbugs.jvmArgs.
<maxAllowedViolations> int - (no description)
Default value is: 0.
User property is: spotbugs.maxAllowedViolations.
<maxHeap> int - (no description)
Default value is: 512.
User property is: spotbugs.maxHeap.
<maxRank> int - (no description)
User property is: spotbugs.maxRank.
<nested> Boolean - (no description)
Default value is: false.
User property is: spotbugs.nested.
<omitVisitors> String - (no description)
User property is: spotbugs.omitVisitors.
<onlyAnalyze> String - (no description)
User property is: spotbugs.onlyAnalyze.
<outputEncoding> String - (no description)
Default value is: ${project.reporting.outputEncoding}.
User property is: outputEncoding.
<pluginList> String - (no description)
User property is: spotbugs.pluginList.
<relaxed> Boolean - (no description)
Default value is: false.
User property is: spotbugs.relaxed.
<skip> boolean - (no description)
Default value is: false.
User property is: spotbugs.skip.
<sourceEncoding> String - (no description)
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
<spotbugsXmlOutput> boolean - Deprecated.
Default value is: true.
<spotbugsXmlOutputFilename> String - (no description)
Default value is: spotbugsXml.xml.
User property is: spotbugs.outputXmlFilename.
<threshold> String - (no description)
Default value is: Default.
User property is: spotbugs.threshold.
<timeout> int - (no description)
Default value is: 600000.
User property is: spotbugs.timeout.
<trace> Boolean - (no description)
Default value is: false.
User property is: spotbugs.trace.
<visitors> String - (no description)
User property is: spotbugs.visitors.
<xrefLocation> File - (no description)
Default value is: ${project.reporting.outputDirectory}/xref.
<xrefTestLocation> File - (no description)
Default value is: ${project.reporting.outputDirectory}/xref-test.

Parameter Details

<classFilesDirectory>

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

<debug>

(no description)
  • Type: java.lang.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

<excludeFilterFile>

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

<failOnError>

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

<failThreshold>

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: spotbugs.failThreshold

<fork>

(no description)
  • Type: boolean
  • Required: No
  • User Property: spotbugs.fork
  • Default: true

<includeFilterFile>

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

<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

<maxAllowedViolations>

(no description)
  • Type: int
  • Required: No
  • User Property: spotbugs.maxAllowedViolations
  • Default: 0

<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: java.lang.Boolean
  • Required: No
  • User Property: spotbugs.nested
  • 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>

(no description)
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}

<outputEncoding>

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

<pluginList>

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

<relaxed>

(no description)
  • Type: java.lang.Boolean
  • Required: No
  • User Property: spotbugs.relaxed
  • Default: false

<skip>

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

<sourceEncoding>

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

<spotbugsXmlOutput>

Deprecated. No reason given
(no description)
  • Type: boolean
  • Required: No
  • Default: true

<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

<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: java.lang.Boolean
  • Required: No
  • User Property: spotbugs.trace
  • Default: false

<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