AndroidComponentsExtension

androidTests

abstract fun androidTests(
    selector: VariantSelector = selector().all(), 
    callback: Action<AndroidTest>
): Unit

Allow for registration of a callback to be called with instances of type AndroidTest once the list of com.android.build.api.artifact.Artifact has been determined.

At this stage, access to the DSL objects is disallowed and access to the AndroidTestBuilder instance is limited to read-only access.

Because the list of artifacts (including private ones) is final, one cannot change the build flow anymore as org.gradle.api.Tasks are now expecting those artifacts as inputs. However users can modify such artifacts by replacing or transforming them, see com.android.build.api.artifact.Artifacts for details.

Code executing in the callback also has access to the AndroidTest information which is used to configure org.gradle.api.Task inputs. Such information represented as org.gradle.api.provider.Property can still be modified ensuring that all org.gradle.api.Tasks created by the Android Gradle Plugin use the updated value.

androidTests

abstract fun androidTests(
    selector: VariantSelector = selector().all(), 
    callback: (AndroidTest) -> Unit
): Unit

Action based version of the AndroidTest above.

beforeAndroidTests

abstract fun beforeAndroidTests(
    selector: VariantSelector = selector().all(), 
    callback: (AndroidTestBuilder) -> Unit
): Unit

Allow for registration of a callback to be called with AndroidTestBuilder that satisfies the selector. The callback will be called as soon as the AndroidTestBuilder instance has been created but before any com.android.build.api.artifact.Artifact related to android tests has been determined, therefore the build flow can still be changed when the callback is invoked.

beforeAndroidTests

abstract fun beforeAndroidTests(
    selector: VariantSelector = selector().all(), 
    callback: Action<AndroidTestBuilder>
): Unit

Action based version of the beforeAndroidTests above.

beforeUnitTests

abstract fun beforeUnitTests(
    selector: VariantSelector = selector().all(), 
    callback: (UnitTestBuilder) -> Unit
): Unit

Allow for registration of a callback to be called with UnitTestBuilder that satisfies the selector. The callback will be called as soon as the UnitTestBuilder instance has been created but before any com.android.build.api.artifact.Artifact related to unit tests has been determined, therefore the build flow can still be changed when the callback is invoked.

beforeUnitTests

abstract fun beforeUnitTests(
    selector: VariantSelector = selector().all(), 
    callback: Action<UnitTestBuilder>
): Unit

Action based version of beforeUnitTests above.

beforeVariants

abstract fun beforeVariants(
    selector: VariantSelector = selector().all(), 
    callback: (VariantBuilderT) -> Unit
): Unit

Method to register a callback to be called with VariantBuilderT instances that satisfies the selector. The callback will be called as soon as the VariantBuilderT instance has been created but before any com.android.build.api.artifact.Artifact has been determined, therefore the build flow can still be changed when the callback is invoked.

At this stage, access to the DSL objects is disallowed, use afterDsl method to programmatically access the DSL objects before the VariantBuilderT object is built.

Example without selection:

androidComponents {
    beforeVariants {
        println("Called with variant : ${'$'}name")
    }
}

Example with selection:

androidComponents {
    val debug = selector().withBuildType("debug")
    beforeVariants(debug) {
        println("Called with variant : ${'$'}name")
    }
}

beforeVariants

abstract fun beforeVariants(
    selector: VariantSelector = selector().all(), 
    callback: Action<VariantBuilderT>
): Unit

Action based version of beforeVariants above.

onVariants

abstract fun onVariants(
    selector: VariantSelector = selector().all(), 
    callback: (VariantT) -> Unit
): Unit

Allow for registration of a callback to be called with variant instances of type VariantT once the list of com.android.build.api.artifact.Artifact has been determined.

At this stage, access to the DSL objects is disallowed and access to the VariantBuilderT instance is limited to read-only access.

Because the list of artifacts (including private ones) is final, one cannot change the build flow anymore as org.gradle.api.Tasks are now expecting those artifacts as inputs. However users can modify such artifacts by replacing or transforming them, see com.android.build.api.artifact.Artifacts for details.

Code executing in the callback also has access to the VariantT information which is used to configure org.gradle.api.Task inputs (for example, the buildConfigFields). Such information represented as org.gradle.api.provider.Property can still be modified ensuring that all org.gradle.api.Tasks created by the Android Gradle Plugin use the updated value.

onVariants

abstract fun onVariants(
    selector: VariantSelector = selector().all(), 
    callback: Action<VariantT>
): Unit

Action based version of onVariants above.

selector

abstract fun selector(): VariantSelector

Creates a VariantSelector instance that can be configured to reduce the set of ComponentBuilder instances participating in the beforeVariants and onVariants callback invocation.

unitTests

abstract fun unitTests(
    selector: VariantSelector = selector().all(), 
    callback: Action<UnitTest>
): Unit

Allow for registration of a callback to be called with instances of type UnitTest once the list of com.android.build.api.artifact.Artifact has been determined.

At this stage, access to the DSL objects is disallowed and access to the UnitTestBuilder instance is limited to read-only access.

Because the list of artifacts (including private ones) is final, one cannot change the build flow anymore as org.gradle.api.Tasks are now expecting those artifacts as inputs. However users can modify such artifacts by replacing or transforming them, see com.android.build.api.artifact.Artifacts for details.

Code executing in the callback also has access to the UnitTest information which is used to configure org.gradle.api.Task inputs. Such information represented as org.gradle.api.provider.Property can still be modified ensuring that all org.gradle.api.Tasks created by the Android Gradle Plugin use the updated value.

unitTests

abstract fun unitTests(
    selector: VariantSelector = selector().all(), 
    callback: (UnitTest) -> Unit
): Unit

Action based version of the unitTests above.

sdkComponents

abstract val sdkComponents: SdkComponents

Provides access to underlying Android SDK and build-tools components like adb.