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

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

The minimum SDK version.

abstract String

The minimum SDK version.

abstract @NonNull String

The name of the flavor.

abstract Boolean

Whether the renderscript code should be compiled to generate C/C++ bindings.

abstract Boolean

Whether the renderscript BLAS support lib should be used to make it compatible with older versions of Android.

abstract Boolean

Whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android.

abstract Integer

The renderscript target api, or null if not specified.

abstract @NonNull Set<@NonNull String>

Specifies a list of alternative resources to keep.

abstract String

Test application ID.

abstract Boolean

See instrumentation.

abstract Boolean

See instrumentation.

abstract String

Test instrumentation runner class name.

abstract @NonNull Map<@NonNull String, @NonNull String>

Test instrumentation runner custom arguments.

abstract @NonNull VectorDrawables

Options to configure the build-time support for vector drawables.

abstract Boolean

Whether to enable unbundling mode for embedded wear app.

abstract void

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

This method is deprecated. Replaced by resourceConfigurations field

abstract void

This method is deprecated. Replaced by resourceConfigurations field

abstract void

This method is deprecated. Replaced by resourceConfigurations field

abstract void

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

This method is deprecated. Replaced by testInstrumentationRunnerArguments property

abstract void

This method is deprecated. Replaced by testInstrumentationRunnerArguments property

abstract void

Configures VectorDrawables.

From org.gradle.api.plugins.ExtensionAware
From com.android.build.api.dsl.LibraryBaseFlavor
abstract Integer

The target SDK version used for building the test APK.

abstract String

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

Options for configuring AAR metadata.

abstract @NonNull Object

Adds a proguard rule file to be included in the published AAR.

abstract @NonNull Object

Adds proguard rule files to be included in the published AAR.

abstract @NonNull AarMetadata

Options for configuring AAR metadata.

abstract @NonNull List<@NonNull File>

ProGuard rule files to be included in the published AAR.

abstract Boolean

Returns whether multi-dex is enabled.

abstract ApkSigningConfig

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

The associated signing config or null if none are set on the variant dimension.

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

Specifies the flavor dimension that this product flavor belongs to.

abstract @NonNull List<@NonNull String>

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

This method is deprecated. Replaced with property matchingFallbacks

abstract void

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

Encapsulates per-variant CMake and ndk-build configurations for your external native build.

abstract @NonNull ExternalNativeBuildFlags

Encapsulates per-variant CMake and ndk-build configurations for your external native build.

abstract @NonNull JavaCompileOptions

Options for configuring Java compilation.

abstract @NonNull Map<@NonNull String, @NonNull Object>

The manifest placeholders.

abstract File

Text file that specifies additional classes that will be compiled into the main dex file.

abstract File

Text file with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.

abstract @NonNull Ndk

Encapsulates per-variant configurations for the NDK, such as ABI filters.

abstract @NonNull Optimization
abstract @NonNull List<@NonNull File>

Specifies the ProGuard configuration files that the plugin should use.

abstract @NonNull Shaders

Options for configuring the shader compiler.

abstract @NonNull List<@NonNull File>

The collection of proguard rule files to be used when processing test code.

abstract void

Options for configuring Java compilation.

abstract void
ndk(@ExtensionFunctionType @NonNull Function1<@NonNull NdkUnit> action)

Encapsulates per-variant configurations for the NDK, such as ABI filters.

abstract void
abstract @NonNull Object
proguardFile(@NonNull Object proguardFile)

Adds a new ProGuard configuration file.

abstract @NonNull Object

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 ShadersUnit> action
)

Configure the shader compiler options.

abstract @NonNull Object

Adds a proguard rule file to be used when processing test code.

abstract @NonNull Object

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