LibraryProductFlavor

public interface LibraryProductFlavor extends LibraryBaseFlavor, ProductFlavor

Encapsulates all product flavors properties for library projects.

Product flavors represent different versions of your project that you expect to co-exist on a single device, the Google Play store, or repository. For example, you can configure 'demo' and 'full' product flavors for your app, and each of those flavors can specify different features, device requirements, resources, and application ID's--while sharing common source code and resources. So, product flavors allow you to output different versions of your project by simply changing only the components and settings that are different between them.

Configuring product flavors is similar to configuring build types: add them to the productFlavors block of your project's build.gradle file and configure the settings you want.

Product flavors support the same properties as the DefaultConfig block—this is because defaultConfig defines a ProductFlavor object that the plugin uses as the base configuration for all other flavors. Each flavor you configure can then override any of the default values in defaultConfig, such as the applicationId.

When using Android plugin 3.0.0 and higher, each flavor must belong to a dimension.

When you configure product flavors, the Android plugin automatically combines them with your BuildType configurations to create build variants. If the plugin creates certain build variants that you don't want, you can filter variants using android.variantFilter.

Summary

Public methods
`abstract boolean`	`isDefault()` Whether this product flavor should be selected in Studio by default
`abstract void`	`setDefault(boolean isDefault)` Whether this product flavor should be selected in Studio by default

Inherited methods

From com.android.build.api.dsl.BaseFlavor

`abstract Integer`	`getMinSdk()` The minimum SDK version.
`abstract String`	`getMinSdkPreview()` The minimum SDK version.
`abstract @NonNull String`	`getName()` The name of the flavor.
`abstract Boolean`	`getRenderscriptNdkModeEnabled()` Whether the renderscript code should be compiled to generate C/C++ bindings.
`abstract Boolean`	`getRenderscriptSupportModeBlasEnabled()` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android.
`abstract Boolean`	`getRenderscriptSupportModeEnabled()` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android.
`abstract Integer`	`getRenderscriptTargetApi()` The renderscript target api, or null if not specified.
`abstract @NonNull Set<@NonNull String>`	`getResourceConfigurations()` Specifies a list of alternative resources to keep.
`abstract String`	`getTestApplicationId()` Test application ID.
`abstract Boolean`	`getTestFunctionalTest()` See instrumentation.
`abstract Boolean`	`getTestHandleProfiling()` See instrumentation.
`abstract String`	`getTestInstrumentationRunner()` Test instrumentation runner class name.
`abstract @NonNull Map<@NonNull String, @NonNull String>`	`getTestInstrumentationRunnerArguments()` Test instrumentation runner custom arguments.
`abstract @NonNull VectorDrawables`	`getVectorDrawables()` Options to configure the build-time support for `vector` drawables.
`abstract Boolean`	`getWearAppUnbundled()` Whether to enable unbundling mode for embedded wear app.
`abstract void`	`initWith(@NonNull BaseFlavor that)` Copies all properties from the given flavor.
`abstract void`	`minSdkVersion(int minSdkVersion)` This method is deprecated. Replaced by minSdk property
`abstract void`	`minSdkVersion(String minSdkVersion)` This method is deprecated. Replaced by minSdkPreview property
`abstract void`	`missingDimensionStrategy( @NonNull String dimension, @NonNull String requestedValue )` Specifies a flavor that the plugin should try to use from a given dimension in a dependency.
`abstract void`	`missingDimensionStrategy( @NonNull String dimension, @NonNull List<@NonNull String> requestedValues )` Specifies a sorted list of flavors that the plugin should try to use from a given dimension in a dependency.
`abstract void`	`missingDimensionStrategy( @NonNull String dimension, @NonNull String requestedValues )` Specifies a sorted list of flavors that the plugin should try to use from a given dimension in a dependency.
`abstract void`	`resConfig(@NonNull String config)` This method is deprecated. Replaced by resourceConfigurations field
`abstract void`	`resConfigs(@NonNull Collection<@NonNull String> config)` This method is deprecated. Replaced by resourceConfigurations field
`abstract void`	`resConfigs(@NonNull String config)` This method is deprecated. Replaced by resourceConfigurations field
`abstract void`	`setMinSdk(Integer minSdk)` The minimum SDK version.
`abstract void`	`setMinSdkPreview(String minSdkPreview)` The minimum SDK version.
`abstract void`	`setMinSdkVersion(int minSdkVersion)` This method is deprecated. Replaced by minSdk property
`abstract void`	`setMinSdkVersion(String minSdkVersion)` This method is deprecated. Replaced by minSdkPreview property
`abstract void`	`setRenderscriptNdkModeEnabled(Boolean renderscriptNdkModeEnabled)` Whether the renderscript code should be compiled to generate C/C++ bindings.
`abstract void`	`setRenderscriptSupportModeBlasEnabled( Boolean renderscriptSupportModeBlasEnabled )` Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android.
`abstract void`	`setRenderscriptSupportModeEnabled( Boolean renderscriptSupportModeEnabled )` Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android.
`abstract void`	`setRenderscriptTargetApi(Integer renderscriptTargetApi)` The renderscript target api, or null if not specified.
`abstract void`	`setTestApplicationId(String testApplicationId)` Test application ID.
`abstract Object`	`setTestFunctionalTest(boolean testFunctionalTest)` This method is deprecated. Replaced by testFunctionalTest property
`abstract void`	`setTestFunctionalTest(Boolean testFunctionalTest)` See instrumentation.
`abstract Object`	`setTestHandleProfiling(boolean testHandleProfiling)` This method is deprecated. Replaced by testFunctionalTest property
`abstract void`	`setTestHandleProfiling(Boolean testHandleProfiling)` See instrumentation.
`abstract void`	`setTestInstrumentationRunner(String testInstrumentationRunner)` Test instrumentation runner class name.
`abstract Object`	`setTestInstrumentationRunnerArguments( @NonNull Map<@NonNull String, @NonNull String> testInstrumentationRunnerArguments )` This method is deprecated. Replaced by testInstrumentationRunnerArguments property
`abstract void`	`setWearAppUnbundled(Boolean wearAppUnbundled)` Whether to enable unbundling mode for embedded wear app.
`abstract void`	`testInstrumentationRunnerArgument( @NonNull String key, @NonNull String value )` This method is deprecated. Replaced by testInstrumentationRunnerArguments property
`abstract void`	`testInstrumentationRunnerArguments( @NonNull Map<@NonNull String, @NonNull String> args )` This method is deprecated. Replaced by testInstrumentationRunnerArguments property
`abstract void`	`vectorDrawables( @ExtensionFunctionType @NonNull Function1<@NonNull VectorDrawables, Unit> action )` Configures `VectorDrawables`.

