Property Detail

• @org.apache.maven.plugins.annotations.Component(role: ArtifactResolver.class)
  org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver

  Artifact resolver, needed to download the coreplugin jar.

• @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: ${project.compileSourceRoots}, required: true, readonly: true)
  java.util.List compileSourceRoots

  The directories containing the sources to be compiled.

• @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.debug)
  java.lang.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

• @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.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.failOnError, defaultValue: true)
  boolean failOnError

  Fail the build on an error.

  Since:

  2.0

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

  Prioritiy threshold which bugs have to reach to cause a failure. Valid values are High, Medium or Low. Bugs below this threshold will just issue a warning log entry.

  Since:

  4.0.1

• @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.fork, defaultValue: true)
  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(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(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(property: localRepository, required: true, readonly: true)
  ArtifactRepository localRepository

  The local repository, needed to download the coreplugin jar.

• @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.maxAllowedViolations, defaultValue: 0)
  int maxAllowedViolations

  specified max number of violations which can be ignored by the spotbugs.

  Since:

  2.4.1

• @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.maxHeap, defaultValue: 512)
  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(property: spotbugs.nested, defaultValue: false)
  java.lang.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(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.

• @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

• @org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, required: true, readonly: 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(property: project, required: true, readonly: true)
  MavenProject project

  Maven Project.

• @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.relaxed)
  java.lang.Boolean relaxed

  Relaxed reporting mode. For many detectors, this option suppresses the heuristics used to avoid reporting false positives.

  Since:

  1.1

• @org.apache.maven.plugins.annotations.Parameter(property: project.remoteArtifactRepositories, required: true, readonly: true)
  java.util.List remoteArtifactRepositories

  Remote repositories which will be searched for the coreplugin jar.

• @org.apache.maven.plugins.annotations.Component(role: ResourceManager.class)
  org.codehaus.plexus.resource.ResourceManager resourceManager

  Resource Manager.

  Since:

  2.0

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

  Maven Session.

• @org.apache.maven.plugins.annotations.Component(role: Renderer.class)
  org.apache.maven.doxia.siterenderer.Renderer siteRenderer

  Doxia Site Renderer.

• @org.apache.maven.plugins.annotations.Component(role: SiteTool.class)
  org.apache.maven.doxia.tools.SiteTool siteTool

  SiteTool.

  Since:

  2.1-SNAPSHOT

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

  Skip entire check.

  Since:

  1.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

• @java.lang.Deprecated
  @org.apache.maven.plugins.annotations.Parameter(defaultValue: true)
  boolean spotbugsXmlOutput

  This has been deprecated and is on by default.

  Since:

  1.2.0

• @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(property: spotbugs.outputXmlFilename, defaultValue: spotbugsXml.xml)
  java.lang.String spotbugsXmlOutputFilename

  Set the name of the output XML file produced

  Since:

  3.1.12.2

• @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: ${project.testCompileSourceRoots}, required: true, readonly: true)
  java.util.List testSourceRoots

  The directories containing the test-sources to be compiled.

  Since:

  2.0

• @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(property: spotbugs.timeout, defaultValue: 600000)
  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(property: spotbugs.trace, defaultValue: false)
  java.lang.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.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: UTF-8, readonly: true)
  java.lang.String xmlEncoding

  Encoding used for xml files. Default value is UTF-8.

• @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

• BaseViolationCheckMojo()

Method Detail

• private boolean doSourceFilesExist()

• @java.lang.Override
  void execute()

• private void printBugs(java.lang.Object total, java.lang.Object bugs)