public class FindBugsExtension extends CodeQualityExtension
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") excludeBugsFilter = file("$rootProject.projectDir/config/findbugs/excludeBugsFilter.xml") }
FindBugsPlugin
Constructor and Description |
---|
FindBugsExtension(Project project) |
Modifier and Type | Method and Description |
---|---|
String |
getEffort()
The analysis effort level.
|
File |
getExcludeBugsFilter()
The filename of a filter specifying baseline bugs to exclude from being reported.
|
TextResource |
getExcludeBugsFilterConfig()
A filter specifying baseline bugs to exclude from being reported.
|
File |
getExcludeFilter()
The filename of a filter specifying bugs to exclude from being reported.
|
TextResource |
getExcludeFilterConfig()
A filter specifying bugs to exclude from being reported.
|
Collection<String> |
getExtraArgs()
Any additional arguments (not covered here more explicitly like
effort ) to be passed along to FindBugs. |
File |
getIncludeFilter()
The filename of a filter specifying which bugs are reported.
|
TextResource |
getIncludeFilterConfig()
A filter specifying which bugs are reported.
|
Collection<String> |
getOmitVisitors()
Similar to
visitors except that it specifies bug detectors which should not be run. |
String |
getReportLevel()
The priority threshold for reporting bugs.
|
Collection<String> |
getVisitors()
The bug detectors which should be run.
|
void |
setEffort(String effort) |
void |
setExcludeBugsFilter(File filter)
The filename of a filter specifying baseline bugs to exclude from being reported.
|
void |
setExcludeBugsFilterConfig(TextResource excludeBugsFilterConfig) |
void |
setExcludeFilter(File filter)
The filename of a filter specifying bugs to exclude from being reported.
|
void |
setExcludeFilterConfig(TextResource excludeFilterConfig) |
void |
setExtraArgs(Collection<String> extraArgs) |
void |
setIncludeFilter(File filter)
The filename of a filter specifying which bugs are reported.
|
void |
setIncludeFilterConfig(TextResource includeFilterConfig) |
void |
setOmitVisitors(Collection<String> omitVisitors) |
void |
setReportLevel(String reportLevel) |
void |
setVisitors(Collection<String> visitors) |
getReportsDir, getSourceSets, getToolVersion, isIgnoreFailures, setIgnoreFailures, setReportsDir, setSourceSets, setToolVersion
public FindBugsExtension(Project project)
public String getEffort()
min
, default
, or max
.
Higher levels increase precision and find more bugs at the expense of running time and memory consumption.public void setEffort(String effort)
public String getReportLevel()
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.public void setReportLevel(String reportLevel)
public Collection<String> getVisitors()
public void setVisitors(Collection<String> visitors)
public Collection<String> getOmitVisitors()
visitors
except that it specifies bug detectors which should not be run.
By default, no visitors are omitted.public void setOmitVisitors(Collection<String> omitVisitors)
@Incubating public TextResource getIncludeFilterConfig()
includeFilter
property.@Incubating public void setIncludeFilterConfig(TextResource includeFilterConfig)
public File getIncludeFilter()
public void setIncludeFilter(File filter)
@Incubating public TextResource getExcludeFilterConfig()
excludeFilter
property.@Incubating public void setExcludeFilterConfig(TextResource excludeFilterConfig)
public File getExcludeFilter()
public void setExcludeFilter(File filter)
@Incubating public TextResource getExcludeBugsFilterConfig()
@Incubating public void setExcludeBugsFilterConfig(TextResource excludeBugsFilterConfig)
public File getExcludeBugsFilter()
public void setExcludeBugsFilter(File filter)
public Collection<String> getExtraArgs()
effort
) 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.
public void setExtraArgs(Collection<String> extraArgs)