com.github.spotbugs

Class SpotBugsPlugin

java.lang.Object

org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

com.github.spotbugs.SpotBugsPlugin

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.internal.project.ProjectInternal>

public class SpotBugsPlugin
extends org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

A plugin for the SpotBugs byte code analyzer.

Declares a spotbugs configuration which needs to be configured with the SpotBugs library to be used. Additional plugins can be added to the spotbugsPlugins configuration.

For projects that have the Java (base) plugin applied, a SpotBugsTask task is created for each source set.

See Also:

SpotBugsTask, SpotBugsExtension

Field Summary

Fields inherited from class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin

project

Constructor Summary

Constructors

Constructor and Description
SpotBugsPlugin()

Method Summary

Modifier and Type	Method and Description
protected void	beforeApply()
protected void	configureConfiguration(org.gradle.api.artifacts.Configuration configuration)
protected void	configureForSourceSet(org.gradle.api.tasks.SourceSet sourceSet, SpotBugsTask task)
protected void	configureTaskDefaults(SpotBugsTask task, java.lang.String baseName)
protected void	createConfigurations() Overriding this method, to include SLF4J into spotbugsClasspath.
protected org.gradle.api.plugins.quality.CodeQualityExtension	createExtension()
protected java.lang.Class<SpotBugsTask>	getTaskType()
protected java.lang.String	getToolName()

Methods inherited from class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin

apply, conventionMappingOf, getBasePlugin, getConfigurationName, getJavaPluginConvention, getReportName, getTaskBaseName, withBasePlugin

Methods inherited from class java.lang.Object

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

Constructor Detail

SpotBugsPlugin

public SpotBugsPlugin()

Method Detail

getToolName

protected java.lang.String getToolName()

Specified by:

getToolName in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

getTaskType

protected java.lang.Class<SpotBugsTask> getTaskType()

Specified by:

getTaskType in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

beforeApply

protected void beforeApply()

Overrides:

beforeApply in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

createExtension

protected org.gradle.api.plugins.quality.CodeQualityExtension createExtension()

Specified by:

createExtension in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

configureTaskDefaults

protected void configureTaskDefaults(SpotBugsTask task,
                                     java.lang.String baseName)

Overrides:

configureTaskDefaults in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

configureConfiguration

protected void configureConfiguration(org.gradle.api.artifacts.Configuration configuration)

Specified by:

configureConfiguration in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

createConfigurations

protected void createConfigurations()

Overriding this method, to include SLF4J into spotbugsClasspath. SLF4J is necessary in worker process.

Overrides:

createConfigurations in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>

configureForSourceSet

protected void configureForSourceSet(org.gradle.api.tasks.SourceSet sourceSet,
                                     SpotBugsTask task)

Overrides:

configureForSourceSet in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin<SpotBugsTask>