FindbugsViolationCheckMojo (Groovy Documentation)

org.codehaus.mojo.findbugs.FindbugsViolationCheckMojo

Fail the build if there were any FindBugs violations in the source code. An XML report is put out by default in the target directory with the errors. To see more documentation about FindBugs' options, please see the FindBugs Manual..
Since:
2.0
Authors:
Garvin LeClaire

Inherited fields
Fields inherited from class	Fields
`class org.apache.maven.plugin.AbstractMojo`	`ROLE`

Properties Summary

Properties
Type	Name and description
`org.apache.maven.artifact.resolver.ArtifactResolver`	`artifactResolver` Artifact resolver, needed to download the coreplugin jar.
`int`	`bugCount`
`java.io.File`	`classFilesDirectory` Directory containing the class files for FindBugs to analyze.
`java.util.List`	`compileSourceRoots` The directories containing the sources to be compiled.
`java.lang.Boolean`	`debug` turn on Findbugs debugging
`java.lang.String`	`effort` Effort of the bug finders.
`int`	`errorCount`
`java.lang.String`	`excludeBugsFile`
`java.lang.String`	`excludeFilterFile`
`boolean`	`failOnError` Fail the build on an error.
`boolean`	`findbugsXmlOutput` Location where generated html will be created.
`java.io.File`	`findbugsXmlOutputDirectory` Specifies the directory where the findbugs native xml output will be generated.
`boolean`	`fork` Fork a VM for FindBugs analysis.
`java.lang.String`	`includeFilterFile`
`boolean`	`includeTests` Run Findbugs on the tests.
`java.lang.String`	`jvmArgs`
`org.apache.maven.artifact.repository.ArtifactRepository`	`localRepository` The local repository, needed to download the coreplugin jar.
`int`	`maxHeap` Maximum Java heap size in megabytes (default=512).
`int`	`maxRank` Maximum bug ranking to record.
`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.
`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.
`java.lang.String`	`outputEncoding` The file encoding to use when creating the HTML reports.
`java.util.List`	`pluginArtifacts` List of artifacts this plugin depends on.
`java.lang.String`	`pluginList`
`org.apache.maven.project.MavenProject`	`project` Maven Project
`java.lang.Boolean`	`relaxed` Relaxed reporting mode.
`java.util.List`	`remoteArtifactRepositories` Remote repositories which will be searched for the coreplugin jar.
`org.codehaus.plexus.resource.ResourceManager`	`resourceManager` @since 2.0
`org.apache.maven.doxia.siterenderer.Renderer`	`siteRenderer` Doxia Site Renderer.
`org.apache.maven.doxia.tools.SiteTool`	`siteTool` SiteTool.
`boolean`	`skip` Skip entire check.
`java.lang.String`	`sourceEncoding` The file encoding to use when reading the source files.
`java.io.File`	`testClassFilesDirectory` Directory containing the test class files for FindBugs to analyze.
`java.util.List`	`testSourceRoots` The directories containing the test-sources to be compiled.
`java.lang.String`	`threshold` Threshold of minimum bug severity to report.
`int`	`timeout` Specifies the amount of time, in milliseconds, that FindBugs may run before it is assumed to be hung and is terminated.
`java.lang.Boolean`	`trace` Prints a trace of detectors run and classes analyzed to standard output.
`java.lang.String`	`visitors` The visitor list to run.
`java.lang.String`	`xmlEncoding` Encoding used for xml files.
`boolean`	`xmlOutput` Turn on and off xml output of the Findbugs 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
`FindbugsViolationCheckMojo ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`execute()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.apache.maven.plugin.AbstractMojo`	org.apache.maven.plugin.AbstractMojo#getPluginContext(), org.apache.maven.plugin.AbstractMojo#setPluginContext(java.util.Map), org.apache.maven.plugin.AbstractMojo#setLog(org.apache.maven.plugin.logging.Log), org.apache.maven.plugin.AbstractMojo#getLog(), org.apache.maven.plugin.AbstractMojo#wait(long, int), org.apache.maven.plugin.AbstractMojo#wait(long), org.apache.maven.plugin.AbstractMojo#wait(), org.apache.maven.plugin.AbstractMojo#equals(java.lang.Object), org.apache.maven.plugin.AbstractMojo#toString(), org.apache.maven.plugin.AbstractMojo#hashCode(), org.apache.maven.plugin.AbstractMojo#getClass(), org.apache.maven.plugin.AbstractMojo#notify(), org.apache.maven.plugin.AbstractMojo#notifyAll(), org.apache.maven.plugin.AbstractMojo#execute()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - @org.apache.maven.plugins.annotations.Component( role = ArtifactResolver.class ) org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver
    
    Artifact resolver, needed to download the coreplugin jar.
  - int bugCount
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.outputDirectory}', required = true ) java.io.File classFilesDirectory
    
    Directory containing the class files for FindBugs 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="findbugs.debug" ) java.lang.Boolean debug
    
    turn on Findbugs debugging
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = "Default", property="findbugs.effort" ) java.lang.String effort
    
    Effort of the bug finders. Valid values are Min, Default and Max.
    Since:
    1.0-beta-1
  - int errorCount
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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 Findbugs as a filter file.
    This is a comma-delimited list.
    Since:
    2.4.1
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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 Findbugs as a filter file.
    
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.failOnError", defaultValue = "true" ) boolean failOnError
    
    Fail the build on an error.
    Since:
    2.0
  - @java.lang.Deprecated @org.apache.maven.plugins.annotations.Parameter( defaultValue = "true" ) boolean findbugsXmlOutput
    
    Location where generated html will be created.
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.directory}', required = true ) java.io.File findbugsXmlOutputDirectory
    
    Specifies the directory where the findbugs native xml output will be generated.
    Since:
    1.2.0
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.fork", defaultValue = "true" ) boolean fork
    
    Fork a VM for FindBugs analysis. This will allow you to set timeouts and heap size
    Since:
    2.3.2
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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 Findbugs as a filter file.
    
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.includeTests" ) boolean includeTests
    
    Run Findbugs on the tests.
    Since:
    2.0
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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 ) org.apache.maven.artifact.repository.ArtifactRepository localRepository
    
    The local repository, needed to download the coreplugin jar.
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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="findbugs.maxRank" ) int maxRank
    
    Maximum bug ranking to record.
    Since:
    2.4.1
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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="findbugs.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="findbugs.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 Findbugs coreplugin.
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.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 Findbugs as a plugin file.
    
    Since:
    1.0-beta-1
  - @org.apache.maven.plugins.annotations.Parameter( property="project", required = true, readonly = true ) org.apache.maven.project.MavenProject project
    
    Maven Project
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.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
    
    Since:
    2.0
  - @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="findbugs.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
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.testOutputDirectory}', required = true ) java.io.File testClassFilesDirectory
    
    Directory containing the test class files for FindBugs 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="findbugs.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="findbugs.timeout", defaultValue = "600000" ) int timeout
    
    Specifies the amount of time, in milliseconds, that FindBugs 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="findbugs.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="findbugs.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="findbugs.xmlOutput", required = true ) boolean xmlOutput
    
    Turn on and off xml output of the Findbugs 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
  - FindbugsViolationCheckMojo()
- Method Detail
  - void execute()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class FindbugsViolationCheckMojo

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@org.apache.maven.plugins.annotations.Component( role = ArtifactResolver.class ) org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

int bugCount

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

@org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.compileSourceRoots}', required = true, readonly = true ) java.util.List compileSourceRoots

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.debug" ) java.lang.Boolean debug

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "Default", property="findbugs.effort" ) java.lang.String effort

int errorCount

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.excludeBugsFile" ) java.lang.String excludeBugsFile

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.excludeFilterFile" ) java.lang.String excludeFilterFile

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.failOnError", defaultValue = "true" ) boolean failOnError

@java.lang.Deprecated @org.apache.maven.plugins.annotations.Parameter( defaultValue = "true" ) boolean findbugsXmlOutput

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

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.fork", defaultValue = "true" ) boolean fork

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.includeFilterFile" ) java.lang.String includeFilterFile

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.includeTests" ) boolean includeTests

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.jvmArgs" ) java.lang.String jvmArgs

@org.apache.maven.plugins.annotations.Parameter( property="localRepository", required = true, readonly = true ) org.apache.maven.artifact.repository.ArtifactRepository localRepository

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.maxHeap", defaultValue = "512" ) int maxHeap

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.maxRank" ) int maxRank

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.nested", defaultValue = "false" ) java.lang.Boolean nested

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.omitVisitors" ) java.lang.String omitVisitors

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.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", required = true, readonly = true ) java.util.List pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.pluginList" ) java.lang.String pluginList

@org.apache.maven.plugins.annotations.Parameter( property="project", required = true, readonly = true ) org.apache.maven.project.MavenProject project

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.relaxed" ) java.lang.Boolean relaxed

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

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

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

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

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.skip", defaultValue = "false" ) boolean skip

@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.testOutputDirectory}', required = true ) java.io.File testClassFilesDirectory

@org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.testCompileSourceRoots}', required = true, readonly = true ) java.util.List testSourceRoots

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "Default", property="findbugs.threshold" ) java.lang.String threshold

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.timeout", defaultValue = "600000" ) int timeout

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.trace", defaultValue = "false" ) java.lang.Boolean trace

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.visitors" ) java.lang.String visitors

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "UTF-8", readonly = true ) java.lang.String xmlEncoding

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.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

FindbugsViolationCheckMojo()

Method Detail

void execute()