ProductFlavor (Gradle API 1.2.3)

com.android.build.gradle.internal.dsl.ProductFlavor

DSL object used to configure product flavors.

Field Summary

Fields
Modifiers	Name	Description
`protected org.gradle.api.logging.Logger`	`logger`
`protected org.gradle.api.Project`	`project`

Constructor Summary

Constructors
Constructor and description
`ProductFlavor (String name, org.gradle.api.Project project, org.gradle.internal.reflect.Instantiator instantiator, org.gradle.api.logging.Logger logger)`

Methods Summary

Methods
Type	Name and description
`void`	`buildConfigField(String type, String name, String value)` Adds a new field to the generated BuildConfig class.
`void`	`consumerProguardFiles(Object... proguardFileArray)`
`NdkConfig`	`getNdkConfig()`
`SigningConfig`	`getSigningConfig()` Signing config used by this product flavor.
`Boolean`	`getUseJack()` Whether the experimental Jack toolchain should be used.
`void`	`maxSdkVersion(int targetSdkVersion)` Sets the maximum SDK version to the given value.
`void`	`minSdkVersion(int minSdkVersion)` Sets minimum SDK version.
`void`	`minSdkVersion(String minSdkVersion)` Sets minimum SDK version.
`void`	`ndk(org.gradle.api.Action<NdkOptions> action)`
`void`	`proguardFile(Object proguardFile)` Adds a new ProGuard configuration file.
`void`	`proguardFiles(Object... proguardFileArray)` Adds new ProGuard configuration files.
`void`	`resConfig(String config)` Adds a resource configuration filter.
`void`	`resConfigs(String... config)` Adds several resource configuration filters.
`void`	`resConfigs(Collection<String> config)` Adds several resource configuration filters.
`void`	`resValue(String type, String name, String value)` Adds a new generated resource.
`void`	`setConsumerProguardFiles(Iterable<?> proguardFileIterable)` Specifies a proguard rule file to be included in the published AAR.
`void`	`setMinSdkVersion(int minSdkVersion)`
`void`	`setMinSdkVersion(String minSdkVersion)`
`void`	`setProguardFiles(Iterable<?> proguardFileIterable)` Sets the ProGuard configuration files.
`com.android.builder.model.ProductFlavor`	`setTargetSdkVersion(int targetSdkVersion)`
`void`	`setTargetSdkVersion(String targetSdkVersion)`
`void`	`setUseJack(Boolean useJack)` Whether the experimental Jack toolchain should be used.
`void`	`targetSdkVersion(int targetSdkVersion)` Sets the target SDK version to the given value.
`void`	`targetSdkVersion(String targetSdkVersion)` Sets the target SDK version to the given value.
`void`	`testProguardFile(Object proguardFile)` Specifies a proguard rule file to be included in the published AAR.
`void`	`testProguardFiles(Object... proguardFileArray)` Adds new ProGuard configuration files.
`void`	`useJack(Boolean useJack)` Whether the experimental Jack toolchain should be used.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultProductFlavor`	addResourceConfiguration, addResourceConfigurations, addResourceConfigurations, equals, getApplicationId, getDimension, getMaxSdkVersion, getMinSdkVersion, getName, getRenderscriptNdkModeEnabled, getRenderscriptSupportModeEnabled, getRenderscriptTargetApi, getResourceConfigurations, getSigningConfig, getTargetSdkVersion, getTestApplicationId, getTestFunctionalTest, getTestHandleProfiling, getTestInstrumentationRunner, getVersionCode, getVersionName, hashCode, setApplicationId, setDimension, setMaxSdkVersion, setMinSdkVersion, setRenderscriptNdkModeEnabled, setRenderscriptSupportModeEnabled, setRenderscriptTargetApi, setSigningConfig, setTargetSdkVersion, setTestApplicationId, setTestFunctionalTest, setTestHandleProfiling, setTestInstrumentationRunner, setVersionCode, setVersionName, toString
`class BaseConfigImpl`	`_initWith, addBuildConfigField, addBuildConfigFields, addManifestPlaceholders, addResValue, addResValues, equals, getBuildConfigFields, getConsumerProguardFiles, getManifestPlaceholders, getMultiDexEnabled, getMultiDexKeepFile, getMultiDexKeepProguard, getProguardFiles, getResValues, getTestProguardFiles, hashCode, setManifestPlaceholders, setMultiDexEnabled, setMultiDexKeepFile, setMultiDexKeepProguard, toString`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - @com.android.annotations.NonNull protected final org.gradle.api.logging.Logger logger
  - @com.android.annotations.NonNull protected final org.gradle.api.Project project
- Constructor Detail
  - ProductFlavor(@com.android.annotations.NonNull String name, @com.android.annotations.NonNull org.gradle.api.Project project, @com.android.annotations.NonNull org.gradle.internal.reflect.Instantiator instantiator, @com.android.annotations.NonNull org.gradle.api.logging.Logger logger)
- Method Detail
  - void buildConfigField(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull String value)
    
    Adds a new field to the generated BuildConfig class. The field is generated as: = ; This means each of these must have valid Java content. If the type is a String, then the value should include quotes.
    Parameters:
    type - the type of the field
    name - the name of the field
    value - the value of the field
  - @com.android.annotations.NonNull void consumerProguardFiles(Object... proguardFileArray)
  - @com.android.annotations.Nullable NdkConfig getNdkConfig()
  - @Override SigningConfig getSigningConfig()
    
    Signing config used by this product flavor.
  - Boolean getUseJack()
    
    Whether the experimental Jack toolchain should be used.
    See Jack and Jill
  - @com.android.annotations.NonNull void maxSdkVersion(int targetSdkVersion)
    
    Sets the maximum SDK version to the given value.
    See uses-sdk element documentation.
  - @com.android.annotations.NonNull void minSdkVersion(int minSdkVersion)
    
    Sets minimum SDK version.
    See uses-sdk element documentation.
  - @com.android.annotations.NonNull void minSdkVersion(String minSdkVersion)
    
    Sets minimum SDK version.
    See uses-sdk element documentation.
  - void ndk(org.gradle.api.Action<NdkOptions> action)
  - @com.android.annotations.NonNull void proguardFile(Object proguardFile)
    
    Adds a new ProGuard configuration file.
    proguardFile getDefaultProguardFile('proguard-android.txt')
    
    There are 2 default rules files
    - proguard-android.txt
    - proguard-android-optimize.txt
    They are located in the SDK. Using getDefaultProguardFile(String filename) will return the full path to the files. They are identical except for enabling optimizations.
  - @com.android.annotations.NonNull void proguardFiles(Object... proguardFileArray)
    
    Adds new ProGuard configuration files.
    There are 2 default rules files
    - proguard-android.txt
    - proguard-android-optimize.txt
    They are located in the SDK. Using getDefaultProguardFile(String filename) will return the full path to the files. They are identical except for enabling optimizations.
  - void resConfig(@com.android.annotations.NonNull String config)
    
    Adds a resource configuration filter.
    If a qualifier value is passed, then all other resources using a qualifier of the same type but of different value will be ignored from the final packaging of the APK.
    For instance, specifying 'hdpi', will ignore all resources using mdpi, xhdpi, etc...
  - void resConfigs(@com.android.annotations.NonNull String... config)
    
    Adds several resource configuration filters.
    If a qualifier value is passed, then all other resources using a qualifier of the same type but of different value will be ignored from the final packaging of the APK.
    For instance, specifying 'hdpi', will ignore all resources using mdpi, xhdpi, etc...
  - void resConfigs(@com.android.annotations.NonNull Collection<String> config)
    
    Adds several resource configuration filters.
    If a qualifier value is passed, then all other resources using a qualifier of the same type but of different value will be ignored from the final packaging of the APK.
    For instance, specifying 'hdpi', will ignore all resources using mdpi, xhdpi, etc...
  - void resValue(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull String value)
    
    Adds a new generated resource.
    This is equivalent to specifying a resource in res/values.
    See Resource Types.
    Parameters:
    type - the type of the resource
    name - the name of the resource
    value - the value of the resource
  - @com.android.annotations.NonNull void setConsumerProguardFiles(Iterable<?> proguardFileIterable)
    
    Specifies a proguard rule file to be included in the published AAR.
    This proguard rule file will then be used by any application project that consume the AAR (if proguard is enabled).
    This allows AAR to specify shrinking or obfuscation exclude rules.
    This is only valid for Library project. This is ignored in Application project.
  - @com.android.annotations.NonNull void setMinSdkVersion(int minSdkVersion)
  - @com.android.annotations.NonNull void setMinSdkVersion(String minSdkVersion)
  - @com.android.annotations.NonNull void setProguardFiles(Iterable<?> proguardFileIterable)
    
    Sets the ProGuard configuration files.
    There are 2 default rules files
    - proguard-android.txt
    - proguard-android-optimize.txt
    They are located in the SDK. Using getDefaultProguardFile(String filename) will return the full path to the files. They are identical except for enabling optimizations.
  - @com.android.annotations.NonNull com.android.builder.model.ProductFlavor setTargetSdkVersion(int targetSdkVersion)
  - @com.android.annotations.NonNull void setTargetSdkVersion(String targetSdkVersion)
  - void setUseJack(Boolean useJack)
    
    Whether the experimental Jack toolchain should be used.
    See Jack and Jill
  - @com.android.annotations.NonNull void targetSdkVersion(int targetSdkVersion)
    
    Sets the target SDK version to the given value.
    See uses-sdk element documentation.
  - @com.android.annotations.NonNull void targetSdkVersion(String targetSdkVersion)
    
    Sets the target SDK version to the given value.
    See uses-sdk element documentation.
  - @com.android.annotations.NonNull void testProguardFile(Object proguardFile)
    
    Specifies a proguard rule file to be included in the published AAR.
    This proguard rule file will then be used by any application project that consume the AAR (if proguard is enabled).
    This allows AAR to specify shrinking or obfuscation exclude rules.
    This is only valid for Library project. This is ignored in Application project.
  - @com.android.annotations.NonNull void testProguardFiles(Object... proguardFileArray)
    
    Adds new ProGuard configuration files.
  - void useJack(Boolean useJack)
    
    Whether the experimental Jack toolchain should be used.
    See Jack and Jill

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Gradle API 1.2.3

[Groovy] Class ProductFlavor

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

@com.android.annotations.NonNull protected final org.gradle.api.logging.Logger logger

@com.android.annotations.NonNull protected final org.gradle.api.Project project

Constructor Detail

ProductFlavor(@com.android.annotations.NonNull String name, @com.android.annotations.NonNull org.gradle.api.Project project, @com.android.annotations.NonNull org.gradle.internal.reflect.Instantiator instantiator, @com.android.annotations.NonNull org.gradle.api.logging.Logger logger)

Method Detail

void buildConfigField(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull String value)

@com.android.annotations.NonNull void consumerProguardFiles(Object... proguardFileArray)

@com.android.annotations.Nullable NdkConfig getNdkConfig()

@Override SigningConfig getSigningConfig()

Boolean getUseJack()

@com.android.annotations.NonNull void maxSdkVersion(int targetSdkVersion)

@com.android.annotations.NonNull void minSdkVersion(int minSdkVersion)

@com.android.annotations.NonNull void minSdkVersion(String minSdkVersion)

void ndk(org.gradle.api.Action<NdkOptions> action)

@com.android.annotations.NonNull void proguardFile(Object proguardFile)

@com.android.annotations.NonNull void proguardFiles(Object... proguardFileArray)

void resConfig(@com.android.annotations.NonNull String config)

void resConfigs(@com.android.annotations.NonNull String... config)

void resConfigs(@com.android.annotations.NonNull Collection<String> config)

void resValue(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull String value)

@com.android.annotations.NonNull void setConsumerProguardFiles(Iterable<?> proguardFileIterable)

@com.android.annotations.NonNull void setMinSdkVersion(int minSdkVersion)

@com.android.annotations.NonNull void setMinSdkVersion(String minSdkVersion)

@com.android.annotations.NonNull void setProguardFiles(Iterable<?> proguardFileIterable)

@com.android.annotations.NonNull com.android.builder.model.ProductFlavor setTargetSdkVersion(int targetSdkVersion)

@com.android.annotations.NonNull void setTargetSdkVersion(String targetSdkVersion)

void setUseJack(Boolean useJack)

@com.android.annotations.NonNull void targetSdkVersion(int targetSdkVersion)

@com.android.annotations.NonNull void targetSdkVersion(String targetSdkVersion)

@com.android.annotations.NonNull void testProguardFile(Object proguardFile)

@com.android.annotations.NonNull void testProguardFiles(Object... proguardFileArray)

void useJack(Boolean useJack)