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

Checkstyle

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

Runs Checkstyle against some source files.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
Link copied to clipboard
@get:Classpath
open var classpath: FileCollection
Link copied to clipboard
open var config: TextResource
Link copied to clipboard
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var configProperties: Map<String, Any>
Link copied to clipboard
open val conventionMapping: ConventionMapping
Link copied to clipboard
open var description: String
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

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

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

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(cl: Closure): T
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.

Link copied to clipboard
open fun conventionMapping(property: String, mapping: Callable<out Any>): Task
Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
Link copied to clipboard
open fun doFirst(action: Action<in Task>): Task
Link copied to clipboard
open fun doLast(action: Action<in Task>): Task
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
open fun exclude(excludes: Array<String>): SourceTask
abstract fun exclude(excludes: Array<String>): PatternFilterable
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
Link copied to clipboard
open fun getAnt(): AntBuilder
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
@Internal
open fun getConfigFile(): File
The Checkstyle configuration file to use.
Link copied to clipboard
open fun getConvention(): Convention
Link copied to clipboard
open fun getDependsOn(): Set<Any>
Link copied to clipboard
Link copied to clipboard
open fun getDidWork(): Boolean
Link copied to clipboard
open fun getExcludes(): Set<String>
Link copied to clipboard
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open fun getIdentityPath(): Path
Link copied to clipboard
open fun getIgnoreFailures(): Boolean
Link copied to clipboard
open fun getIncludes(): Set<String>
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
abstract fun getInputs(): TaskInputs
Link copied to clipboard
abstract fun getJavaLauncher(): Property<JavaLauncher>
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
Link copied to clipboard
open fun getLocalState(): TaskLocalState
Link copied to clipboard
open fun getLogger(): Logger
Link copied to clipboard
open fun getLogging(): LoggingManager
Link copied to clipboard
abstract fun getMaxHeapSize(): Property<String>
Link copied to clipboard
abstract fun getMinHeapSize(): Property<String>
Link copied to clipboard
Link copied to clipboard
open fun getName(): String
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
abstract fun getOutputs(): TaskOutputs
Link copied to clipboard
open fun getPath(): String
Link copied to clipboard
open fun getProject(): Project
Link copied to clipboard
Link copied to clipboard
abstract fun getReports(): T
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
Link copied to clipboard
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.
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
abstract fun getState(): TaskState
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
abstract fun getTaskDependencies(): TaskDependency
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
Link copied to clipboard
open fun getTemporaryDir(): File
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open fun hasTaskActions(): Boolean
Link copied to clipboard
open fun include(includes: Array<String>): SourceTask
abstract fun include(includes: Array<String>): PatternFilterable
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
Link copied to clipboard
Link copied to clipboard
open fun isEnabled(): Boolean
Link copied to clipboard
open fun isHasCustomActions(): Boolean
Link copied to clipboard
@Internal
open fun isIgnoreFailures(): Boolean
Whether the build should break when the verifications performed by this task fail.
Link copied to clipboard
@Console
open fun isShowViolations(): Boolean
Whether rule violations are to be displayed on the console.
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
Link copied to clipboard
Link copied to clipboard
open fun onlyIf(spec: Spec<in Task>)
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun property(propertyName: String): Any
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.
Link copied to clipboard
open fun run()
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
Link copied to clipboard
open fun setConfigFile(configFile: File)
The Checkstyle configuration file to use.
Link copied to clipboard
inline fun Checkstyle.setConfigProperties(vararg p0: Pair<String, Any?>)

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

Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
Link copied to clipboard
open fun setExcludes(excludes: Iterable<String>): SourceTask
abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
Link copied to clipboard
open fun setIgnoreFailures(ignoreFailures: Boolean)
Link copied to clipboard
open fun setIncludes(includes: Iterable<String>): SourceTask
abstract fun setIncludes(includes: Iterable<String>): PatternFilterable
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
Link copied to clipboard
open fun setOnlyIf(spec: Spec<in Task>)
Link copied to clipboard
open fun setProperty(name: String, value: Any)
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
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 setSource(source: FileTree)
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
Link copied to clipboard
open fun source(sources: Array<Any>): SourceTask
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.

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