Groovy Documentation

org.gradle.api.plugins.quality
[Groovy] Class FindBugsExtension

java.lang.Object
  org.gradle.api.plugins.quality.CodeQualityExtension
      org.gradle.api.plugins.quality.FindBugsExtension

class FindBugsExtension
extends CodeQualityExtension

Configuration options for the FindBugs plugin. All options have sensible defaults. See the FindBugs Manual for additional information on these options.

Below is a full configuration example. Since all properties have sensible defaults, typically only selected properties will be configured.

     apply plugin: "java"
     apply plugin: "findbugs"

     findbugs {
         toolVersion = "2.0.1"
         sourceSets = [sourceSets.main]
         ignoreFailures = true
         reportsDir = file("$project.buildDir/findbugsReports")
         effort = "max"
         reportLevel = "high"
         visitors = ["FindSqlInjection", "SwitchFallthrough"]
         omitVisitors = ["FindNonShortCircuit"]
         includeFilter = file("$rootProject.projectDir/config/findbugs/includeFilter.xml")
         excludeFilter = file("$rootProject.projectDir/config/findbugs/excludeFilter.xml")
     }
 
See Also:
FindBugsPlugin


Property Summary
String effort

The analysis effort level.

File excludeFilter

The filename of a filter specifying bugs to exclude from being reported.

File includeFilter

The filename of a filter specifying which bugs are reported.

Collection omitVisitors

Similar to visitors except that it specifies bug detectors which should not be run.

String reportLevel

The priority threshold for reporting bugs.

Collection visitors

The bug detectors which should be run.

 

Property Detail

effort

String effort
The analysis effort level. The value specified should be one of min, default, or max. Higher levels increase precision and find more bugs at the expense of running time and memory consumption.


excludeFilter

File excludeFilter
The filename of a filter specifying bugs to exclude from being reported.


includeFilter

File includeFilter
The filename of a filter specifying which bugs are reported.


omitVisitors

Collection omitVisitors
Similar to visitors except that it specifies bug detectors which should not be run. By default, no visitors are omitted.


reportLevel

String reportLevel
The priority threshold for reporting bugs. If set to low, all bugs are reported. If set to medium (the default), medium and high priority bugs are reported. If set to high, only high priority bugs are reported.


visitors

Collection visitors
The bug detectors which should be run. The bug detectors are specified by their class names, without any package qualification. By default, all detectors which are not disabled by default are run.


 

Gradle API 1.7