com.github.spotbugs

Class SpotBugsExtension

java.lang.Object

org.gradle.api.plugins.quality.CodeQualityExtension

com.github.spotbugs.SpotBugsExtension

public class SpotBugsExtension
extends org.gradle.api.plugins.quality.CodeQualityExtension

Configuration options for the SpotBugs plugin. All options have sensible defaults. See the SpotBugs 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: "spotbugs" spotbugs { toolVersion = "2.0.1" sourceSets = [sourceSets.main] ignoreFailures = true reportsDir = file("$project.buildDir/spotbugsReports") effort = "max" reportLevel = "high" visitors = ["FindSqlInjection", "SwitchFallthrough"] omitVisitors = ["FindNonShortCircuit"] includeFilter = file("$rootProject.projectDir/config/spotbugs/includeFilter.xml") excludeFilter = file("$rootProject.projectDir/config/spotbugs/excludeFilter.xml") excludeBugsFilter = file("$rootProject.projectDir/config/spotbugs/excludeBugsFilter.xml") }

See Also:

SpotBugsPlugin

Constructor Summary

Constructors

Constructor and Description
SpotBugsExtension(org.gradle.api.Project project)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEffort() The analysis effort level.
java.io.File	getExcludeBugsFilter() The filename of a filter specifying baseline bugs to exclude from being reported.
org.gradle.api.resources.TextResource	getExcludeBugsFilterConfig() A filter specifying baseline bugs to exclude from being reported.
java.io.File	getExcludeFilter() The filename of a filter specifying bugs to exclude from being reported.
org.gradle.api.resources.TextResource	getExcludeFilterConfig() A filter specifying bugs to exclude from being reported.
java.util.Collection<java.lang.String>	getExtraArgs() Any additional arguments (not covered here more explicitly like effort) to be passed along to SpotBugs.
java.io.File	getIncludeFilter() The filename of a filter specifying which bugs are reported.
org.gradle.api.resources.TextResource	getIncludeFilterConfig() A filter specifying which bugs are reported.
java.util.Collection<java.lang.String>	getOmitVisitors() Similar to visitors except that it specifies bug detectors which should not be run.
java.lang.String	getReportLevel() The priority threshold for reporting bugs.
java.util.Collection<java.lang.String>	getVisitors() The bug detectors which should be run.
void	setEffort(java.lang.String effort)
void	setExcludeBugsFilter(java.io.File filter) The filename of a filter specifying baseline bugs to exclude from being reported.
void	setExcludeBugsFilterConfig(org.gradle.api.resources.TextResource excludeBugsFilterConfig)
void	setExcludeFilter(java.io.File filter) The filename of a filter specifying bugs to exclude from being reported.
void	setExcludeFilterConfig(org.gradle.api.resources.TextResource excludeFilterConfig)
void	setExtraArgs(java.util.Collection<java.lang.String> extraArgs)
void	setIncludeFilter(java.io.File filter) The filename of a filter specifying which bugs are reported.
void	setIncludeFilterConfig(org.gradle.api.resources.TextResource includeFilterConfig)
void	setOmitVisitors(java.util.Collection<java.lang.String> omitVisitors)
void	setReportLevel(java.lang.String reportLevel)
void	setVisitors(java.util.Collection<java.lang.String> visitors)

Methods inherited from class org.gradle.api.plugins.quality.CodeQualityExtension

getReportsDir, getSourceSets, getToolVersion, isIgnoreFailures, setIgnoreFailures, setReportsDir, setSourceSets, setToolVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpotBugsExtension

public SpotBugsExtension(org.gradle.api.Project project)

Method Detail

getEffort

public java.lang.String getEffort()

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.

Returns:

analysis effort level

setEffort

public void setEffort(java.lang.String effort)

Parameters:

effort - analysis effort level

getReportLevel

public java.lang.String getReportLevel()

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.

Returns:

priority threshold for reporting bugs

setReportLevel

public void setReportLevel(java.lang.String reportLevel)

Parameters:

reportLevel - priority threshold for reporting bugs

getVisitors

public java.util.Collection<java.lang.String> 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.

Returns:

bug detectors which should be run

setVisitors

public void setVisitors(java.util.Collection<java.lang.String> visitors)

Parameters:

visitors - bug detectors which should be run

getOmitVisitors

public java.util.Collection<java.lang.String> getOmitVisitors()

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

Returns:

bug detectors which should not be run

setOmitVisitors

public void setOmitVisitors(java.util.Collection<java.lang.String> omitVisitors)

Parameters:

omitVisitors - bug detectors which should not be run

getIncludeFilterConfig

@Incubating
public org.gradle.api.resources.TextResource getIncludeFilterConfig()

A filter specifying which bugs are reported. Replaces the includeFilter property.

Returns:

filter specifying which bugs are reported

Since:

2.2

setIncludeFilterConfig

@Incubating
public void setIncludeFilterConfig(org.gradle.api.resources.TextResource includeFilterConfig)

getIncludeFilter

public java.io.File getIncludeFilter()

The filename of a filter specifying which bugs are reported.

Returns:

filename of a filter specifying which bugs are reported

setIncludeFilter

public void setIncludeFilter(java.io.File filter)

The filename of a filter specifying which bugs are reported.

Parameters:

filter - filename of a filter specifying which bugs are reported

getExcludeFilterConfig

@Incubating
public org.gradle.api.resources.TextResource getExcludeFilterConfig()

A filter specifying bugs to exclude from being reported. Replaces the excludeFilter property.

Returns:

filter specifying bugs to exclude from being reported

Since:

2.2

setExcludeFilterConfig

@Incubating
public void setExcludeFilterConfig(org.gradle.api.resources.TextResource excludeFilterConfig)

Parameters:

excludeFilterConfig - filter specifying bugs to exclude from being reported

getExcludeFilter

public java.io.File getExcludeFilter()

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

Returns:

filename of a filter specifying bugs to exclude from being reported

setExcludeFilter

public void setExcludeFilter(java.io.File filter)

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

Parameters:

filter - filename of a filter specifying bugs to exclude from being reported

getExcludeBugsFilterConfig

@Incubating
public org.gradle.api.resources.TextResource getExcludeBugsFilterConfig()

A filter specifying baseline bugs to exclude from being reported.

Returns:

filter specifying baseline bugs to exclude from being report

Since:

2.4

setExcludeBugsFilterConfig

@Incubating
public void setExcludeBugsFilterConfig(org.gradle.api.resources.TextResource excludeBugsFilterConfig)

Parameters:

excludeBugsFilterConfig - filter specifying baseline bugs to exclude from being report

getExcludeBugsFilter

public java.io.File getExcludeBugsFilter()

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

Returns:

filename of a filter specifying baseline bugs to exclude from being reporte

setExcludeBugsFilter

public void setExcludeBugsFilter(java.io.File filter)

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

Parameters:

filter - filename of a filter specifying baseline bugs to exclude from being reported

getExtraArgs

public java.util.Collection<java.lang.String> getExtraArgs()

Any additional arguments (not covered here more explicitly like effort) to be passed along to SpotBugs.

Extra arguments are passed to SpotBugs 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 SpotBugs.

See the SpotBugs TextUICommandLine source for available options.

Returns:

any additional arguments (not covered here more explicitly like effort) to be passed along to SpotBugs

Since:

2.6

setExtraArgs

public void setExtraArgs(java.util.Collection<java.lang.String> extraArgs)

Parameters:

extraArgs - any additional arguments (not covered here more explicitly like effort) to be passed along to SpotBugs