Class FindBugsExtension
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" showProgress = true reportLevel = "high" visitors = ["FindSqlInjection", "SwitchFallthrough"] omitVisitors = ["FindNonShortCircuit"] includeFilter = file("$rootProject.projectDir/config/findbugs/includeFilter.xml") excludeFilter = file("$rootProject.projectDir/config/findbugs/excludeFilter.xml") excludeBugsFilter = file("$rootProject.projectDir/config/findbugs/excludeBugsFilter.xml") }
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe analysis effort level.The filename of a filter specifying baseline bugs to exclude from being reported.A filter specifying baseline bugs to exclude from being reported.The filename of a filter specifying bugs to exclude from being reported.A filter specifying bugs to exclude from being reported.Any additional arguments (not covered here more explicitly likeeffort
) to be passed along to FindBugs.The filename of a filter specifying which bugs are reported.A filter specifying which bugs are reported.Any additional arguments to be passed along to FindBugs JVM process.Similar tovisitors
except that it specifies bug detectors which should not be run.The priority threshold for reporting bugs.The bug detectors which should be run.boolean
Indicates whether analysis progress should be rendered on standard output.void
The analysis effort level.void
setExcludeBugsFilter
(File filter) The filename of a filter specifying baseline bugs to exclude from being reported.void
setExcludeBugsFilterConfig
(TextResource excludeBugsFilterConfig) A filter specifying baseline bugs to exclude from being reported.void
setExcludeFilter
(File filter) The filename of a filter specifying bugs to exclude from being reported.void
setExcludeFilterConfig
(TextResource excludeFilterConfig) A filter specifying bugs to exclude from being reported.void
setExtraArgs
(Collection<String> extraArgs) Any additional arguments (not covered here more explicitly likeeffort
) to be passed along to FindBugs.void
setIncludeFilter
(File filter) The filename of a filter specifying which bugs are reported.void
setIncludeFilterConfig
(TextResource includeFilterConfig) A filter specifying which bugs are reported.void
setJvmArgs
(Collection<String> jvmArgs) Any additional arguments to be passed along to FindBugs JVM process.void
setOmitVisitors
(Collection<String> omitVisitors) Similar tovisitors
except that it specifies bug detectors which should not be run.void
setReportLevel
(String reportLevel) The priority threshold for reporting bugs.void
setShowProgress
(boolean showProgress) Indicates whether analysis progress should be rendered on standard output.void
setVisitors
(Collection<String> visitors) The bug detectors which should be run.Methods inherited from class org.gradle.api.plugins.quality.CodeQualityExtension
getReportsDir, getSourceSets, getToolVersion, isIgnoreFailures, setIgnoreFailures, setReportsDir, setSourceSets, setToolVersion
-
Constructor Details
-
FindBugsExtension
-
-
Method Details
-
getEffort
The analysis effort level. The value specified should be one ofmin
,default
, ormax
. Higher levels increase precision and find more bugs at the expense of running time and memory consumption. -
setEffort
The analysis effort level. The value specified should be one ofmin
,default
, ormax
. Higher levels increase precision and find more bugs at the expense of running time and memory consumption. -
getReportLevel
The priority threshold for reporting bugs. If set tolow
, all bugs are reported. If set tomedium
(the default), medium and high priority bugs are reported. If set tohigh
, only high priority bugs are reported. -
setReportLevel
The priority threshold for reporting bugs. If set tolow
, all bugs are reported. If set tomedium
(the default), medium and high priority bugs are reported. If set tohigh
, only high priority bugs are reported. -
getVisitors
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. -
setVisitors
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. -
getOmitVisitors
Similar tovisitors
except that it specifies bug detectors which should not be run. By default, no visitors are omitted. -
setOmitVisitors
Similar tovisitors
except that it specifies bug detectors which should not be run. By default, no visitors are omitted. -
getIncludeFilterConfig
A filter specifying which bugs are reported. Replaces theincludeFilter
property.- Since:
- 2.2
-
setIncludeFilterConfig
A filter specifying which bugs are reported. Replaces theincludeFilter
property.- Since:
- 2.2
-
getIncludeFilter
The filename of a filter specifying which bugs are reported. -
setIncludeFilter
The filename of a filter specifying which bugs are reported. -
getExcludeFilterConfig
A filter specifying bugs to exclude from being reported. Replaces theexcludeFilter
property.- Since:
- 2.2
-
setExcludeFilterConfig
A filter specifying bugs to exclude from being reported. Replaces theexcludeFilter
property.- Since:
- 2.2
-
getExcludeFilter
The filename of a filter specifying bugs to exclude from being reported. -
setExcludeFilter
The filename of a filter specifying bugs to exclude from being reported. -
getExcludeBugsFilterConfig
A filter specifying baseline bugs to exclude from being reported.- Since:
- 2.4
-
setExcludeBugsFilterConfig
A filter specifying baseline bugs to exclude from being reported.- Since:
- 2.4
-
getExcludeBugsFilter
The filename of a filter specifying baseline bugs to exclude from being reported. -
setExcludeBugsFilter
The filename of a filter specifying baseline bugs to exclude from being reported. -
getExtraArgs
Any additional arguments (not covered here more explicitly likeeffort
) to be passed along to FindBugs.Extra arguments are passed to FindBugs after the arguments Gradle understands (like
effort
but before the list of classes to analyze. This should only be used for arguments that cannot be provided by Gradle directly. Gradle does not try to interpret or validate the arguments before passing them to FindBugs.See the FindBugs TextUICommandLine source for available options.
- Since:
- 2.6
-
setExtraArgs
Any additional arguments (not covered here more explicitly likeeffort
) to be passed along to FindBugs.Extra arguments are passed to FindBugs after the arguments Gradle understands (like
effort
but before the list of classes to analyze. This should only be used for arguments that cannot be provided by Gradle directly. Gradle does not try to interpret or validate the arguments before passing them to FindBugs.See the FindBugs TextUICommandLine source for available options.
- Since:
- 2.6
-
getJvmArgs
Any additional arguments to be passed along to FindBugs JVM process.Arguments can contain general JVM flags like
-Xdebug
and also FindBugs system properties like-Dfindbugs.loadPropertiesFrom=...
- Since:
- 4.3
-
setJvmArgs
Any additional arguments to be passed along to FindBugs JVM process.Arguments can contain general JVM flags like
-Xdebug
and also FindBugs system properties like-Dfindbugs.loadPropertiesFrom=...
- Since:
- 4.3
-
isShowProgress
Indicates whether analysis progress should be rendered on standard output. Defaults to false.- Since:
- 4.2
-
setShowProgress
Indicates whether analysis progress should be rendered on standard output.- Since:
- 4.2
-