KotlinMultiplatformAndroidCompilationBuilder

@Incubating
public interface KotlinMultiplatformAndroidCompilationBuilder

Options to build a KotlinMultiplatformAndroidCompilation object.

Summary

Public methods
`abstract @NonNull String`	`@Incubating getCompilationName()` The name of the compilation object.
`abstract @NonNull String`	`@Incubating getDefaultSourceSetName()` The name of the sourceSet that is used in the compilation as the default sourceSet to compile.
`abstract String`	`@Incubating getSourceSetTreeName()` The name of the sourceSet tree that would be used to infer the dependencies between sourceSets.
`abstract void`	`@Incubating setCompilationName(@NonNull String compilationName)` The name of the compilation object.
`abstract void`	`@Incubating setDefaultSourceSetName(@NonNull String defaultSourceSetName)` The name of the sourceSet that is used in the compilation as the default sourceSet to compile.
`abstract void`	`@Incubating setSourceSetTreeName(String sourceSetTreeName)` The name of the sourceSet tree that would be used to infer the dependencies between sourceSets.

Public methods

getCompilationName

@Incubating
abstract @NonNull String getCompilationName()

The name of the compilation object. The name can be used later to access the compilation object using

kotlin {
  androidLibrary {
    compilations.getByName("main") {
      // configure compilation
    }
  }
}

See also
`KotlinCompilation`

getDefaultSourceSetName

@Incubating
abstract @NonNull String getDefaultSourceSetName()

The name of the sourceSet that is used in the compilation as the default sourceSet to compile. The sourceSet created will be located at $projectDir/src/$sourceSetName.

The sourceSet name can be used later to access the sourceSet object using

kotlin {
  sourceSets.getByName("androidMain") {
    // configure sourceSet
  }
}

See also
`KotlinSourceSet`

getSourceSetTreeName

@Incubating
abstract String getSourceSetTreeName()

The name of the sourceSet tree that would be used to infer the dependencies between sourceSets. For example, setting the sourceSetTreeName to test means that compilation will include the commonTest sourceSet, and setting it to integrationTest means that the compilation will include the commonIntegrationTest sourceSet if exists.

Setting this value to null means that this compilation is not part of any sourceSet trees and the kotlin plugin will not include any common test sourceSets in this compilation.

See also
`org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension.targetHierarchy`

setCompilationName

@Incubating
abstract void setCompilationName(@NonNull String compilationName)

The name of the compilation object. The name can be used later to access the compilation object using

kotlin {
  androidLibrary {
    compilations.getByName("main") {
      // configure compilation
    }
  }
}

See also
`KotlinCompilation`

setDefaultSourceSetName

@Incubating
abstract void setDefaultSourceSetName(@NonNull String defaultSourceSetName)

The name of the sourceSet that is used in the compilation as the default sourceSet to compile. The sourceSet created will be located at $projectDir/src/$sourceSetName.

The sourceSet name can be used later to access the sourceSet object using

kotlin {
  sourceSets.getByName("androidMain") {
    // configure sourceSet
  }
}

See also
`KotlinSourceSet`

setSourceSetTreeName

@Incubating
abstract void setSourceSetTreeName(String sourceSetTreeName)

Setting this value to null means that this compilation is not part of any sourceSet trees and the kotlin plugin will not include any common test sourceSets in this compilation.

See also
`org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension.targetHierarchy`