@java.lang.SuppressWarnings("UnnecessaryInheritDoc") public abstract class BaseExtension extends java.lang.Object
Base 'android' extension for all android plugins.
This is never used directly. Instead,
com.android.application
uses AppExtensioncom.android.library
uses LibraryExtensioncom.android.test
uses TestExtensionType | Name and description |
---|---|
void |
aaptOptions(org.gradle.api.Action<com.android.build.gradle.internal.dsl.AaptOptions> action) Configures aapt options. |
void |
adbOptions(org.gradle.api.Action<com.android.build.gradle.internal.dsl.AdbOptions> action) Configures adb options. |
void |
addVariant(com.android.build.gradle.api.BaseVariant variant) |
void |
buildToolsVersion(java.lang.String version) |
void |
buildTypes(org.gradle.api.Action<? super org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.BuildType>> action) Configures build types. |
protected void |
checkWritability() |
void |
compileOptions(org.gradle.api.Action<com.android.build.gradle.internal.CompileOptions> action) Configures compile options. |
void |
compileSdkVersion(java.lang.String version) Sets the compile SDK version, based on full SDK version string, e.g. |
void |
compileSdkVersion(int apiLevel) Sets the compile SDK version, based on API level, e.g. 21 for Lollipop. |
protected void |
createConfiguration(org.gradle.api.artifacts.ConfigurationContainer configurations, java.lang.String configurationName, java.lang.String configurationDescription) |
void |
dataBinding(org.gradle.api.Action<com.android.build.gradle.internal.dsl.DataBindingOptions> action) Configures data binding options. |
void |
defaultConfig(org.gradle.api.Action<com.android.build.gradle.internal.dsl.ProductFlavor> action) The default configuration, inherited by all product flavors (if any are defined). |
void |
defaultPublishConfig(java.lang.String value) |
void |
deviceProvider(com.android.builder.testing.api.DeviceProvider deviceProvider) |
void |
dexOptions(org.gradle.api.Action<com.android.build.gradle.internal.dsl.DexOptions> action) Configures dex options. |
void |
disableWrite() Disallow further modification on the extension. |
void |
enforceUniquePackageName(boolean value) |
void |
flavorDimensions(java.lang.String... dimensions) Specifies names of flavor dimensions. |
void |
generatePureSplits(boolean flag) |
com.android.build.gradle.internal.dsl.AaptOptions |
getAaptOptions() {@inheritDoc} |
java.io.File |
getAdbExe() |
com.android.build.gradle.internal.dsl.AdbOptions |
getAdbOptions() {@inheritDoc} |
java.util.Collection<java.lang.String> |
getAidlPackageWhiteList() |
java.util.List<java.io.File> |
getBootClasspath() |
com.android.repository.Revision |
getBuildToolsRevision() |
java.lang.String |
getBuildToolsVersion() Required. |
java.util.Collection<com.android.build.gradle.internal.dsl.BuildType> |
getBuildTypes() {@inheritDoc} |
com.android.build.gradle.internal.CompileOptions |
getCompileOptions() {@inheritDoc} |
java.lang.String |
getCompileSdkVersion() Required. |
com.android.build.gradle.internal.dsl.DataBindingOptions |
getDataBinding() {@inheritDoc} |
com.android.build.gradle.internal.dsl.ProductFlavor |
getDefaultConfig() {@inheritDoc} |
java.io.File |
getDefaultProguardFile(java.lang.String name) |
java.lang.String |
getDefaultPublishConfig() Name of the configuration used to build the default artifact of this project. |
java.util.List<com.android.builder.testing.api.DeviceProvider> |
getDeviceProviders() |
com.android.build.gradle.internal.dsl.DexOptions |
getDexOptions() {@inheritDoc} |
boolean |
getEnforceUniquePackageName() |
java.util.List<java.lang.String> |
getFlavorDimensionList() Returns the names of flavor dimensions. |
boolean |
getGeneratePureSplits() {@inheritDoc} |
com.android.build.gradle.internal.coverage.JacocoOptions |
getJacoco() {@inheritDoc} |
java.util.Collection<com.android.builder.core.LibraryRequest> |
getLibraryRequests() |
com.android.build.gradle.internal.dsl.LintOptions |
getLintOptions() {@inheritDoc} |
java.io.File |
getNdkDirectory() ReturnS the NDK directory used. |
java.lang.Boolean |
getPackageBuildConfig() |
com.android.build.gradle.internal.dsl.PackagingOptions |
getPackagingOptions() {@inheritDoc} |
java.util.Collection<com.android.build.gradle.internal.dsl.ProductFlavor> |
getProductFlavors() {@inheritDoc} |
boolean |
getPublishNonDefault() Whether to publish artifacts for all configurations, not just the default one. |
java.lang.String |
getResourcePrefix() {@inheritDoc} |
java.io.File |
getSdkDirectory() Returns the SDK directory used. |
java.util.Collection<com.android.build.gradle.internal.dsl.SigningConfig> |
getSigningConfigs() {@inheritDoc} |
org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.api.AndroidSourceSet> |
getSourceSets() All source sets. |
com.android.build.gradle.internal.dsl.Splits |
getSplits() {@inheritDoc} |
com.android.build.gradle.internal.dsl.TestOptions |
getTestOptions() {@inheritDoc} |
java.util.List<com.android.builder.testing.api.TestServer> |
getTestServers() |
java.util.List<com.android.build.api.transform.Transform> |
getTransforms() |
java.util.List<java.util.List<java.lang.Object>> |
getTransformsDependencies() |
org.gradle.api.Action<com.android.build.gradle.api.VariantFilter> |
getVariantFilter() Callback to control which variants should be excluded. |
void |
jacoco(org.gradle.api.Action<com.android.build.gradle.internal.coverage.JacocoOptions> action) Configures JaCoCo options. |
void |
lintOptions(org.gradle.api.Action<com.android.build.gradle.internal.dsl.LintOptions> action) Configures lint options. |
void |
packagingOptions(org.gradle.api.Action<com.android.build.gradle.internal.dsl.PackagingOptions> action) Configures packaging options. |
void |
productFlavors(org.gradle.api.Action<? super org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.ProductFlavor>> action) Configures product flavors. |
void |
publishNonDefault(boolean value) |
void |
registerArtifactType(java.lang.String name, boolean isTest, int artifactType) |
void |
registerBuildTypeSourceProvider(java.lang.String name, com.android.build.gradle.internal.dsl.BuildType buildType, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerJavaArtifact(java.lang.String name, com.android.build.gradle.api.BaseVariant variant, java.lang.String assembleTaskName, java.lang.String javaCompileTaskName, java.util.Collection<java.io.File> generatedSourceFolders, java.lang.Iterable<java.lang.String> ideSetupTaskNames, org.gradle.api.artifacts.Configuration configuration, java.io.File classesFolder, java.io.File javaResourceFolder, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerMultiFlavorSourceProvider(java.lang.String name, java.lang.String flavorName, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerProductFlavorSourceProvider(java.lang.String name, com.android.build.gradle.internal.dsl.ProductFlavor productFlavor, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerTransform(com.android.build.api.transform.Transform transform, java.lang.Object... dependencies) |
void |
resourcePrefix(java.lang.String prefix) |
void |
setBuildToolsVersion(java.lang.String version) |
void |
setCompileSdkVersion(int apiLevel) |
void |
setCompileSdkVersion(java.lang.String target) |
void |
setDefaultPublishConfig(java.lang.String value) |
void |
setEnforceUniquePackageName(boolean value) |
void |
setGeneratePureSplits(boolean flag) |
void |
setVariantFilter(org.gradle.api.Action<com.android.build.gradle.api.VariantFilter> filter) |
void |
signingConfigs(org.gradle.api.Action<? super org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.SigningConfig>> action) Configures signing configs. |
void |
sourceSets(org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.api.AndroidSourceSet>> action) Configures source sets. |
void |
splits(org.gradle.api.Action<com.android.build.gradle.internal.dsl.Splits> action) Configures APK splits. |
void |
testOptions(org.gradle.api.Action<com.android.build.gradle.internal.dsl.TestOptions> action) Configures test options. |
void |
testServer(com.android.builder.testing.api.TestServer testServer) |
void |
useLibrary(java.lang.String name) Request the use a of Library. |
void |
useLibrary(java.lang.String name, boolean required) Request the use a of Library. |
void |
variantFilter(org.gradle.api.Action<com.android.build.gradle.api.VariantFilter> filter) |
com.android.builder.model.SourceProvider |
wrapJavaSourceSet(org.gradle.api.tasks.SourceSet sourceSet) |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Configures aapt options.
Configures adb options.
Configures build types.
Configures compile options.
Sets the compile SDK version, based on full SDK version string, e.g.
android-21
for Lollipop.
Sets the compile SDK version, based on API level, e.g. 21 for Lollipop.
Configures data binding options.
The default configuration, inherited by all product flavors (if any are defined).
Configures dex options.
Disallow further modification on the extension.
Specifies names of flavor dimensions.
{@inheritDoc}
{@inheritDoc}
Required. Version of the build tools to use.
Value assigned to this property is parsed and stored in a normalized form, so reading it back may give a slightly different string.
{@inheritDoc}
{@inheritDoc}
Required. Compile SDK version.
Your code will be compiled against the android.jar from this API level. You should generally use the most up-to-date SDK version here. Use the Lint tool to make sure you don't use APIs not available in earlier platform version without checking.
Setter can be called with a string like "android-21" or a number.
Value assigned to this property is parsed and stored in a normalized form, so reading it back may give a slightly different string.
{@inheritDoc}
{@inheritDoc}
Name of the configuration used to build the default artifact of this project.
{@inheritDoc}
Returns the names of flavor dimensions.
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
ReturnS the NDK directory used.
{@inheritDoc}
{@inheritDoc}
Whether to publish artifacts for all configurations, not just the default one.
{@inheritDoc}
Returns the SDK directory used.
{@inheritDoc}
All source sets. Note that the Android plugin uses its own implementation of source sets, com.android.build.gradle.api.AndroidSourceSet.
{@inheritDoc}
{@inheritDoc}
Callback to control which variants should be excluded.
The org.gradle.api.Action is passed a single object of type com.android.build.gradle.api.VariantFilter. It should set the com.android.build.gradle.api.VariantFilter#setIgnore(boolean) flag to filter out the given variant.
Configures JaCoCo options.
Configures lint options.
Configures packaging options.
Configures product flavors.
Configures signing configs.
Configures source sets.
Note that the Android plugin uses its own implementation of source sets, com.android.build.gradle.api.AndroidSourceSet.
Configures APK splits.
Configures test options.
Request the use a of Library. The library is then added to the classpath.
name
- the name of the library.Request the use a of Library. The library is then added to the classpath.
name
- the name of the library.required
- if using the library requires a manifest entry, the entry will
indicate that the library is not required.