LibraryVariant

@Incubating interface LibraryVariant : Variant

com.android.build.api.variant.LibraryVariant

Variant for Library projects

Summary

Public methods
abstract Unit	`packaging(action: LibraryPackaging.() -> Unit)` Variant's packagingOptions, initialized by the corresponding global DSL element.

Inherited functions

From class Variant

Unit

addBuildConfigField(key: String, value: Serializable, comment: String?)

Convenience method to add a new Build Config field which value is known at configuration time.

Unit

addResValue(name: String, type: String, value: String, comment: String?)

Adds a ResValue element to the generated resources.

Unit

addResValue(name: String, type: String, value: Provider<String>, comment: String?)

Adds a ResValue element to the generated resources.

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 Provider<String>	`applicationId` Variant's application ID as present in the final manifest file of the APK.
abstract LibraryPackaging	`packaging` Variant's packagingOptions, initialized by the corresponding global DSL element.

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.
`ExternalCmake?`	`externalCmake` Variant's ExternalCmake, initialized by merging the product flavor values or null if no cmake external build is configured for this variant.
`ExternalNdkBuild?`	`externalNdkBuild` Variant's ExternalNdkBuild, initialized by merging the product flavor values or null if no ndk-build external build is configured for this variant.
`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.
`Provider<String>`	`packageName` The package name into which some classes are generated

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 is an empty string.

The full name of the variant is queried via getName.

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.

Public methods

packaging

abstract fun packaging(action: LibraryPackaging.() -> Unit): Unit

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

Properties

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

packaging

abstract val packaging: LibraryPackaging

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