findbugs:findbugs

Note: This Mojo should be used as a Maven report.

Full name:

org.codehaus.mojo:findbugs-maven-plugin:2.0-SNAPSHOT:findbugs

Description:

Generates a FindBugs Report when the site plugin is run. The HTML report is generated for site commands only. The optional report formats are generated for both the site commands.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Invokes the execution of the lifecycle phase compile prior to executing itself.

Required Parameters

Name Type Since Description
classFilesDirectory File - Directory containing the class files for FindBugs to analyze. Default value is: ${project.build.outputDirectory}.
findbugsXmlOutputDirectory File 1.2.0 Specifies the directory where the findbugs native xml output will be generated. Default value is: ${project.build.directory}.
outputDirectory String - Location where generated html will be created. Default value is: ${project.reporting.outputDirectory}.
xmlOutputDirectory File 1.0.0 Specifies the directory where the xml output will be generated. Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
debug Boolean - turn on Findbugs debugging Default value is: false.
effort String 1.0-beta-1 Effort of the bug finders. Valid values are Min, Default and Max.
excludeFilterFile String 1.0-beta-1 File name of the exclude filter. Bugs matching the filters are not reported.
findbugsXmlOutput boolean 1.2.0 Turn on and off findbugs native xml output of the Findbugs report. Default value is: false.
findbugsXmlWithMessages boolean 1.2.0 Turn on and off xml output of the Findbugs report. Default value is: false.
includeFilterFile String 1.0-beta-1 File name of the include filter. Only bugs in matching the filters are reported.
omitVisitors String 1.0-beta-1 The visitor list to omit. This is a comma-delimited list.
onlyAnalyze String 1.1 Restrict analysis to find bugs to given comma-separated list of classes and packages.
pluginList String 1.0-beta-1 The plugin list to include in the report. This is a comma-delimited list.
relaxed Boolean 1.1 Relaxed reporting mode. For many detectors, this option suppresses the heuristics used to avoid reporting false positives. Default value is: false.
skip boolean 1.1 Skip entire check. Default value is: false.
threshold String - Threshold of minimum bug severity to report. Valid values are High, Default, Low, Ignore, and Exp (for experimental).
visitors String 1.0-beta-1 The visitor list to run. This is a comma-delimited list.
xmlOutput boolean 1.0.0 Turn on and off xml output of the Findbugs report. Default value is: false.

Parameter Details

classFilesDirectory:

Directory containing the class files for FindBugs to analyze.

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

turn on Findbugs debugging

  • Type: java.lang.Boolean
  • Required: No
  • Default: false
effort:

Effort of the bug finders. Valid values are Min, Default and Max.

  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
excludeFilterFile:

File name of the exclude filter. Bugs matching the filters are not reported.

  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
findbugsXmlOutput:

Turn on and off findbugs native xml output of the Findbugs report.

  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • Default: false
findbugsXmlOutputDirectory:

Specifies the directory where the findbugs native xml output will be generated.

  • Type: java.io.File
  • Since: 1.2.0
  • Required: Yes
  • Default: ${project.build.directory}
findbugsXmlWithMessages:

Turn on and off xml output of the Findbugs report.

  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • Default: false
includeFilterFile:

File name of the include filter. Only bugs in matching the filters are reported.

  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
omitVisitors:

The visitor list to omit. This is a comma-delimited list.

  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
onlyAnalyze:

Restrict analysis to find bugs to given comma-separated list of classes and packages.

  • Type: java.lang.String
  • Since: 1.1
  • Required: No
outputDirectory:

Location where generated html will be created.

  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}
pluginList:

The plugin list to include in the report. This is a comma-delimited list.

  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
relaxed:

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

  • Type: java.lang.Boolean
  • Since: 1.1
  • Required: No
  • Default: false
skip:

Skip entire check.

  • Type: boolean
  • Since: 1.1
  • Required: No
  • Expression: ${findbugs.skip}
  • Default: false
threshold:

Threshold of minimum bug severity to report. Valid values are High, Default, Low, Ignore, and Exp (for experimental).

  • Type: java.lang.String
  • Required: No
visitors:

The visitor list to run. This is a comma-delimited list.

  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
xmlOutput:

Turn on and off xml output of the Findbugs report.

  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • Default: false
xmlOutputDirectory:

Specifies the directory where the xml output will be generated.

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