kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.tasks/KotlinCompileTool

KotlinCompileTool

interface KotlinCompileTool : PatternFilterable, Task

Represents a Kotlin task participating in some stage of the build by compiling sources or running additional Kotlin tools.

Inheritors

Properties

Link copied to clipboard
@get:OutputDirectory
abstract val destinationDirectory: DirectoryProperty

The destination directory where the task artifact can be found.

Link copied to clipboard
@get:Classpath
@get:Incremental
abstract val libraries: ConfigurableFileCollection

Collection of external artifacts participating in the output artifact generation.

Link copied to clipboard
@get:InputFiles
@get:SkipWhenEmpty
@get:IgnoreEmptyDirectories
@get:NormalizeLineEndings
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val sources: FileCollection

The configured task inputs (for example, Kotlin sources) which are used to produce a task artifact.

Functions

Link copied to clipboard
abstract operator fun compareTo(other: Task): Int
Link copied to clipboard
abstract fun configure(configureClosure: Closure<Any>): Task
Link copied to clipboard
abstract fun dependsOn(vararg paths: Any): Task
Link copied to clipboard
abstract fun doFirst(@DelegatesTo(value = Task::class) action: Closure<Any>): Task
abstract fun doFirst(action: Action<in Task>): Task
abstract fun doFirst(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
abstract fun doLast(@DelegatesTo(value = Task::class) action: Closure<Any>): Task
abstract fun doLast(action: Action<in Task>): Task
abstract fun doLast(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
abstract fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
abstract fun exclude(excludeSpec: Closure<Any>): PatternFilterable
abstract fun exclude(vararg excludes: String): PatternFilterable
abstract fun exclude(excludes: MutableIterable<String>): PatternFilterable
abstract fun exclude(excludeSpec: Spec<FileTreeElement>): PatternFilterable
Link copied to clipboard
abstract fun finalizedBy(vararg paths: Any): Task
Link copied to clipboard
@Internal
abstract fun getActions(): MutableList<Action<in Task>>
Link copied to clipboard
@Internal
abstract fun getAnt(): AntBuilder
Link copied to clipboard
Link copied to clipboard
@Internal
abstract fun getDependsOn(): MutableSet<Any>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Internal
abstract fun getDidWork(): Boolean
Link copied to clipboard
@Internal
abstract fun getEnabled(): Boolean
Link copied to clipboard
@Internal
abstract override fun getExcludes(): MutableSet<String>

Returns the set of exclude patterns.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Internal
@Nullable
abstract fun getGroup(): String?
Link copied to clipboard
@Internal
abstract override fun getIncludes(): MutableSet<String>

Returns the set of include patterns.

Link copied to clipboard
@Internal
abstract fun getInputs(): TaskInputs
Link copied to clipboard
Link copied to clipboard
@Internal
abstract fun getLogger(): Logger
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Internal
abstract override fun getName(): String
Link copied to clipboard
@Internal
abstract fun getOutputs(): TaskOutputs
Link copied to clipboard
@Internal
abstract fun getPath(): String
Link copied to clipboard
@Internal
abstract fun getProject(): Project
Link copied to clipboard
Link copied to clipboard
@Internal
abstract fun getState(): TaskState
Link copied to clipboard
Link copied to clipboard
@Internal
abstract fun getTemporaryDir(): File
Link copied to clipboard
Link copied to clipboard
abstract fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
abstract fun include(includeSpec: Closure<Any>): PatternFilterable
abstract fun include(vararg includes: String): PatternFilterable
abstract fun include(includes: MutableIterable<String>): PatternFilterable
abstract fun include(includeSpec: Spec<FileTreeElement>): PatternFilterable
Link copied to clipboard
abstract fun mustRunAfter(vararg paths: Any): Task
Link copied to clipboard
Link copied to clipboard
abstract fun onlyIf(onlyIfClosure: Closure<Any>)
abstract fun onlyIf(onlyIfSpec: Spec<in Task>)
@Incubating
abstract fun onlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)
Link copied to clipboard
@Nullable
abstract fun property(propertyName: String): Any?
Link copied to clipboard
abstract fun setActions(actions: MutableList<Action<in Task>>)
Link copied to clipboard
abstract fun setDependsOn(dependsOnTasks: MutableIterable<*>)
Link copied to clipboard
abstract fun setDescription(@Nullable description: String?)
Link copied to clipboard
abstract fun setDidWork(didWork: Boolean)
Link copied to clipboard
abstract fun setEnabled(enabled: Boolean)
Link copied to clipboard
Link copied to clipboard
abstract fun setFinalizedBy(finalizedBy: MutableIterable<*>)
Link copied to clipboard
abstract fun setGroup(@Nullable group: String?)
Link copied to clipboard
Link copied to clipboard
abstract fun setMustRunAfter(mustRunAfter: MutableIterable<*>)
Link copied to clipboard
abstract fun setOnlyIf(onlyIfClosure: Closure<Any>)
abstract fun setOnlyIf(onlyIfSpec: Spec<in Task>)
@Incubating
abstract fun setOnlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)
Link copied to clipboard
abstract fun setProperty(name: String, value: Any)
Link copied to clipboard
abstract fun setShouldRunAfter(shouldRunAfter: MutableIterable<*>)
Link copied to clipboard
abstract fun setSource(vararg sources: Any)

Sets input sources for this task.

Link copied to clipboard
abstract fun shouldRunAfter(vararg paths: Any): TaskDependency
Link copied to clipboard
abstract fun source(vararg sources: Any)

Adds input sources for this task.

Link copied to clipboard
abstract fun usesService(service: Provider<out BuildService<*>>)