# Checkstyle

@CacheableTask
abstract class Checkstyle : AbstractCodeQualityTask, Reporting<T> (source)

Runs Checkstyle against some source files.

## Constructors

Checkstyle
Link copied to clipboard
constructor()

## Properties

checkstyleClasspath
Link copied to clipboard
@get:Classpath
open var checkstyleClasspath: FileCollection
classpath
Link copied to clipboard
@get:Classpath
open var classpath: FileCollection
config
Link copied to clipboard
open var config: TextResource
configDirectory
Link copied to clipboard
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:InputFiles
val configDirectory: DirectoryProperty
configProperties
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var configProperties: Map<String, Any>
conventionMapping
Link copied to clipboard
open val conventionMapping: ConventionMapping
description
Link copied to clipboard
open var description: String
enabled
Link copied to clipboard
open var enabled: Boolean
enableExternalDtdLoad
Link copied to clipboard
@get:Incubating
@get:Input
val enableExternalDtdLoad: Property<Boolean>
extra
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

group
Link copied to clipboard
open var group: String
impliesSubProjects
Link copied to clipboard
open var impliesSubProjects: Boolean
maxErrors
Link copied to clipboard
@get:Input
open var maxErrors: Int
maxWarnings
Link copied to clipboard
@get:Input
open var maxWarnings: Int
reports
Link copied to clipboard
val reports: CheckstyleReports
state
Link copied to clipboard
val state: TaskStateInternal
TASK_ACTION
Link copied to clipboard
val TASK_ACTION: String = "action"
TASK_CONSTRUCTOR_ARGS
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
TASK_DEPENDS_ON
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
TASK_DESCRIPTION
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
TASK_GROUP
Link copied to clipboard
val TASK_GROUP: String = "group"
TASK_NAME
Link copied to clipboard
val TASK_NAME: String = "name"
TASK_OVERWRITE
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
TASK_TYPE
Link copied to clipboard
val TASK_TYPE: String = "type"
timeout
Link copied to clipboard
val timeout: Property<Duration>

## Functions

acceptServiceReferences
Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
appendParallelSafeAction
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
compareTo
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
configure
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(cl: Closure): T
configure
Link copied to clipboard
inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

