com.android.builder.core

Class DefaultProductFlavor

java.lang.Object

com.android.builder.internal.BaseConfigImpl

com.android.builder.core.DefaultProductFlavor

All Implemented Interfaces:

com.android.builder.model.BaseConfig, com.android.builder.model.DimensionAware, com.android.builder.model.ProductFlavor, java.io.Serializable

public class DefaultProductFlavor
extends com.android.builder.internal.BaseConfigImpl
implements com.android.builder.model.ProductFlavor

The configuration of a product flavor. This is also used to describe the default configuration of all builds, even those that do not contain any flavors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultProductFlavor(java.lang.String name) Creates a ProductFlavor with a given name.
DefaultProductFlavor(java.lang.String name, DefaultVectorDrawablesOptions vectorDrawablesOptions)

Method Summary

Modifier and Type	Method and Description
void	addResourceConfiguration(java.lang.String configuration) Adds a res config filter (for instance 'hdpi')
void	addResourceConfigurations(java.util.Collection<java.lang.String> configurations) Adds a res config filter (for instance 'hdpi')
void	addResourceConfigurations(java.lang.String... configurations) Adds a res config filter (for instance 'hdpi')
java.lang.String	getApplicationId() Returns the application ID.
java.lang.String	getDimension() Name of the dimension this product flavor belongs to.
java.lang.Integer	getMaxSdkVersion()
com.android.builder.model.ApiVersion	getMinSdkVersion() Min SDK version.
java.lang.String	getName()
java.lang.Boolean	getRenderscriptNdkModeEnabled()
java.lang.Boolean	getRenderscriptSupportModeBlasEnabled()
java.lang.Boolean	getRenderscriptSupportModeEnabled()
java.lang.Integer	getRenderscriptTargetApi()
java.util.Collection<java.lang.String>	getResourceConfigurations() Adds a res config filter (for instance 'hdpi')
com.android.builder.model.SigningConfig	getSigningConfig() Signing config used by this product flavor.
com.android.builder.model.ApiVersion	getTargetSdkVersion() Target SDK version.
java.lang.String	getTestApplicationId() Test application ID.
java.lang.Boolean	getTestFunctionalTest() See instrumentation.
java.lang.Boolean	getTestHandleProfiling() See instrumentation.
java.lang.String	getTestInstrumentationRunner() Test instrumentation runner class name.
java.util.Map<java.lang.String,java.lang.String>	getTestInstrumentationRunnerArguments() Test instrumentation runner custom arguments.
DefaultVectorDrawablesOptions	getVectorDrawables() Options to configure the build-time support for vector drawables.
java.lang.Integer	getVersionCode() Version code.
java.lang.String	getVersionName() Version name.
java.lang.Boolean	getWearAppUnbundled() Returns whether to enable unbundling mode for embedded wear app.
static java.lang.String	mergeApplicationIdSuffix(java.lang.String overlay, java.lang.String base)
static java.lang.String	mergeVersionNameSuffix(java.lang.String overlay, java.lang.String base)
com.android.builder.model.ProductFlavor	setApplicationId(java.lang.String applicationId) Sets the application id.
void	setDimension(java.lang.String dimension)
com.android.builder.model.ProductFlavor	setMaxSdkVersion(java.lang.Integer maxSdkVersion)
com.android.builder.model.ProductFlavor	setMinSdkVersion(com.android.builder.model.ApiVersion minSdkVersion) Sets the minSdkVersion to the given value.
com.android.builder.model.ProductFlavor	setRenderscriptNdkModeEnabled(java.lang.Boolean renderscriptNdkMode) Sets whether the renderscript code should be compiled to generate C/C++ bindings.
com.android.builder.model.ProductFlavor	setRenderscriptSupportModeBlasEnabled(java.lang.Boolean renderscriptSupportModeBlas) Sets whether RenderScript BLAS support lib should be used to make it compatible with older versions of Android.
com.android.builder.model.ProductFlavor	setRenderscriptSupportModeEnabled(java.lang.Boolean renderscriptSupportMode) Sets whether the renderscript code should be compiled in support mode to make it compatible with older versions of Android.
void	setRenderscriptTargetApi(java.lang.Integer renderscriptTargetApi) Sets the renderscript target API to the given value.
com.android.builder.model.ProductFlavor	setSigningConfig(com.android.builder.model.SigningConfig signingConfig) Sets the signing configuration.
com.android.builder.model.ProductFlavor	setTargetSdkVersion(com.android.builder.model.ApiVersion targetSdkVersion) Sets the targetSdkVersion to the given value.
com.android.builder.model.ProductFlavor	setTestApplicationId(java.lang.String applicationId) Sets the test application ID.
com.android.builder.model.ProductFlavor	setTestFunctionalTest(boolean functionalTest)
com.android.builder.model.ProductFlavor	setTestHandleProfiling(boolean handleProfiling)
com.android.builder.model.ProductFlavor	setTestInstrumentationRunner(java.lang.String testInstrumentationRunner) Sets the test instrumentation runner to the given value.
com.android.builder.model.ProductFlavor	setTestInstrumentationRunnerArguments(java.util.Map<java.lang.String,java.lang.String> testInstrumentationRunnerArguments) Sets the test instrumentation runner custom arguments.
com.android.builder.model.ProductFlavor	setVersionCode(java.lang.Integer versionCode) Sets the version code.
com.android.builder.model.ProductFlavor	setVersionName(java.lang.String versionName) Sets the version name.
void	setWearAppUnbundled(java.lang.Boolean wearAppUnbundled) Sets whether to enable unbundling mode for embedded wear app.
java.lang.String	toString()

