com.android.builder.model

Interface BaseConfig

All Known Subinterfaces:

BuildType, ProductFlavor

public interface BaseConfig

Base config object for Build Type and Product flavor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationIdSuffix() Returns the application id suffix applied to this base config.
java.util.Map<java.lang.String,ClassField>	getBuildConfigFields() Map of Build Config Fields where the key is the field name.
java.util.Collection<java.io.File>	getConsumerProguardFiles() Returns the collection of proguard rule files for consumers of the library to use.
java.util.List<java.io.File>	getJarJarRuleFiles() Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getManifestPlaceholders() Returns the map of key value pairs for placeholder substitution in the android manifest file.
java.lang.Boolean	getMultiDexEnabled() Returns whether multi-dex is enabled.
java.io.File	getMultiDexKeepFile()
java.io.File	getMultiDexKeepProguard()
java.lang.String	getName()
java.util.Collection<java.io.File>	getProguardFiles() Specifies the ProGuard configuration files that the plugin should use.
java.util.Map<java.lang.String,ClassField>	getResValues() Map of generated res values where the key is the res name.
java.util.Collection<java.io.File>	getTestProguardFiles() Returns the collection of proguard rule files to use for the test APK.
java.lang.String	getVersionNameSuffix() Returns the version name suffix of this flavor or null if none have been set.

Method Detail

getName

@NonNull
java.lang.String getName()

getApplicationIdSuffix

@Nullable
java.lang.String getApplicationIdSuffix()

Returns the application id suffix applied to this base config. To get the final application id, use AndroidArtifact.getApplicationId().

Returns:

the application id

getVersionNameSuffix

@Nullable
java.lang.String getVersionNameSuffix()

Returns the version name suffix of this flavor or null if none have been set. This is only the value set on this product flavor, not necessarily the actual version name suffix used.

Returns:

the version name suffix, or null if not specified

getBuildConfigFields

@NonNull
java.util.Map<java.lang.String,ClassField> getBuildConfigFields()

Map of Build Config Fields where the key is the field name.

Returns:

a non-null map of class fields (possibly empty).

getResValues

@NonNull
java.util.Map<java.lang.String,ClassField> getResValues()

Map of generated res values where the key is the res name.

Returns:

a non-null map of class fields (possibly empty).

getProguardFiles

@NonNull
java.util.Collection<java.io.File> getProguardFiles()

Specifies the ProGuard configuration files that the plugin should use.

There are two ProGuard rules files that ship with the Android plugin and are used by default:

• proguard-android.txt
• proguard-android-optimize.txt

proguard-android-optimize.txt is identical to proguard-android.txt , exccept with optimizations enabled. You can use getDefaultProguardFile(String filename) to return the full path of the files.

Returns:

a non-null collection of files.

See Also:

getTestProguardFiles()

getConsumerProguardFiles

@NonNull
java.util.Collection<java.io.File> getConsumerProguardFiles()

Returns the collection of proguard rule files for consumers of the library to use.

Returns:

a non-null collection of files.

getTestProguardFiles

@NonNull
java.util.Collection<java.io.File> getTestProguardFiles()

Returns the collection of proguard rule files to use for the test APK.

Returns:

a non-null collection of files.

getManifestPlaceholders

@NonNull
java.util.Map<java.lang.String,java.lang.Object> getManifestPlaceholders()

Returns the map of key value pairs for placeholder substitution in the android manifest file. This map will be used by the manifest merger.

Returns:

the map of key value pairs.

getMultiDexEnabled

@Nullable
java.lang.Boolean getMultiDexEnabled()

Returns whether multi-dex is enabled. This can be null if the flag is not set, in which case the default value is used.

getMultiDexKeepFile

@Nullable
java.io.File getMultiDexKeepFile()

getMultiDexKeepProguard

@Nullable
java.io.File getMultiDexKeepProguard()

getJarJarRuleFiles

@Deprecated
 @NonNull
java.util.List<java.io.File> getJarJarRuleFiles()

Deprecated.

This property can only be used with the Jack toolchain, which is deprecated.

If you are currently using Jack, you should migrate to using the default toolchain, which includes improved support for Java 8 language features. To learn more, read Use Java 8 language features.