conventionMapping
Link copied to clipboard
open fun conventionMapping(property: String, mapping: Callable<out Any>): Task
dependsOn
Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
doFirst
Link copied to clipboard
open fun doFirst(action: Action<in Task>): Task
doLast
Link copied to clipboard
open fun doLast(action: Action<in Task>): Task
doNotTrackState
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String)
exclude
Link copied to clipboard
open fun exclude(excludes: Array<String>): SourceTask
abstract fun exclude(excludes: Array<String>): PatternFilterable
finalizedBy
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
getActions
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
getAnt
Link copied to clipboard
open fun getAnt(): AntBuilder
getAsDynamicObject
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
getConfigFile
Link copied to clipboard
@Internal
open fun getConfigFile(): File
The Checkstyle configuration file to use.
getConvention
Link copied to clipboard
open fun getConvention(): Convention
getDependsOn
Link copied to clipboard
open fun getDependsOn(): Set<Any>
getDestroyables
Link copied to clipboard
open fun getDestroyables(): TaskDestroyables
getDidWork
Link copied to clipboard
open fun getDidWork(): Boolean
getExcludes
Link copied to clipboard
open fun getExcludes(): Set<String>
getExtensions
Link copied to clipboard
open fun getExtensions(): ExtensionContainer
getFinalizedBy
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
getIdentityPath
Link copied to clipboard
open fun getIdentityPath(): Path
getIgnoreFailures
Link copied to clipboard
open fun getIgnoreFailures(): Boolean
getIncludes
Link copied to clipboard
open fun getIncludes(): Set<String>
getInputs
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
abstract fun getInputs(): TaskInputs
getJavaLauncher
Link copied to clipboard
abstract fun getJavaLauncher(): Property<JavaLauncher>
getLifecycleDependencies
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
getLocalState
Link copied to clipboard
open fun getLocalState(): TaskLocalState
getLogger
Link copied to clipboard
open fun getLogger(): Logger
getLogging
Link copied to clipboard
open fun getLogging(): LoggingManager
getMaxHeapSize
Link copied to clipboard
abstract fun getMaxHeapSize(): Property<String>
getMinHeapSize
Link copied to clipboard
abstract fun getMinHeapSize(): Property<String>
getMustRunAfter
Link copied to clipboard
open fun getMustRunAfter(): TaskDependency
getName
Link copied to clipboard
open fun getName(): String
getOnlyIf
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
getOutputs
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
abstract fun getOutputs(): TaskOutputs
getPath
Link copied to clipboard
open fun getPath(): String
getProject
Link copied to clipboard
open fun getProject(): Project
getReasonNotToTrackState
Link copied to clipboard
open fun getReasonNotToTrackState(): Optional<String>
getReasonTaskIsIncompatibleWithConfigurationCache
Link copied to clipboard
open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>
getReports
Link copied to clipboard
abstract fun getReports(): T
getRequiredServices
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
getSharedResources
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
getShouldRunAfter
Link copied to clipboard
open fun getShouldRunAfter(): TaskDependency
getSource
Link copied to clipboard
@PathSensitive(value = PathSensitivity.RELATIVE)
open fun getSource(): FileTree
The sources for this task are relatively relocatable even though it produces output that includes absolute paths.
getStandardOutputCapture
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
getState
Link copied to clipboard
abstract fun getState(): TaskState
getTaskActions
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
getTaskDependencies
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
abstract fun getTaskDependencies(): TaskDependency
getTaskIdentity
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
getTemporaryDir
Link copied to clipboard
open fun getTemporaryDir(): File
getTemporaryDirFactory
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
hasProperty
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
hasTaskActions
Link copied to clipboard
open fun hasTaskActions(): Boolean
include
Link copied to clipboard
open fun include(includes: Array<String>): SourceTask
abstract fun include(includes: Array<String>): PatternFilterable
injectIntoNewInstance
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
isCompatibleWithConfigurationCache
Link copied to clipboard
open fun isCompatibleWithConfigurationCache(): Boolean
isEnabled
Link copied to clipboard
open fun isEnabled(): Boolean
isHasCustomActions
Link copied to clipboard
open fun isHasCustomActions(): Boolean
isIgnoreFailures
Link copied to clipboard
@Internal
open fun isIgnoreFailures(): Boolean
Whether the build should break when the verifications performed by this task fail.
isShowViolations
Link copied to clipboard
@Console
open fun isShowViolations(): Boolean
Whether rule violations are to be displayed on the console.
mustRunAfter
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
notCompatibleWithConfigurationCache
Link copied to clipboard
open fun notCompatibleWithConfigurationCache(reason: String)
onlyIf
Link copied to clipboard
open fun onlyIf(spec: Spec<in Task>)
prependParallelSafeAction
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
property
Link copied to clipboard
open fun property(propertyName: String): Any
reports
Link copied to clipboard
open fun reports(@DelegatesTo(value = CheckstyleReports::class, strategy = Closure.DELEGATE_FIRST) closure: Closure): CheckstyleReports
open fun reports(configureAction: Action<in CheckstyleReports>): CheckstyleReports
Configures the reports to be generated by this task.
run
Link copied to clipboard
open fun run()
setActions
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
setConfigFile
Link copied to clipboard
open fun setConfigFile(configFile: File)
The Checkstyle configuration file to use.
setConfigProperties
Link copied to clipboard
inline fun Checkstyle.setConfigProperties(vararg configProperties: Pair<String, Any?>)

Kotlin extension function for org.gradle.api.plugins.quality.Checkstyle.setConfigProperties.

setDependsOn
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
setDidWork
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
setExcludes
Link copied to clipboard
open fun setExcludes(excludes: Iterable<String>): SourceTask
abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable
setFinalizedBy
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
setIgnoreFailures
Link copied to clipboard
open fun setIgnoreFailures(ignoreFailures: Boolean)
setIncludes
Link copied to clipboard
open fun setIncludes(includes: Iterable<String>): SourceTask
abstract fun setIncludes(includes: Iterable<String>): PatternFilterable
setMustRunAfter
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
setOnlyIf
Link copied to clipboard
open fun setOnlyIf(spec: Spec<in Task>)
setProperty
Link copied to clipboard
open fun setProperty(name: String, value: Any)
setShouldRunAfter
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
setShowViolations
Link copied to clipboard
open fun setShowViolations(showViolations: Boolean)
Whether rule violations are to be displayed on the console.
setSource
Link copied to clipboard
open fun setSource(source: FileTree)
shouldRunAfter
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
source
Link copied to clipboard
open fun source(sources: Array<Any>): SourceTask
the
Link copied to clipboard
inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<out Any>>)