From org.gradle.api.plugins.ExtensionAware

abstract @NonNull ExtensionContainer

@Internal
getExtensions()

From com.android.build.api.dsl.LibraryBaseFlavor

`abstract Integer`	`getTargetSdk()` The target SDK version used for building the test APK.
`abstract String`	`getTargetSdkPreview()` The target SDK version used for building the test APK.
`abstract void`	`setTargetSdk(Integer targetSdk)` The target SDK version used for building the test APK.
`abstract void`	`setTargetSdkPreview(String targetSdkPreview)` The target SDK version used for building the test APK.
`abstract void`	`setTargetSdkVersion(String targetSdkVersion)` This method is deprecated. Replaced by targetSdkPreview property
`abstract void`	`targetSdkVersion(int targetSdkVersion)` This method is deprecated. Replaced by targetSdk property
`abstract void`	`targetSdkVersion(String targetSdkVersion)` This method is deprecated. Replaced by targetSdkPreview property

From com.android.build.api.dsl.LibraryVariantDimension

`abstract void`	`aarMetadata( @ExtensionFunctionType @NonNull Function1<@NonNull AarMetadata, Unit> action )` Options for configuring AAR metadata.
`abstract @NonNull Object`	`consumerProguardFile(@NonNull Object proguardFile)` Adds a proguard rule file to be included in the published AAR.
`abstract @NonNull Object`	`consumerProguardFiles(@NonNull Object proguardFiles)` Adds proguard rule files to be included in the published AAR.
`abstract @NonNull AarMetadata`	`getAarMetadata()` Options for configuring AAR metadata.
`abstract @NonNull List<@NonNull File>`	`getConsumerProguardFiles()` ProGuard rule files to be included in the published AAR.
`abstract Boolean`	`getMultiDexEnabled()` Returns whether multi-dex is enabled.
`abstract ApkSigningConfig`	`getSigningConfig()` The associated signing config or null if none are set on the variant dimension.
`abstract void`	`setMultiDexEnabled(Boolean multiDexEnabled)` Returns whether multi-dex is enabled.
`abstract void`	`setSigningConfig(ApkSigningConfig signingConfig)` The associated signing config or null if none are set on the variant dimension.

From com.android.build.api.dsl.ProductFlavor

