gradle/org.gradle.api.plugins.quality/CheckstyleExtension

CheckstyleExtension

abstract class CheckstyleExtension : CodeQualityExtension(source)

Configuration options for the Checkstyle plugin.

See also

Constructors

Link copied to clipboard
constructor(project: Project)

Properties

Link copied to clipboard
open var config: TextResource

Functions

Link copied to clipboard
abstract fun getConfigDirectory(): DirectoryProperty
Path to other Checkstyle configuration files.
Link copied to clipboard
open fun getConfigFile(): File
The Checkstyle configuration file to use.
Link copied to clipboard
abstract fun getConfigProperties(): MapProperty<String, Any>
The properties available for use in the configuration file.
Link copied to clipboard
@Incubating
@Optional
@Input
abstract fun getEnableExternalDtdLoad(): Property<Boolean>
Enable the ability to use custom DTD files in config and load them from some location on all checkstyle tasks in this project.
Link copied to clipboard
abstract fun getIgnoreFailures(): Property<Boolean>
Whether to allow the build to continue if there are warnings.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract fun getMaxErrors(): Property<Integer>
The maximum number of errors that are tolerated before breaking the build or setting the failure property.
Link copied to clipboard
abstract fun getMaxWarnings(): Property<Integer>
The maximum number of warnings that are tolerated before breaking the build or setting the failure property.
Link copied to clipboard
@ReplacedBy(value = "reportsDirectory")
open fun getReportsDir(): File
The directory where reports will be generated.
Link copied to clipboard
@Incubating
abstract fun getReportsDirectory(): DirectoryProperty
The directory where reports will be generated.
Link copied to clipboard
abstract fun getShowViolations(): Property<Boolean>
Whether rule violations are to be displayed on the console.
Link copied to clipboard
abstract fun getSourceSets(): ListProperty<SourceSet>
The source sets to be analyzed as part of the check and build tasks.
Link copied to clipboard
abstract fun getToolVersion(): Property<String>
The version of the code quality tool to be used.
Link copied to clipboard
open fun setConfigFile(configFile: File)
The Checkstyle configuration file to use.
Link copied to clipboard
open fun setConfigProperties(configProperties: Map<String, Any>)
The properties available for use in the configuration file.
Link copied to clipboard
Link copied to clipboard
open fun setIgnoreFailures(ignoreFailures: Boolean)
Whether to allow the build to continue if there are warnings.
Link copied to clipboard
open fun setMaxErrors(maxErrors: Int)
Set the maximum number of errors that are tolerated before breaking the build.
Link copied to clipboard
open fun setMaxWarnings(maxWarnings: Int)
Set the maximum number of warnings that are tolerated before breaking the build.
Link copied to clipboard
open fun setReportsDir(reportsDir: File)
Sets the directory where reports will be generated.
Link copied to clipboard
open fun setShowViolations(showViolations: Boolean)
Whether rule violations are to be displayed on the console.
Link copied to clipboard
open fun setSourceSets(sourceSets: Collection<SourceSet>)
The source sets to be analyzed as part of the check and build tasks.
Link copied to clipboard
open fun setToolVersion(toolVersion: String)
The version of the code quality tool to be used.
Generated by Dokka
Gradle Kotlin DSL Reference