LibraryVariant

Added in 4.2.0

interface LibraryVariant : Variant, GeneratesAar, HasDeviceTests, HasAndroidTest, HasHostTests, HasUnitTest, HasTestFixtures, CanMinifyCode

Model for library components that only contains build-time properties.

See Component and Variant for more information.

Summary

Public properties
Renderscript?

Variant specific settings for the renderscript compiler.

Inherited functions
From com.android.build.api.variant.Component
String
@Incubating
computeTaskName(action: String, subject: String)

Utility method to create unique task name for component.
Unit

This function is deprecated. Will be removed in v9.0, use the instrumentation block.
Unit
<ParamT : InstrumentationParameters> transformClassesWith(
    classVisitorFactoryImplClass: Class<AsmClassVisitorFactory<ParamT>>,
    scope: InstrumentationScope,
    instrumentationParamsConfig: (ParamT) -> Unit
)

This function is deprecated. Will be removed in v9.0, use the instrumentation block.
From com.android.build.api.variant.HasAndroidResources
ResValue.Key
makeResValueKey(type: String, name: String)

Make a ResValue.Key to interact with resValues's MapProperty
From com.android.build.api.variant.Variant
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.
Unit
@Incubating
missingDimensionStrategy(
    dimension: String,
    vararg requestedValues: String
)

Set up a new matching request for a given flavor dimension and value.

Inherited properties
From com.android.build.api.variant.CanMinifyCode
Boolean

Specifies whether code will be minified.
From com.android.build.api.variant.Component
Configuration

Access to the variant's annotation processor Configuration; for example, the debugAnnotationProcessor Configuration for the debug variant.
Artifacts

Access to the variant's buildable artifacts for build customization.
FileCollection

Access to the variant's compile classpath.
Configuration

Access to the variant's compile Configuration; for example, the debugCompileClasspath Configuration for the debug variant.
Boolean

Whether the produced artifacts will be debuggable
Instrumentation

Access to the variant's instrumentation options.
JavaCompilation

Access to the variant's java compilation options.
LifecycleTasks

Provides access to the LifecycleTasks created for this component.
Provider<String>

The namespace of the generated R and BuildConfig classes.
Configuration

Access to the variant's runtime Configuration; for example, the debugRuntimeClasspath Configuration for the debug variant.
Sources

Access to variant's source files.
From com.android.build.api.variant.ComponentIdentity
String?

Build type name.
String?

The multi-flavor name of the variant.
String

Component's name.
List<Pair<String, String>>

List of flavor names.
From com.android.build.api.variant.GeneratesAar
AarMetadata

Variant's aar metadata, initialized by merging the corresponding com.android.build.api.dsl.AarMetadata DSL elements.
From com.android.build.api.variant.HasAndroidResources
Property<Boolean>

Variant's is pseudo locales enabled, initialized by the corresponding DSL elements.
MapProperty<ResValue.Key, ResValue>

Variant's ResValue which will be generated.
From com.android.build.api.variant.HasAndroidTest
AndroidTest?

Variant's AndroidTest configuration, or null if android tests are disabled for this variant.
From com.android.build.api.variant.HasDeviceTests
List<DeviceTest>

Variant's List of DeviceTest configurations, or empty if all devices tests (like android tests) are disabled for this variant.
From com.android.build.api.variant.HasHostTests
Map<String, HostTest>

Map of Variant's HostTest, or empty if all host tests (like unit test) for this variant are disabled.
From com.android.build.api.variant.HasTestFixtures
TestFixtures?

Variant's TestFixtures, or null if the test fixtures for this variant are disabled.
From com.android.build.api.variant.Variant
MapProperty<String, BuildConfigField<Serializable>>

Variant's BuildConfigField which will be generated in the BuildConfig class.
List<Component>

List containing this variant and all of its nestedComponents
MapProperty<String, Any>

Additional per variant experimental properties.
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>

MapProperty of the variant's manifest placeholders.
Int?

Gets the maximum supported SDK Version for this variant.
Int?
AndroidVersion

Gets the minimum supported SDK Version for this variant.
AndroidVersion
List<Component>

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

Variant's packagingOptions, initialized by the corresponding global DSL element.
ListProperty<RegularFile>

List of proguard configuration files for this variant.
AndroidVersion

Gets the target SDK Version for this variant.
UnitTest?

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

Public properties

renderscript

Added in 7.0.0
val renderscript: Renderscript?

Variant specific settings for the renderscript compiler. This will return null when com.android.build.api.dsl.BuildFeatures.renderScript is false.