Variant

interface Variant : Component, HasAndroidResources

Known direct subclasses

ApplicationVariant, DynamicFeatureVariant, LibraryVariant, TestVariant

`ApplicationVariant`	Properties for the main Variant of an application.
`DynamicFeatureVariant`
`LibraryVariant`	`Variant` for Library projects
`TestVariant`	`Variant` for test-only modules.

Parent interface for all types of variants.

Summary

Public functions
`T?`	`<T : Any?> getExtension(type: Class<T>)` Returns an extension object registered via the `VariantBuilder.registerExtension` API or null if none were registered under the passed `type`.

Public properties
`MapProperty<String, BuildConfigField<Serializable>>`	`buildConfigFields` Variant's `BuildConfigField` which will be generated in the BuildConfig class.
`List<Component>`	`components` List containing this variant and all of its `nestedComponents`
`MapProperty<String, Any>`	`experimentalProperties` Additional per variant experimental properties.
`ExternalNativeBuild?`	`externalNativeBuild` Variant's cmake `ExternalNativeBuild`, initialized by merging the product flavor values or null if no cmake external build is configured for this variant.
`MapProperty<String, String>`	`manifestPlaceholders` `MapProperty` of the variant's manifest placeholders.
`Int?`	`maxSdkVersion` Gets the maximum supported SDK Version for this variant.
`AndroidVersion`	`minSdkVersion` Gets the minimum supported SDK Version for this variant.
`Provider<String>`	`namespace` The namespace of the generated R and BuildConfig classes.
`List<Component>`	`nestedComponents` List of the components nested in this variant, the returned list will contain:
`Packaging`	`packaging` Variant's packagingOptions, initialized by the corresponding global DSL element.
`ListProperty<RegularFile>`	`proguardFiles` List of proguard configuration files for this variant.
`AndroidVersion`	`targetSdkVersion` Gets the target SDK Version for this variant.
`UnitTest?`	`unitTest` Variant's `UnitTest`, or null if the unit tests for this variant are disabled.

Inherited functions

From class com.android.build.api.variant.Component

`Unit`	`setAsmFramesComputationMode(mode: FramesComputationMode)` This function is deprecated. Use the instrumentation block.
`Unit`	`<ParamT : InstrumentationParameters> transformClassesWith( classVisitorFactoryImplClass: Class<AsmClassVisitorFactory<ParamT>>, scope: InstrumentationScope, instrumentationParamsConfig: (ParamT) -> Unit )` This function is deprecated. Use the instrumentation block.

From class com.android.build.api.variant.HasAndroidResources

ResValue.Key

makeResValueKey(type: String, name: String)

Make a ResValue.Key to interact with resValues's MapProperty

Inherited properties

From class com.android.build.api.variant.Component

`Configuration`	`annotationProcessorConfiguration` Access to the variant's annotation processor `Configuration`; for example, the debugAnnotationProcessor `Configuration` for the debug variant.
`Artifacts`	`artifacts` Access to the variant's buildable artifacts for build customization.
`FileCollection`	`compileClasspath` Access to the variant's compile classpath.
`Configuration`	`compileConfiguration` Access to the variant's compile `Configuration`; for example, the debugCompileClasspath `Configuration` for the debug variant.
`Instrumentation`	`instrumentation` Access to the variant's instrumentation options.
`JavaCompilation`	`javaCompilation` Access to the variant's java compilation options.
`Configuration`	`runtimeConfiguration` Access to the variant's runtime `Configuration`; for example, the debugRuntimeClasspath `Configuration` for the debug variant.
`Sources`	`sources` Access to variant's source files.

From class com.android.build.api.variant.ComponentIdentity

`String?`	`buildType` Build type name, might be replaced with access to locked DSL object once ready.
`String?`	`flavorName` The multi-flavor name of the variant.
`String`	`name` Component's name.
`List<Pair<String, String>>`	`productFlavors` List of flavor names, might be replaced with access to locked DSL objects once ready.

From class com.android.build.api.variant.HasAndroidResources

`Property<Boolean>`	`pseudoLocalesEnabled` Variant's is pseudo locales enabled, initialized by the corresponding DSL elements.
`MapProperty<ResValue.Key, ResValue>`	`resValues` Variant's `ResValue` which will be generated.

Public functions

getExtension

fun <T : Any?> getExtension(type: Class<T>): T?

Returns an extension object registered via the VariantBuilder.registerExtension API or null if none were registered under the passed type.

Returns
`T?`	the registered object or null.

Public properties

buildConfigFields

val buildConfigFields: MapProperty<String, BuildConfigField<Serializable>>

Variant's BuildConfigField which will be generated in the BuildConfig class.

components

val components: List<Component>

List containing this variant and all of its nestedComponents

Example:

androidComponents.onVariants(selector().withName("debug")) {
    // components contains the debug variant along with its unitTests, androidTests, and
    // testFixtures (if enabled).
    components.forEach { component ->
        component.runtimeConfiguration
            .resolutionStrategy
            .dependencySubstitution {
                substitute(project(":foo")).using(project(":bar"))
            }
    }
}

experimentalProperties

val experimentalProperties: MapProperty<String, Any>

Additional per variant experimental properties.

Initialized from com.android.build.api.dsl.CommonExtension.experimentalProperties

externalNativeBuild

val externalNativeBuild: ExternalNativeBuild?

Variant's cmake ExternalNativeBuild, initialized by merging the product flavor values or null if no cmake external build is configured for this variant.

manifestPlaceholders

val manifestPlaceholders: MapProperty<String, String>

MapProperty of the variant's manifest placeholders.

Placeholders are organized with a key and a value. The value is a String that will be used as is in the merged manifest.

Returns
`MapProperty<String, String>`	the `MapProperty` with keys as `String`

maxSdkVersion

val maxSdkVersion: Int?

Gets the maximum supported SDK Version for this variant.

minSdkVersion

val minSdkVersion: AndroidVersion

Gets the minimum supported SDK Version for this variant.

namespace

val namespace: Provider<String>

The namespace of the generated R and BuildConfig classes. Also, the namespace used to resolve any relative class names that are declared in the AndroidManifest.xml.

nestedComponents

val nestedComponents: List<Component>

List of the components nested in this variant, the returned list will contain:

UnitTest component if the unit tests for this variant are enabled,
AndroidTest component if this variant HasAndroidTest and android tests for this variant are enabled,
TestFixtures component if this variant HasTestFixtures and test fixtures for this variant are enabled.

Use this list to do operations on all nested components of this variant without having to manually check whether the variant has each component.

Example:

androidComponents.onVariants(selector().withName("debug")) {
    // will return unitTests, androidTests, testFixtures for the debug variant (if enabled).
    nestedComponents.forEach { component ->
        component.transformClassesWith(NestedComponentsClassVisitorFactory::class.java,
                                       InstrumentationScope.Project) {}
    }
}

packaging

val packaging: Packaging

Variant's packagingOptions, initialized by the corresponding global DSL element.

proguardFiles

val proguardFiles: ListProperty<RegularFile>

List of proguard configuration files for this variant. The list is initialized from the corresponding DSL element, and cannot be queried at configuration time. At configuration time, you can only add new elements to the list.

This list will be initialized from com.android.build.api.dsl.VariantDimension#proguardFile for non test related variants and from com.android.build.api.dsl.VariantDimension.testProguardFiles for test related variants.

targetSdkVersion

val targetSdkVersion: AndroidVersion

Gets the target SDK Version for this variant.

unitTest

val unitTest: UnitTest?

Variant's UnitTest, or null if the unit tests for this variant are disabled.