findbugs:gui

Full name:

org.codehaus.mojo:findbugs-maven-plugin:2.4.1-SNAPSHOT:gui

Description:

Launch the Findbugs GUI. It will use all the parameters in the POM fle.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 2.0.

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}.
findbugsXmlOutputDirectory File 2.0 Specifies the directory where the findbugs native 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.
encoding String 2.2 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. Note: This parameter always overrides the property charset from Checkstyle's TreeWalker module.
Default value is: ${project.build.sourceEncoding}.
maxHeap int 2.2 Maximum Java heap size in megabytes (default=512).
Default value is: 512.
pluginList String 2.0 The plugin list to include in the report. This is a FindBugsInfo.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

encoding:

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. Note: This parameter always overrides the property charset from Checkstyle's TreeWalker module.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

findbugsXmlOutputDirectory:

Specifies the directory where the findbugs native xml output will be generated.
  • Type: java.io.File
  • Since: 2.0
  • Required: Yes
  • Default: ${project.build.directory}

maxHeap:

Maximum Java heap size in megabytes (default=512).
  • Type: int
  • Since: 2.2
  • Required: No
  • Default: 512

pluginList:

The plugin list to include in the report. This is a FindBugsInfo.COMMA-delimited list.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No