Methods inherited from class com.android.builder.internal.BaseConfigImpl

_initWith, addBuildConfigField, addBuildConfigFields, addFlavorSelections, addManifestPlaceholders, addResValue, addResValues, flavorSelection, getApplicationIdSuffix, getBuildConfigFields, getConsumerProguardFiles, getFlavorSelections, getJarJarRuleFiles, getManifestPlaceholders, getMultiDexEnabled, getMultiDexKeepFile, getMultiDexKeepProguard, getProguardFiles, getResValues, getTestProguardFiles, getVersionNameSuffix, setApplicationIdSuffix, setJarJarRuleFiles, setManifestPlaceholders, setMultiDexEnabled, setMultiDexKeepFile, setMultiDexKeepProguard, setVersionNameSuffix

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.builder.model.BaseConfig

getApplicationIdSuffix, getBuildConfigFields, getConsumerProguardFiles, getFlavorSelections, getJarJarRuleFiles, getManifestPlaceholders, getMultiDexEnabled, getMultiDexKeepFile, getMultiDexKeepProguard, getProguardFiles, getResValues, getTestProguardFiles, getVersionNameSuffix

Constructor Detail

DefaultProductFlavor

public DefaultProductFlavor(@NonNull
                            java.lang.String name)

Creates a ProductFlavor with a given name. Names can be important when dealing with flavor groups.

Parameters:

name - the name of the flavor.

See Also:

BuilderConstants.MAIN

DefaultProductFlavor

public DefaultProductFlavor(@NonNull
                            java.lang.String name,
                            @NonNull
                            DefaultVectorDrawablesOptions vectorDrawablesOptions)

Method Detail

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface com.android.builder.model.BaseConfig

Specified by:

getName in interface com.android.builder.model.ProductFlavor

setDimension

public void setDimension(@NonNull
                         java.lang.String dimension)

getDimension

@Nullable
public java.lang.String getDimension()

Name of the dimension this product flavor belongs to.

Specified by:

getDimension in interface com.android.builder.model.DimensionAware

setApplicationId

@NonNull
public com.android.builder.model.ProductFlavor setApplicationId(java.lang.String applicationId)

Sets the application id.

getApplicationId

@Nullable
public java.lang.String getApplicationId()

Returns the application ID.

See Set the Application ID

Specified by:

getApplicationId in interface com.android.builder.model.ProductFlavor

setVersionCode

@NonNull
public com.android.builder.model.ProductFlavor setVersionCode(java.lang.Integer versionCode)

Sets the version code.

Parameters:

versionCode - the version code

Returns:

the flavor object

getVersionCode

@Nullable
public java.lang.Integer getVersionCode()

Version code.

See Versioning Your Application

