findbugs:check

Full name:

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

Description:

Fail the build if Findbugs finds an error. An XML report is put out by default in the target directory with the errors.

Attributes:

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

Required Parameters

Name Type Since Description
classFilesDirectory File 2.0 Directory containing the class files for FindBugs to analyze. Default value is: ${project.build.outputDirectory}.
findbugsCheckOutputDirectory File 2.0 Specifies the directory where the findbugs xml output will be generated. Default value is: ${project.build.directory}.

Optional Parameters

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

Parameter Details

classFilesDirectory:

Directory containing the class files for FindBugs to analyze.

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

turn on Findbugs debugging

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

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

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Default: Default
excludeFilterFile:

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

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
findbugsCheckOutputDirectory:

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

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

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

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
omitVisitors:

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

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
onlyAnalyze:

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

  • Type: java.lang.String
  • Since: 2.0
  • Required: No
pluginList:

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

  • Type: java.lang.String
  • Since: 2.0
  • 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: 2.0
  • Required: No
  • Default: false
skip:

Skip entire check.

  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${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
  • Since: 2.0
  • Required: No
  • Default: Default
visitors:

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

  • Type: java.lang.String
  • Since: 2.0
  • Required: No