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

BaseKotlinCompile

interface BaseKotlinCompile : KotlinCompileTool

Represents any Kotlin compilation task including common task inputs.

Inheritors

KotlinJvmCompile

Properties

destinationDirectory

@get:OutputDirectory

abstract val destinationDirectory: DirectoryProperty

The destination directory where the task artifact can be found.

abstract val friendPaths: ConfigurableFileCollection

Paths to the output directories of the friend modules whose internal declarations should be visible.

@get:Incremental

abstract val libraries: ConfigurableFileCollection

Collection of external artifacts participating in the output artifact generation.

multiPlatformEnabled

@get:Input

abstract val multiPlatformEnabled: Property<Boolean>

Enables the Kotlin Multiplatform flag for compilation.

pluginClasspath

abstract val pluginClasspath: ConfigurableFileCollection

Kotlin compiler plugins artifacts , such as JAR or class files, that participate in the compilation process. All files that are permitted in the JVM classpath are permitted here.

abstract val pluginOptions: ListProperty<CompilerPluginConfig>

The configuration for the Kotlin compiler plugin added in pluginClasspath using CompilerPluginConfig.

@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.

abstract val sourceSetName: Property<String>

Specifies the name of org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet that is compiled.

useModuleDetection

@get:Input

abstract val useModuleDetection: Property<Boolean>

Enable more granular tracking of inter-modules as part of incremental compilation. Useful in Android projects.

Functions

abstract operator fun compareTo(other: Task): Int

abstract fun configure(configureClosure: Closure<Any>): Task

abstract fun dependsOn(vararg paths: Any): Task

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

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

doNotTrackState

abstract fun doNotTrackState(reasonNotToTrackState: String)

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

abstract fun finalizedBy(vararg paths: Any): Task

abstract fun getActions(): MutableList<Action<in Task>>

abstract fun getAnt(): AntBuilder

abstract fun ~~getConvention~~(): Convention

abstract fun getDependsOn(): MutableSet<Any>

abstract fun getDescription(): String?

getDestroyables

abstract fun getDestroyables(): TaskDestroyables

abstract fun getDidWork(): Boolean

abstract fun getEnabled(): Boolean

abstract override fun getExcludes(): MutableSet<String>

Returns the set of exclude patterns.

abstract fun getExtensions(): ExtensionContainer

abstract fun getFinalizedBy(): TaskDependency

abstract fun getGroup(): String?

abstract override fun getIncludes(): MutableSet<String>

Returns the set of include patterns.

abstract fun getInputs(): TaskInputs

abstract fun getLocalState(): TaskLocalState

abstract fun getLogger(): Logger

abstract fun getLogging(): LoggingManager

getMustRunAfter

abstract fun getMustRunAfter(): TaskDependency

abstract override fun getName(): String

abstract fun getOutputs(): TaskOutputs

abstract fun getPath(): String

abstract fun getProject(): Project

getShouldRunAfter

abstract fun getShouldRunAfter(): TaskDependency

abstract fun getState(): TaskState

getTaskDependencies

abstract fun getTaskDependencies(): TaskDependency

getTemporaryDir

abstract fun getTemporaryDir(): File

abstract fun getTimeout(): Property<Duration>

abstract fun hasProperty(propertyName: String): Boolean

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

abstract fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

abstract fun notCompatibleWithConfigurationCache(reason: String)

abstract fun onlyIf(onlyIfClosure: Closure<Any>)

abstract fun onlyIf(onlyIfSpec: Spec<in Task>)

abstract fun onlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)

abstract fun property(propertyName: String): Any?

abstract fun setActions(actions: MutableList<Action<in Task>>)

abstract fun setDependsOn(dependsOnTasks: MutableIterable<*>)

abstract fun setDescription(@Nullable description: String?)

abstract fun setDidWork(didWork: Boolean)

abstract fun setEnabled(enabled: Boolean)

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

abstract fun setFinalizedBy(finalizedBy: MutableIterable<*>)

abstract fun setGroup(@Nullable group: String?)

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

setMustRunAfter

abstract fun setMustRunAfter(mustRunAfter: MutableIterable<*>)

abstract fun setOnlyIf(onlyIfClosure: Closure<Any>)

abstract fun setOnlyIf(onlyIfSpec: Spec<in Task>)

abstract fun setOnlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)

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

setShouldRunAfter

abstract fun setShouldRunAfter(shouldRunAfter: MutableIterable<*>)

abstract fun setSource(vararg sources: Any)

Sets input sources for this task.

abstract fun shouldRunAfter(vararg paths: Any): TaskDependency

abstract fun source(vararg sources: Any)

Adds input sources for this task.

abstract fun usesService(service: Provider<out BuildService<*>>)