Specified by:

getVersionCode in interface com.android.builder.model.ProductFlavor

setVersionName

@NonNull
public com.android.builder.model.ProductFlavor setVersionName(java.lang.String versionName)

Sets the version name.

Parameters:

versionName - the version name

Returns:

the flavor object

getVersionName

@Nullable
public java.lang.String getVersionName()

Version name.

See Versioning Your Application

Specified by:

getVersionName in interface com.android.builder.model.ProductFlavor

setMinSdkVersion

@NonNull
public com.android.builder.model.ProductFlavor setMinSdkVersion(com.android.builder.model.ApiVersion minSdkVersion)

Sets the minSdkVersion to the given value.

getMinSdkVersion

@Nullable
public com.android.builder.model.ApiVersion getMinSdkVersion()

Min SDK version.

Specified by:

getMinSdkVersion in interface com.android.builder.model.ProductFlavor

setTargetSdkVersion

@NonNull
public com.android.builder.model.ProductFlavor setTargetSdkVersion(@Nullable
                                                                            com.android.builder.model.ApiVersion targetSdkVersion)

Sets the targetSdkVersion to the given value.

getTargetSdkVersion

@Nullable
public com.android.builder.model.ApiVersion getTargetSdkVersion()

Target SDK version.

Specified by:

getTargetSdkVersion in interface com.android.builder.model.ProductFlavor

setMaxSdkVersion

@NonNull
public com.android.builder.model.ProductFlavor setMaxSdkVersion(java.lang.Integer maxSdkVersion)

getMaxSdkVersion

@Nullable
public java.lang.Integer getMaxSdkVersion()

Specified by:

getMaxSdkVersion in interface com.android.builder.model.ProductFlavor

getRenderscriptTargetApi

@Nullable
public java.lang.Integer getRenderscriptTargetApi()

Specified by:

getRenderscriptTargetApi in interface com.android.builder.model.ProductFlavor

setRenderscriptTargetApi

public void setRenderscriptTargetApi(@Nullable
                                     java.lang.Integer renderscriptTargetApi)

Sets the renderscript target API to the given value.

getRenderscriptSupportModeEnabled

@Nullable
public java.lang.Boolean getRenderscriptSupportModeEnabled()

Specified by:

getRenderscriptSupportModeEnabled in interface com.android.builder.model.ProductFlavor

getRenderscriptSupportModeBlasEnabled

@Nullable
public java.lang.Boolean getRenderscriptSupportModeBlasEnabled()

Specified by:

getRenderscriptSupportModeBlasEnabled in interface com.android.builder.model.ProductFlavor

setRenderscriptSupportModeEnabled

public com.android.builder.model.ProductFlavor setRenderscriptSupportModeEnabled(java.lang.Boolean renderscriptSupportMode)

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

setRenderscriptSupportModeBlasEnabled

public com.android.builder.model.ProductFlavor setRenderscriptSupportModeBlasEnabled(java.lang.Boolean renderscriptSupportModeBlas)

Sets whether RenderScript BLAS support lib should be used to make it compatible with older versions of Android.

getRenderscriptNdkModeEnabled

@Nullable
public java.lang.Boolean getRenderscriptNdkModeEnabled()

Specified by:

getRenderscriptNdkModeEnabled in interface com.android.builder.model.ProductFlavor

setRenderscriptNdkModeEnabled

public com.android.builder.model.ProductFlavor setRenderscriptNdkModeEnabled(java.lang.Boolean renderscriptNdkMode)

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

setTestApplicationId

@NonNull
public com.android.builder.model.ProductFlavor setTestApplicationId(java.lang.String applicationId)

Sets the test application ID.

getTestApplicationId

@Nullable
public java.lang.String getTestApplicationId()

Test application ID.

See Set the Application ID

Specified by:

getTestApplicationId in interface com.android.builder.model.ProductFlavor

setTestInstrumentationRunner

@NonNull
public com.android.builder.model.ProductFlavor setTestInstrumentationRunner(java.lang.String testInstrumentationRunner)

Sets the test instrumentation runner to the given value.

getTestInstrumentationRunner

@Nullable
public java.lang.String getTestInstrumentationRunner()

Test instrumentation runner class name.

