LibraryVariant

@Incubating interface LibraryVariant : Variant

com.android.build.api.variant.LibraryVariant

Variant for Library projects

Summary

Inherited functions

From class Variant

T?

getExtension(type: Class<T>)

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

ResValue.Key

makeResValueKey(type: String, name: String)

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

From class Component

Unit

setAsmFramesComputationMode(mode: FramesComputationMode)

Sets the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through transformClassesWith. The default mode is to copy frames.

When setting this multiple times, the mode with the highest enum value will be selected.

Unit

transformClassesWith(classVisitorFactoryImplClass: Class<out AsmClassVisitorFactory<ParamT>>, scope: InstrumentationScope, instrumentationParamsConfig: (ParamT) -> Unit)

Registers an asm class visitor to instrument the classes defined by the given scope. An instance of the factory will be instantiated and used to create visitors for each class.

Example:

androidComponentsExtension.onVariants(selector().all(), {
    transformClassesWith(AsmClassVisitorFactoryImpl.class,
                         InstrumentationScope.Project) { params ->
        params.x = "value"
    }
    setAsmFramesComputationMode(COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS)
})

This API is experimental and subject to breaking change and we strongly suggest you don't publish plugins that depend on it yet.

Properties
abstract AarMetadata	`aarMetadata` Variant's aar metadata, initialized by merging the corresponding com.android.build.api.dsl.AarMetadata DSL elements.
abstract AndroidTest?	`androidTest` Variant's AndroidTest configuration, or null if android tests are disabled for this variant.
abstract Provider<String>	`applicationId` Variant's application ID as present in the final manifest file of the APK.
abstract Renderscript?	`renderscript` Variant specific settings for the renderscript compiler.

Inherited properties

From class Component

Artifacts

artifacts

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

From class Variant

`MapProperty<String, BuildConfigField<out Serializable>>`	`buildConfigFields` Variant's BuildConfigField which will be generated in the BuildConfig class.
`ExternalNativeBuild?`	`externalCmake` Variant's cmake ExternalNativeBuild, initialized by merging the product flavor values or null if no cmake external build is configured for this variant.
`ExternalNativeBuild?`	`externalNdkBuild` Variant's ndk-build ExternalNativeBuild, initialized by merging the product flavor values or null if no ndk-build external build is configured for this variant.
`Property<Boolean>`	`isPseudoLocalesEnabled` Variant's is pseudo locales enabled, initialized by the corresponding DSL elements.
`MapProperty<String, String>`	`manifestPlaceholders` 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.
`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. Also, the namespace used to resolve any relative class names that are declared in the AndroidManifest.xml. This value supersedes any value specified by the `package` attribute in the source AndroidManifest.xml, but doing a 'get' on this property will not retrieve the value specified in the AndroidManifest.xml.
`Packaging`	`packaging` Variant's packagingOptions, initialized by the corresponding global DSL element.
`ListProperty<RegularFile>`	`proguardFiles` 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.
`MapProperty<ResValue.Key, ResValue>`	`resValues` Variant's ResValue which will be generated.
`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.

From class 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. This does not include the build type. If no flavors are present, this will return null The full name of the variant is queried via getName.
`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. The order is properly sorted based on the associated dimension order.

Properties

aarMetadata

abstract val aarMetadata: AarMetadata

Variant's aar metadata, initialized by merging the corresponding com.android.build.api.dsl.AarMetadata DSL elements.

androidTest

abstract val androidTest: AndroidTest?

Variant's AndroidTest configuration, or null if android tests are disabled for this variant.

applicationId

abstract val applicationId: Provider<String>

Variant's application ID as present in the final manifest file of the APK.

This is a read-ony value based on the package entry in the manifest

renderscript

abstract val renderscript: Renderscript?

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