com.github.spotbugs

Class SpotBugsTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

com.github.spotbugs.SpotBugsTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.reporting.Reporting<SpotBugsReports>, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.api.tasks.VerificationTask, org.gradle.util.Configurable<org.gradle.api.Task>

@CacheableTask
public class SpotBugsTask
extends org.gradle.api.tasks.SourceTask
implements org.gradle.api.tasks.VerificationTask, org.gradle.api.reporting.Reporting<SpotBugsReports>

Analyzes code with SpotBugs. See the SpotBugs Manual for additional information on configuration options.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from class org.gradle.api.tasks.SourceTask

source

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
SpotBugsTask()

Method Summary

Modifier and Type	Method and Description
SpotBugsTask	extraArgs(java.lang.Iterable<java.lang.String> arguments)
SpotBugsTask	extraArgs(java.lang.String... arguments)
org.gradle.api.file.FileCollection	getClasses() The classes to be analyzed.
org.gradle.api.file.FileCollection	getClasspath() Compile class path for the classes to be analyzed.
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.
boolean	getIgnoreFailures() Whether or not to allow the build to continue if there are warnings.
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.
org.gradle.internal.reflect.Instantiator	getInstantiator()
java.lang.String	getMaxHeapSize() The maximum heap size for the forked spotbugs process (ex: '1g').
java.util.Collection<java.lang.String>	getOmitVisitors() Similar to visitors except that it specifies bug detectors which should not be run.
org.gradle.api.file.FileCollection	getPluginClasspath() Class path holding any additional SpotBugs plugins.
java.lang.String	getReportLevel() The priority threshold for reporting bugs.
SpotBugsReports	getReports() The reports to be generated by this task.
org.gradle.api.file.FileTree	getSource()
org.gradle.api.file.FileCollection	getSpotbugsClasspath() Class path holding the SpotBugs library.
java.util.Collection<java.lang.String>	getVisitors() The bug detectors which should be run.
org.gradle.process.internal.worker.WorkerProcessFactory	getWorkerProcessBuilderFactory()
SpotBugsReports	reports(org.gradle.api.Action<? super SpotBugsReports> configureAction) Configures the reports to be generated by this task.
SpotBugsReports	reports(groovy.lang.Closure closure) Configures the reports to be generated by this task.
void	run()
void	setClasses(org.gradle.api.file.FileCollection classes)
void	setClasspath(org.gradle.api.file.FileCollection classpath)
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	setIgnoreFailures(boolean ignoreFailures)
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	setMaxHeapSize(java.lang.String maxHeapSize)
void	setOmitVisitors(java.util.Collection<java.lang.String> omitVisitors)
void	setPluginClasspath(org.gradle.api.file.FileCollection pluginClasspath)
void	setReportLevel(java.lang.String reportLevel)
void	setSpotbugsClasspath(org.gradle.api.file.FileCollection spotbugsClasspath)
void	setVisitors(java.util.Collection<java.lang.String> visitors)

Methods inherited from class org.gradle.api.tasks.SourceTask

exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, newInputFile, newOutputDirectory, newOutputFile, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SpotBugsTask

public SpotBugsTask()

Method Detail

getInstantiator

@Inject
public org.gradle.internal.reflect.Instantiator getInstantiator()

getWorkerProcessBuilderFactory

@Inject
public org.gradle.process.internal.worker.WorkerProcessFactory getWorkerProcessBuilderFactory()

getReports

public SpotBugsReports getReports()

The reports to be generated by this task.

Specified by:

getReports in interface org.gradle.api.reporting.Reporting<SpotBugsReports>

Returns:

The reports container

reports

public SpotBugsReports reports(groovy.lang.Closure closure)

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

 spotbugsTask {
   reports {
     xml {
       destination "build/spotbugs.xml"
     }
   }
 }
 

Specified by:

reports in interface org.gradle.api.reporting.Reporting<SpotBugsReports>

Parameters:

closure - The configuration

Returns:

The reports container

reports

public SpotBugsReports reports(org.gradle.api.Action<? super SpotBugsReports> configureAction)

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

 spotbugsTask {
   reports {
     xml {
       destination "build/spotbugs.xml"
     }
   }
 }
 

Specified by:

reports in interface org.gradle.api.reporting.Reporting<SpotBugsReports>

Parameters:

configureAction - The configuration

Returns:

The reports container

getIncludeFilter

@Internal
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 report

getExcludeFilter

@Internal
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

getExcludeBugsFilter

@Internal
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 reported

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

run

public void run()
         throws java.io.IOException,
                java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

extraArgs

public SpotBugsTask extraArgs(java.lang.Iterable<java.lang.String> arguments)

extraArgs

public SpotBugsTask extraArgs(java.lang.String... arguments)

getSource

@PathSensitive(value=RELATIVE)
public org.gradle.api.file.FileTree getSource()

Overrides:

getSource in class org.gradle.api.tasks.SourceTask

getClasses

@SkipWhenEmpty
 @PathSensitive(value=RELATIVE)
 @InputFiles
public org.gradle.api.file.FileCollection getClasses()

The classes to be analyzed.

Returns:

classes to be analyzed

setClasses

public void setClasses(org.gradle.api.file.FileCollection classes)

Parameters:

classes - classes to be analyzed

getClasspath

@Classpath
public org.gradle.api.file.FileCollection getClasspath()

Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves.

Returns:

compile class path for the classes to be analyze

setClasspath

public void setClasspath(org.gradle.api.file.FileCollection classpath)

Parameters:

classpath - compile class path for the classes to be analyze

getSpotbugsClasspath

@Classpath
public org.gradle.api.file.FileCollection getSpotbugsClasspath()

Class path holding the SpotBugs library.

Returns:

class path holding the SpotBugs library

setSpotbugsClasspath

public void setSpotbugsClasspath(org.gradle.api.file.FileCollection spotbugsClasspath)

Parameters:

spotbugsClasspath - class path holding the SpotBugs library

getPluginClasspath

@Classpath
public org.gradle.api.file.FileCollection getPluginClasspath()

Class path holding any additional SpotBugs plugins.

Returns:

class path holding any additional SpotBugs plugin

setPluginClasspath

public void setPluginClasspath(org.gradle.api.file.FileCollection pluginClasspath)

Parameters:

pluginClasspath - class path holding any additional SpotBugs plugin

getIgnoreFailures

@Input
public boolean getIgnoreFailures()

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

Specified by:

getIgnoreFailures in interface org.gradle.api.tasks.VerificationTask

setIgnoreFailures

public void setIgnoreFailures(boolean ignoreFailures)

Specified by:

setIgnoreFailures in interface org.gradle.api.tasks.VerificationTask

getEffort

@Input
 @Optional
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

@Input
 @Optional
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

getMaxHeapSize

@Input
 @Optional
public java.lang.String getMaxHeapSize()

The maximum heap size for the forked spotbugs process (ex: '1g').

Returns:

maximum heap size

setMaxHeapSize

public void setMaxHeapSize(java.lang.String maxHeapSize)

Parameters:

maxHeapSize - maximum heap size

getVisitors

@Input
 @Optional
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

@Input
 @Optional
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
 @Optional
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

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

Parameters:

includeFilterConfig - filter specifying which bugs are reported

getExcludeFilterConfig

@Incubating
 @Optional
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

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

Parameters:

excludeFilterConfig - filter specifying bugs to exclude from being reported

getExcludeBugsFilterConfig

@Incubating
 @Optional
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 reported

setExcludeBugsFilterConfig

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

Parameters:

excludeBugsFilterConfig - filter specifying baseline bugs to exclude from being reported

getExtraArgs

@Input
 @Optional
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