This is a fully qualified class name of the runner, e.g. android.test.InstrumentationTestRunner

See instrumentation.

Specified by:

getTestInstrumentationRunner in interface com.android.builder.model.ProductFlavor

setTestInstrumentationRunnerArguments

@NonNull
public com.android.builder.model.ProductFlavor setTestInstrumentationRunnerArguments(@NonNull
                                                                                              java.util.Map<java.lang.String,java.lang.String> testInstrumentationRunnerArguments)

Sets the test instrumentation runner custom arguments.

getTestInstrumentationRunnerArguments

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getTestInstrumentationRunnerArguments()

Test instrumentation runner custom arguments. e.g. [key: "value"] will give adb shell am instrument -w -e key value com.example...".

See instrumentation.

Test runner arguments can also be specified from the command line:

 ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.size=medium
 ./gradlew connectedAndroidTest -Pandroid.testInstrumentationRunnerArguments.foo=bar
 

Specified by:

getTestInstrumentationRunnerArguments in interface com.android.builder.model.ProductFlavor

getTestHandleProfiling

@Nullable
public java.lang.Boolean getTestHandleProfiling()

See instrumentation.

Specified by:

getTestHandleProfiling in interface com.android.builder.model.ProductFlavor

setTestHandleProfiling

@NonNull
public com.android.builder.model.ProductFlavor setTestHandleProfiling(boolean handleProfiling)

getTestFunctionalTest

@Nullable
public java.lang.Boolean getTestFunctionalTest()

See instrumentation.

Specified by:

getTestFunctionalTest in interface com.android.builder.model.ProductFlavor

setTestFunctionalTest

@NonNull
public com.android.builder.model.ProductFlavor setTestFunctionalTest(boolean functionalTest)

getSigningConfig

@Nullable
public com.android.builder.model.SigningConfig getSigningConfig()

Signing config used by this product flavor.

Specified by:

getSigningConfig in interface com.android.builder.model.ProductFlavor

setSigningConfig

@NonNull
public com.android.builder.model.ProductFlavor setSigningConfig(com.android.builder.model.SigningConfig signingConfig)

Sets the signing configuration. e.g.: signingConfig signingConfigs.myConfig

getVectorDrawables

@NonNull
public DefaultVectorDrawablesOptions getVectorDrawables()

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

Specified by:

getVectorDrawables in interface com.android.builder.model.ProductFlavor

getWearAppUnbundled

@Nullable
public java.lang.Boolean getWearAppUnbundled()

Returns whether to enable unbundling mode for embedded wear app. If true, this enables the app to transition from an embedded wear app to one distributed by the play store directly.

Specified by:

getWearAppUnbundled in interface com.android.builder.model.ProductFlavor

setWearAppUnbundled

public void setWearAppUnbundled(@Nullable
                                java.lang.Boolean wearAppUnbundled)

Sets whether to enable unbundling mode for embedded wear app. If true, this enables the app to transition from an embedded wear app to one distributed by the play store directly.

addResourceConfiguration

public void addResourceConfiguration(@NonNull
                                     java.lang.String configuration)

Adds a res config filter (for instance 'hdpi')

addResourceConfigurations

public void addResourceConfigurations(@NonNull
                                      java.lang.String... configurations)

Adds a res config filter (for instance 'hdpi')

addResourceConfigurations

public void addResourceConfigurations(@NonNull
                                      java.util.Collection<java.lang.String> configurations)

Adds a res config filter (for instance 'hdpi')

getResourceConfigurations

@NonNull
public java.util.Collection<java.lang.String> getResourceConfigurations()

Adds a res config filter (for instance 'hdpi')

Specified by:

getResourceConfigurations in interface com.android.builder.model.ProductFlavor

mergeApplicationIdSuffix

public static java.lang.String mergeApplicationIdSuffix(@Nullable
                                                        java.lang.String overlay,
                                                        @Nullable
                                                        java.lang.String base)

mergeVersionNameSuffix

public static java.lang.String mergeVersionNameSuffix(@Nullable
                                                      java.lang.String overlay,
                                                      @Nullable
                                                      java.lang.String base)

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class com.android.builder.internal.BaseConfigImpl