com.android.build.gradle

Class LibraryExtension

java.lang.Object

com.android.build.gradle.BaseExtension

com.android.build.gradle.TestedExtension

com.android.build.gradle.LibraryExtension

All Implemented Interfaces:

AndroidConfig, TestedAndroidConfig

Direct Known Subclasses:

FeatureExtension

public class LibraryExtension
extends TestedExtension

The android extension for com.android.library projects.

Apply this plugin to your project to create an Android library.

Field Summary

Fields inherited from class com.android.build.gradle.BaseExtension

globalScope, logger, project

Constructor Summary

Constructors

Constructor and Description

LibraryExtension(org.gradle.api.Project project, ProjectOptions projectOptions, com.android.build.gradle.internal.scope.GlobalScope globalScope, org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.BuildType> buildTypes, org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.ProductFlavor> productFlavors, org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.SigningConfig> signingConfigs, org.gradle.api.NamedDomainObjectContainer<BaseVariantOutput> buildOutputs, com.android.build.gradle.internal.dependency.SourceSetManager sourceSetManager, com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)

Method Summary

Modifier and Type	Method and Description
void	addVariant(BaseVariant variant)
void	aidlPackageWhiteList(java.lang.String... aidlFqcns)
java.util.Collection<java.lang.String>	getAidlPackageWhiteList() Aidl files to package in the aar.
org.gradle.api.internal.DefaultDomainObjectSet<LibraryVariant>	getLibraryVariants() Returns a collection of build variants that the library project includes.
java.lang.Boolean	getPackageBuildConfig() Whether to package build config class file.
void	packageBuildConfig(boolean value)
void	setAidlPackageWhiteList(java.util.Collection<java.lang.String> aidlPackageWhiteList)
void	setPackageBuildConfig(boolean value) Deprecated.

Methods inherited from class com.android.build.gradle.TestedExtension

addTestVariant, addUnitTestVariant, getMockableAndroidJar, getTestBuildType, getTestVariants, getUnitTestVariants, setTestBuildType

Methods inherited from class com.android.build.gradle.BaseExtension

aaptOptions, adbOptions, buildToolsVersion, buildTypes, checkWritability, compileOptions, compileSdkVersion, compileSdkVersion, dataBinding, defaultConfig, defaultPublishConfig, deviceProvider, dexOptions, disableWrite, externalNativeBuild, flavorDimensions, generatePureSplits, getAaptOptions, getAdbExe, getAdbExecutable, getAdbOptions, getBaseFeature, getBootClasspath, getBuildOutputs, getBuildToolsRevision, getBuildToolsVersion, getBuildTypes, getCompileOptions, getCompileSdkVersion, getDataBinding, getDefaultConfig, getDefaultProguardFile, getDefaultPublishConfig, getDeviceProviders, getDexOptions, getExternalNativeBuild, getFlavorDimensionList, getGeneratePureSplits, getJacoco, getLibraryRequests, getLintOptions, getNdkDirectory, getNdkVersion, getPackagingOptions, getProductFlavors, getResourcePrefix, getSdkDirectory, getSigningConfigs, getSourceSets, getSplits, getTestOptions, getTestServers, getTransforms, getTransformsDependencies, getVariantFilter, getViewBinding, jacoco, lintOptions, packagingOptions, productFlavors, registerArtifactType, registerBuildTypeSourceProvider, registerJavaArtifact, registerMultiFlavorSourceProvider, registerProductFlavorSourceProvider, registerTransform, resourcePrefix, setBuildToolsVersion, setCompileSdkVersion, setCompileSdkVersion, setDefaultPublishConfig, setGeneratePureSplits, setNdkVersion, setPublishNonDefault, setVariantFilter, signingConfigs, sourceSets, splits, testOptions, testServer, useLibrary, useLibrary, variantFilter, viewBinding, wrapJavaSourceSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.android.build.gradle.AndroidConfig

getAaptOptions, getAdbOptions, getBaseFeature, getBootClasspath, getBuildOutputs, getBuildToolsRevision, getBuildToolsVersion, getBuildTypes, getCompileOptions, getCompileSdkVersion, getDataBinding, getDefaultConfig, getDefaultPublishConfig, getDeviceProviders, getDexOptions, getExternalNativeBuild, getFlavorDimensionList, getGeneratePureSplits, getJacoco, getLibraryRequests, getLintOptions, getNdkVersion, getPackagingOptions, getProductFlavors, getResourcePrefix, getSigningConfigs, getSourceSets, getSplits, getTestOptions, getTestServers, getTransforms, getTransformsDependencies, getVariantFilter

Constructor Detail

LibraryExtension

public LibraryExtension(@NonNull
                        org.gradle.api.Project project,
                        @NonNull
                        ProjectOptions projectOptions,
                        @NonNull
                        com.android.build.gradle.internal.scope.GlobalScope globalScope,
                        @NonNull
                        org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.BuildType> buildTypes,
                        @NonNull
                        org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.ProductFlavor> productFlavors,
                        @NonNull
                        org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.SigningConfig> signingConfigs,
                        @NonNull
                        org.gradle.api.NamedDomainObjectContainer<BaseVariantOutput> buildOutputs,
                        @NonNull
                        com.android.build.gradle.internal.dependency.SourceSetManager sourceSetManager,
                        @NonNull
                        com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)

Method Detail

getLibraryVariants

public org.gradle.api.internal.DefaultDomainObjectSet<LibraryVariant> getLibraryVariants()

Returns a collection of build variants that the library project includes.

To process elements in this collection, you should use the all iterator. That's because the plugin populates this collection only after the project is evaluated. Unlike the each iterator, using all processes future elements as the plugin creates them.

The following sample iterates through all libraryVariants elements to inject a build variable into the manifest:

 android.libraryVariants.all { variant ->
     def mergedFlavor = variant.getMergedFlavor()
     // Defines the value of a build variable you can use in the manifest.
     mergedFlavor.manifestPlaceholders = [hostName:"www.example.com"]
 }
 

addVariant

public void addVariant(BaseVariant variant)

Specified by:

addVariant in class BaseExtension

packageBuildConfig

public void packageBuildConfig(boolean value)

setPackageBuildConfig

@Deprecated
public void setPackageBuildConfig(boolean value)

Deprecated.

getPackageBuildConfig

public java.lang.Boolean getPackageBuildConfig()

Description copied from interface: AndroidConfig

Whether to package build config class file.

Specified by:

getPackageBuildConfig in interface AndroidConfig

Overrides:

getPackageBuildConfig in class BaseExtension

aidlPackageWhiteList

public void aidlPackageWhiteList(java.lang.String... aidlFqcns)

setAidlPackageWhiteList

public void setAidlPackageWhiteList(java.util.Collection<java.lang.String> aidlPackageWhiteList)

getAidlPackageWhiteList

public java.util.Collection<java.lang.String> getAidlPackageWhiteList()

Description copied from interface: AndroidConfig

Aidl files to package in the aar.

Specified by:

getAidlPackageWhiteList in interface AndroidConfig

Overrides:

getAidlPackageWhiteList in class BaseExtension