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

KotlinToolTask

@KotlinGradlePluginDsl
interface KotlinToolTask<out TO : KotlinCommonCompilerToolOptions> : Task

Represents a Kotlin task performing further processing of compiled code via additional Kotlin tools using configurable toolOptions.

Check KotlinCommonCompilerToolOptions inheritors (excluding KotlinCommonCompilerToolOptions) for the possible configuration options.

See also

Properties

Link copied to clipboard
abstract val toolOptions: TO

Represents the tool options used by a Kotlin task with reasonable configured defaults.

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 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
Link copied to clipboard
Link copied to clipboard
@Internal
@Nullable
abstract fun getGroup(): String?
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 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
abstract fun setFinalizedBy(finalizedBy: MutableIterable<*>)
Link copied to clipboard
abstract fun setGroup(@Nullable group: String?)
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 shouldRunAfter(vararg paths: Any): TaskDependency
Link copied to clipboard
open fun toolOptions(configure: TO.() -> Unit)
open fun toolOptions(configure: Action<in TO>)

Configures the toolOptions with the provided configuration.

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