FindBugs

API Documentation:FindBugs

Analyzes code with FindBugs.

Properties

PropertyDescription
classes

The classes 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.

excludes

The set of exclude patterns.

findbugsClasspath

Class path holding the FindBugs library.

ignoreFailures

Whether or not to allow the build to continue if there are warnings.

includes

The set of include patterns.

pluginClasspath

Class path holding any additional FindBugs plugins.

reports

The reports to be generated by this task.

source

The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

Property details

The classes to be analyzed.

Default with pmd plugin:
sourceSet.output

FileCollection 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.

Default with pmd plugin:
sourceSet.compileClasspath

Set<String> excludes

The set of exclude patterns.

FileCollection findbugsClasspath

Class path holding the FindBugs library.

Default with pmd plugin:
project.configurations.findbugs

boolean ignoreFailures

Whether or not to allow the build to continue if there are warnings.

Default with pmd plugin:
project.findbugs.ignoreFailures

Set<String> includes

The set of include patterns.

FileCollection pluginClasspath

Class path holding any additional FindBugs plugins.

Default with pmd plugin:
project.configurations.findbugsPlugins

FindBugsReports reports (read-only)

The reports to be generated by this task.

FileTree source

The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

Default with pmd plugin:
sourceSet.allJava

Script blocks

BlockDescription
reports

Configures the reports to be generated by this task. The contained reports can be configured by name and closures. Example:

Script block details

reports { }

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:
FindBugsReports from reports

Methods

MethodDescription
exclude(excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a FileTreeElement as its parameter. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any 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 multiple patterns 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 match any 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 multiple patterns 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 match any 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 match any 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 FileTreeElement as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

include(includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file 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 multiple patterns 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 a file 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 a file must match at least one of the include patterns or specs to be included.

source(sources)

Adds some source to this task. The given source objects will be evaluated as for Project.files().

Method details

SourceTask exclude(Closure excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a FileTreeElement as its parameter. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

SourceTask exclude(Iterable<String> excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.

SourceTask exclude(String... excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.

SourceTask exclude(Spec<FileTreeElement> 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 match any exclude pattern to be processed.

SourceTask include(Closure includeSpec)

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a FileTreeElement as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

SourceTask include(Iterable<String> includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.

SourceTask include(String... includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.

SourceTask include(Spec<FileTreeElement> 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 a file must match at least one of the include patterns or specs to be included.

SourceTask source(Object... sources)

Adds some source to this task. The given source objects will be evaluated as for Project.files().