gradle/org.gradle.api.plugins.quality/Checkstyle

Checkstyle

@CacheableTask

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

Runs Checkstyle against some source files.

Constructors

Checkstyle

constructor()

Properties

checkstyleClasspath

@get:Classpath

open var checkstyleClasspath: FileCollection

classpath

@get:Classpath

open var classpath: FileCollection

config

open var config: TextResource

configDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:InputFiles

val configDirectory: DirectoryProperty

configProperties

@get:Nullable

@get:Optional

@get:Input

open var configProperties: Map<String, Any>

conventionMapping

open val conventionMapping: ConventionMapping

description

open var description: String

enabled

open var enabled: Boolean

enableExternalDtdLoad

@get:Incubating

@get:Input

val enableExternalDtdLoad: Property<Boolean>

extra

val ExtensionAware.extra: ExtraPropertiesExtension

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

group

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

maxErrors

@get:Input

open var maxErrors: Int

maxWarnings

@get:Input

open var maxWarnings: Int

reports

val reports: CheckstyleReports

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "type"

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

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

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

dependsOn

open fun dependsOn(paths: Array<Any>): Task

doFirst

open fun doFirst(action: Action<in Task>): Task

doLast

open fun doLast(action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

exclude

open fun exclude(excludes: Array<String>): SourceTask

abstract fun exclude(excludes: Array<String>): PatternFilterable

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

getActions

open fun getActions(): List<Action<in Task>>

getAnt

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getConfigFile

@Internal

open fun getConfigFile(): File

The Checkstyle configuration file to use.

getConvention

open fun getConvention(): Convention

getDependsOn

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

getDidWork

open fun getDidWork(): Boolean

getExcludes

open fun getExcludes(): Set<String>

getExtensions

open fun getExtensions(): ExtensionContainer

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

getIgnoreFailures

open fun getIgnoreFailures(): Boolean

getIncludes

open fun getIncludes(): Set<String>

getInputs

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getJavaLauncher

abstract fun getJavaLauncher(): Property<JavaLauncher>

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

getLogger

open fun getLogger(): Logger

getLogging

open fun getLogging(): LoggingManager

getMaxHeapSize

abstract fun getMaxHeapSize(): Property<String>

getMinHeapSize

abstract fun getMinHeapSize(): Property<String>

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

getName

open fun getName(): String

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

getPath

open fun getPath(): String

getProject

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getReports

abstract fun getReports(): T

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getSource

@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

open fun getStandardOutputCapture(): StandardOutputCapture

getState

abstract fun getState(): TaskState

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

hasProperty

open fun hasProperty(propertyName: String): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

include

open fun include(includes: Array<String>): SourceTask

abstract fun include(includes: Array<String>): PatternFilterable

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

isEnabled

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

isIgnoreFailures

@Internal

open fun isIgnoreFailures(): Boolean

Whether the build should break when the verifications performed by this task fail.

isShowViolations

@Console

open fun isShowViolations(): Boolean

Whether rule violations are to be displayed on the console.

mustRunAfter

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

open fun onlyIf(spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

property

open fun property(propertyName: String): Any

reports

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

open fun run()

setActions

open fun setActions(replacements: List<Action<in Task>>)

setConfigFile

open fun setConfigFile(configFile: File)

The Checkstyle configuration file to use.

setConfigProperties

inline fun Checkstyle.setConfigProperties(vararg configProperties: Pair<String, Any?>)

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

setDependsOn

open fun setDependsOn(dependsOn: Iterable<out Any>)

setDidWork

open fun setDidWork(didWork: Boolean)

setExcludes

open fun setExcludes(excludes: Iterable<String>): SourceTask

abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setIgnoreFailures

open fun setIgnoreFailures(ignoreFailures: Boolean)

setIncludes

open fun setIncludes(includes: Iterable<String>): SourceTask

abstract fun setIncludes(includes: Iterable<String>): PatternFilterable

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

setOnlyIf

open fun setOnlyIf(spec: Spec<in Task>)

setProperty

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

setShowViolations

open fun setShowViolations(showViolations: Boolean)

Whether rule violations are to be displayed on the console.

setSource

open fun setSource(source: FileTree)

shouldRunAfter

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

source

open fun source(sources: Array<Any>): SourceTask

the

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

open fun usesService(service: Provider<out BuildService<out Any>>)