Package org.gradle.api.plugins.quality

Class CodeQualityExtension

java.lang.Object

org.gradle.api.plugins.quality.CodeQualityExtension

Direct Known Subclasses:

CheckstyleExtension, CodeNarcExtension, PmdExtension

public abstract class CodeQualityExtension
extends Object

Base Code Quality Extension.

Constructor Summary

Constructors

Constructor	Description
CodeQualityExtension()

Method Summary

Modifier and Type	Method	Description
abstract Property<Boolean>	getIgnoreFailures()	Whether to allow the build to continue if there are warnings.
Property<Boolean>	getIsIgnoreFailures()
abstract DirectoryProperty	getReportsDir()	The directory where reports will be generated.
abstract ListProperty<SourceSet>	getSourceSets()	The source sets to be analyzed as part of the check and build tasks.
abstract Property<String>	getToolVersion()	The version of the code quality tool to be used.
void	setIgnoreFailures(boolean ignoreFailures)	Whether to allow the build to continue if there are warnings.
void	setReportsDir(File reportsDir)	The directory where reports will be generated.
void	setSourceSets(Collection<SourceSet> sourceSets)	The source sets to be analyzed as part of the check and build tasks.
void	setToolVersion(String toolVersion)	The version of the code quality tool to be used.

Methods inherited from class java.lang.Object

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

Constructor Details

CodeQualityExtension

public CodeQualityExtension()

Method Details

getToolVersion

public abstract Property<String> getToolVersion()

The version of the code quality tool to be used.

setToolVersion

public void setToolVersion(String toolVersion)

The version of the code quality tool to be used.

getSourceSets

public abstract ListProperty<SourceSet> getSourceSets()

The source sets to be analyzed as part of the check and build tasks.

setSourceSets

public void setSourceSets(Collection<SourceSet> sourceSets)

The source sets to be analyzed as part of the check and build tasks.

getIgnoreFailures

public abstract Property<Boolean> getIgnoreFailures()

Whether to allow the build to continue if there are warnings. Example: ignoreFailures = true

setIgnoreFailures

public void setIgnoreFailures(boolean ignoreFailures)

Whether to allow the build to continue if there are warnings. Example: ignoreFailures = true

getIsIgnoreFailures

public Property<Boolean> getIsIgnoreFailures()

getReportsDir

public abstract DirectoryProperty getReportsDir()

The directory where reports will be generated.

setReportsDir

public void setReportsDir(File reportsDir)

The directory where reports will be generated.