kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.plugin/KotlinTarget

KotlinTarget

@KotlinGradlePluginDsl

interface KotlinTarget : Named, HasAttributes, HasProject, HasMutableExtras

Represents a target platform for which Kotlin code is built.

This abstraction allows for the configuration of tasks, dependencies, and other settings specific to the platform on which the code is intended to run.

By default, a Kotlin target contains two KotlinCompilations: one for production and one for test source code.

Examples of accessing the Kotlin target:

In Kotlin/JVM or Kotlin/Android projects:

kotlin {
    target {
        // Configure JVM or Android target specifics here
    }
}

In Kotlin Multiplatform projects:

kotlin {
    jvm { // Creates JVM target
        // Configure JVM target specifics here
    }

    linuxX64 {
        // Configure Kotlin native target for Linux X86_64 here
    }
}

To learn more about the different targets in Kotlin, see Targets.

Inheritors

KotlinTargetWithTests

Properties

apiElementsConfigurationName

abstract val apiElementsConfigurationName: String

The name of the configuration that is used when compiling against the API of this Kotlin target.

artifactsTaskName

abstract val artifactsTaskName: String

The name of the task responsible for assembling the final artifact for this target.

abstract val compilations: NamedDomainObjectContainer<out KotlinCompilation<KotlinCommonOptionsDeprecated>>

A container for Kotlin compilations related to this target.

abstract val components: Set<SoftwareComponent>

Represents a collection of Gradle software components associated with this Kotlin target.

disambiguationClassifier

open val disambiguationClassifier: String?

Retrieves the disambiguation classifier for the Kotlin target.

abstract override val extras: MutableExtras

abstract val platformType: KotlinPlatformType

Represents the type of Kotlin platform associated with the target.

abstract val project: Project

The Gradle Project associated with the entity.

abstract val publishable: Boolean

Indicates whether the Kotlin target is publishable.

runtimeElementsConfigurationName

abstract val runtimeElementsConfigurationName: String

The name of the configuration containing elements that are strictly required at runtime by this Kotlin target.

sourcesElementsConfigurationName

abstract val sourcesElementsConfigurationName: String

The name of the configuration that represents the variant that carries the original source code in packaged form.

abstract val targetName: String

The name of the target in the Kotlin build configuration.

Functions

open fun attributes(configure: AttributeContainer.() -> Unit)

open fun attributes(configure: Action<AttributeContainer>)

Configures the attributes associated with this target.

abstract fun getAttributes(): AttributeContainer

mavenPublication

open fun mavenPublication(action: MavenPublication.() -> Unit)

abstract fun mavenPublication(action: Action<MavenPublication>)

Configures the Maven publication for this Kotlin target.

abstract fun withSourcesJar(publish: Boolean = true)

Configures the publication of sources.