| API Documentation: | FindBugs |
|---|
Analyzes code withFindBugs. See theFindBugs Manual for additional information on configurationoptions.
| Property | Description |
classes | The class directories to be analyzed. |
classpath | Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves. |
effort | The analysis effort level. The value specified should be one of |
excludeFilter | The filename of a filter specifying bugs to exclude from being reported. |
excludeFilterConfig | Incubating A filter specifying bugs to exclude from being reported. Replaces the |
excludes | The set of exclude patterns. |
findbugsClasspath | Class path holding the FindBugs library. |
ignoreFailures | Whether to allow the build to continue if there are warnings. |
includeFilter | The filename of a filter specifying which bugs are reported. |
includeFilterConfig | Incubating A filter specifying which bugs are reported. Replaces the |
includes | The set of include patterns. |
maxHeapSize | The maximum heap size for the forked findbugs process (ex: '1g'). |
omitVisitors | Similar to |
pluginClasspath | Class path holding any additional FindBugs plugins. |
reportLevel | The priority threshold for reporting bugs. If set to |
reports | The reports to be generated by this task. |
showProgress | Indicates whether analysis progress should be rendered on standard output. Defaults to false. |
source | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist. |
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 arerun. |
| Method | Description |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included. |
reports(configureAction) | Configures the reports to be generated by this task.The contained reports can be configured by name and closures. Example: |
source(sources) | Adds some source to this task. The given source objects will be evaluated as per |
| Block | Description |
reports | Configures the reports to be generated by this task.The contained reports can be configured by name and closures. Example: |
FileCollectionclasses
The class directories to be analyzed.
- Default with
findbugsplugin: sourceSet.output.classesDirs
FileCollectionclasspath
Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves.
- Default with
findbugsplugin: sourceSet.compileClasspath
Stringeffort
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 timeand memory consumption.
- Default with
findbugsplugin: project.findbugs.effort
FileexcludeFilter
The filename of a filter specifying bugs to exclude from being reported.
- Default with
findbugsplugin: project.findbugs.excludeFilter
TextResourceexcludeFilterConfig
Note: This property isincubating and may change in a future version of Gradle.
A filter specifying bugs to exclude from being reported. Replaces theexcludeFilter property.
- Default with
findbugsplugin: project.findbugs.excludeFilterConfig
FileCollectionfindbugsClasspath
Class path holding the FindBugs library.
- Default with
findbugsplugin: project.configurations.findbugs
Whether to allow the build to continue if there are warnings.
- Default with
findbugsplugin: project.findbugs.ignoreFailures
FileincludeFilter
The filename of a filter specifying which bugs are reported.
- Default with
findbugsplugin: project.findbugs.includeFilter
TextResourceincludeFilterConfig
Note: This property isincubating and may change in a future version of Gradle.
A filter specifying which bugs are reported. Replaces theincludeFilter property.
- Default with
findbugsplugin: project.findbugs.includeFilterConfig
StringmaxHeapSize
The maximum heap size for the forked findbugs process (ex: '1g').
- Default with
findbugsplugin: null
Collection<String>omitVisitors
Collection<String>Similar tovisitors except that it specifies bug detectors which should not be run. By default, no visitors are omitted.
- Default with
findbugsplugin: project.findbugs.omitVisitors
FileCollectionpluginClasspath
Class path holding any additional FindBugs plugins.
- Default with
findbugsplugin: project.configurations.findbugsPlugins
StringreportLevel
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.
- Default with
findbugsplugin: project.findbugs.reportLevel
FindBugsReportsreports (read-only)
The reports to be generated by this task.
Indicates whether analysis progress should be rendered on standard output. Defaults to false.
- Default with
findbugsplugin: project.findbugs.showProgress
FileTreesource (read-only)
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
- Default with
findbugsplugin: sourceSet.allJava
Collection<String>visitors
Collection<String>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 arerun.
- Default with
findbugsplugin: project.findbugs.visitors
SourceTaskexclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElement as its parameter. The closure should return true or false. Example:
copySpec { from'source' into'destination'//an example of excluding files from certain configuration: exclude { it.file in configurations.someConf.files }}If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskinclude(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElement as its parameter.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
SourceTaskinclude(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
SourceTaskinclude(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
SourceTaskinclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
FindBugsReportsreports(Action<? superFindBugsReports>
Action<? superFindBugsReports>Configures the reports to be generated by this task.The contained reports can be configured by name and closures. Example:
findbugsTask { reports { xml { destination"build/findbugs.xml" } }}SourceTasksource(Object...
Object...Adds some source to this task. The given source objects will be evaluated as perProject.files(java.lang.Object[]).
Configures the reports to be generated by this task.The contained reports can be configured by name and closures. Example:
findbugsTask { reports { xml { destination"build/findbugs.xml" } }}- Delegates to:
FindBugsReportsfromreports