`abstract String`	`getDimension()` Specifies the flavor dimension that this product flavor belongs to.
`abstract @NonNull List<@NonNull String>`	`getMatchingFallbacks()` Specifies a sorted list of product flavors that the plugin should try to use when a direct variant match with a local module dependency is not possible.
`abstract Void`	`setDimension(String dimension)` This method is deprecated. Replaced with the dimension property
`abstract void`	`setDimension(String dimension)` Specifies the flavor dimension that this product flavor belongs to.
`abstract void`	`setMatchingFallbacks(@NonNull List<@NonNull String> fallbacks)` This method is deprecated. Replaced with property matchingFallbacks
`abstract void`	`setMatchingFallbacks(@NonNull String fallbacks)` This method is deprecated. Replaced with property matchingFallbacks

From com.android.build.api.dsl.VariantDimension

`abstract void`	`addManifestPlaceholders( @NonNull Map<@NonNull String, @NonNull Object> manifestPlaceholders )` Adds manifest placeholders.
`abstract void`	`buildConfigField( @NonNull String type, @NonNull String name, @NonNull String value )` Adds a new field to the generated BuildConfig class.
`abstract void`	`@Incubating externalNativeBuild( @ExtensionFunctionType @NonNull Function1<@NonNull ExternalNativeBuildFlags, Unit> action )` Encapsulates per-variant CMake and ndk-build configurations for your external native build.
`abstract @NonNull ExternalNativeBuildFlags`	`@Incubating getExternalNativeBuild()` Encapsulates per-variant CMake and ndk-build configurations for your external native build.
`abstract @NonNull JavaCompileOptions`	`getJavaCompileOptions()` Options for configuring Java compilation.
`abstract @NonNull Map<@NonNull String, @NonNull Object>`	`getManifestPlaceholders()` The manifest placeholders.
`abstract File`	`getMultiDexKeepFile()` Text file that specifies additional classes that will be compiled into the main dex file.
`abstract File`	`getMultiDexKeepProguard()` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.
`abstract @NonNull Ndk`	`getNdk()` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`abstract @NonNull Optimization`	`@Incubating getOptimization()`
`abstract @NonNull List<@NonNull File>`	`getProguardFiles()` Specifies the ProGuard configuration files that the plugin should use.
`abstract @NonNull Shaders`	`getShaders()` Options for configuring the shader compiler.
`abstract @NonNull List<@NonNull File>`	`getTestProguardFiles()` The collection of proguard rule files to be used when processing test code.
`abstract void`	`javaCompileOptions( @ExtensionFunctionType @NonNull Function1<@NonNull JavaCompileOptions, Unit> action )` Options for configuring Java compilation.
`abstract void`	`ndk(@ExtensionFunctionType @NonNull Function1<@NonNull Ndk, Unit> action)` Encapsulates per-variant configurations for the NDK, such as ABI filters.
`abstract void`	`@Incubating optimization( @ExtensionFunctionType @NonNull Function1<@NonNull Optimization, Unit> action )`
`abstract @NonNull Object`	`proguardFile(@NonNull Object proguardFile)` Adds a new ProGuard configuration file.
`abstract @NonNull Object`	`proguardFiles(@NonNull Object files)` Adds new ProGuard configuration files.
`abstract void`	`resValue(@NonNull String type, @NonNull String name, @NonNull String value)` Adds a new generated resource.
`abstract Void`	`setManifestPlaceholders( @NonNull Map<@NonNull String, @NonNull Object> manifestPlaceholders )` This method is deprecated. Use manifestPlaceholders property instead
`abstract void`	`setMultiDexKeepFile(File multiDexKeepFile)` Text file that specifies additional classes that will be compiled into the main dex file.
`abstract void`	`setMultiDexKeepProguard(File multiDexKeepProguard)` Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.
`abstract @NonNull Object`	`setProguardFiles(@NonNull Iterable<@NonNull ?> proguardFileIterable)` Replaces the ProGuard configuration files.
`abstract void`	`shaders( @ExtensionFunctionType @NonNull Function1<@NonNull Shaders, Unit> action )` Configure the shader compiler options.
`abstract @NonNull Object`	`testProguardFile(@NonNull Object proguardFile)` Adds a proguard rule file to be used when processing test code.
`abstract @NonNull Object`	`testProguardFiles(@NonNull Object proguardFiles)` Adds proguard rule files to be used when processing test code.

Public methods

isDefault

abstract boolean isDefault()

Whether this product flavor should be selected in Studio by default

setDefault

abstract void setDefault(boolean isDefault)

Whether this product flavor should be selected in Studio by default