com.android.build.gradle.api

Interface BaseVariant

All Known Subinterfaces:

ApkVariant, ApplicationVariant, FeatureVariant, LibraryVariant, TestVariant, UnitTestVariant

public interface BaseVariant

A Build variant and all its public data. This is the base class for items common to apps, test apps, and libraries

Method Summary

Modifier and Type	Method and Description
void	addJavaSourceFoldersToModel(java.util.Collection<java.io.File> sourceFolders) Adds new Java source folders to the model.
void	addJavaSourceFoldersToModel(java.io.File... sourceFolders) Adds new Java source folders to the model.
void	buildConfigField(java.lang.String type, java.lang.String name, java.lang.String value) Adds a variant-specific BuildConfig field.
AidlCompile	getAidlCompile() Returns the AIDL compilation task.
org.gradle.api.artifacts.Configuration	getAnnotationProcessorConfiguration() Returns the configuration object for the annotation processor.
java.lang.String	getApplicationId() Returns the applicationId of the variant.
org.gradle.api.Task	getAssemble() Returns the assemble task for all this variant's output
java.lang.String	getBaseName() Returns the base name for the output of the variant.
com.android.builder.model.BuildType	getBuildType() Returns the DefaultBuildType for this build variant.
org.gradle.api.Task	getCheckManifest() Returns the check manifest task.
org.gradle.api.file.FileCollection	getCompileClasspath(java.lang.Object key) Returns the java compilation classpath.
org.gradle.api.artifacts.ArtifactCollection	getCompileClasspathArtifacts(java.lang.Object key) Returns the java compilation classpath as an ArtifactCollection
org.gradle.api.artifacts.Configuration	getCompileConfiguration() Returns the configuration object for the compilation
java.lang.String	getDescription() Returns a description for the build variant.
java.lang.String	getDirName() Returns a subfolder name for the variant.
java.util.Collection<ExternalNativeBuildTask>	getExternalNativeBuildTasks() Returns the tasks for building external native projects.
java.lang.String	getFlavorName() Returns the flavor name of the variant.
GenerateBuildConfig	getGenerateBuildConfig() Returns the BuildConfig generation task.
org.gradle.api.tasks.compile.JavaCompile	getJavaCompile() Deprecated. prefer getJavaCompiler() which always return the java compiler task irrespective of which tool chain (javac or jack) used.
JavaCompileOptions	getJavaCompileOptions() Returns a JavaCompileOptions that represents the java compile settings for this build variant.
org.gradle.api.Task	getJavaCompiler() Returns the Java Compiler task which can be either javac or jack depending on the project configuration.
java.io.File	getMappingFile() Returns the obfuscation mapping file.
MergeSourceSetFolders	getMergeAssets() Returns the asset merging task.
com.android.builder.model.ProductFlavor	getMergedFlavor() Returns a DefaultProductFlavor that represents the merging of the default config and the flavors of this build variant.
MergeResources	getMergeResources() Returns the resource merging task.
java.lang.String	getName() Returns the name of the variant.
NdkCompile	getNdkCompile() Returns the NDK Compilation task.
org.gradle.api.Task	getObfuscation() Returns the obfuscation task.
org.gradle.api.DomainObjectCollection<BaseVariantOutput>	getOutputs() Returns the variant outputs.
boolean	getOutputsAreSigned()
org.gradle.api.Task	getPreBuild() Returns the pre-build anchor task
org.gradle.api.tasks.AbstractCopyTask	getProcessJavaResources() Returns the Java resource processing task.
java.util.List<com.android.builder.model.ProductFlavor>	getProductFlavors() Returns the list of DefaultProductFlavor for this build variant.
RenderscriptCompile	getRenderscriptCompile() Returns the Renderscript compilation task.
org.gradle.api.artifacts.Configuration	getRuntimeConfiguration() Returns the configuration object for the runtime
java.util.List<org.gradle.api.file.ConfigurableFileTree>	getSourceFolders(SourceKind folderType) Returns a list of FileCollection representing the source folders.
java.util.List<com.android.builder.model.SourceProvider>	getSourceSets() Returns a list of sorted SourceProvider in order of ascending order, meaning, the earlier items are meant to be overridden by later items.
void	missingDimensionStrategy(java.lang.String dimension, java.util.List<java.lang.String> requestedValues) Set up a new matching request for a given flavor dimension and value.
void	missingDimensionStrategy(java.lang.String dimension, java.lang.String... requestedValues) Set up a new matching request for a given flavor dimension and value.
void	missingDimensionStrategy(java.lang.String dimension, java.lang.String requestedValue) Set up a new matching request for a given flavor dimension and value.
void	register(org.gradle.api.Task task) Registers a task to be executed before any main output tasks like the assemble or bundle tasks are invoked.
void	registerExternalAptJavaOutput(org.gradle.api.file.ConfigurableFileTree folder) Register the output of an external annotation processor.
java.lang.Object	registerGeneratedBytecode(org.gradle.api.file.FileCollection fileCollection) Deprecated. use registerPreJavacGeneratedBytecode(FileCollection)
void	registerGeneratedResFolders(org.gradle.api.file.FileCollection folders) Adds to the variant new generated resource folders.
void	registerJavaGeneratingTask(org.gradle.api.Task task, java.util.Collection<java.io.File> sourceFolders) Adds to the variant a task that generates Java source code.
void	registerJavaGeneratingTask(org.gradle.api.Task task, java.io.File... sourceFolders) Adds to the variant a task that generates Java source code.
void	registerPostJavacGeneratedBytecode(org.gradle.api.file.FileCollection fileCollection) Adds to the variant new generated Java byte-code.
java.lang.Object	registerPreJavacGeneratedBytecode(org.gradle.api.file.FileCollection fileCollection) Adds to the variant new generated Java byte-code.
void	registerResGeneratingTask(org.gradle.api.Task task, java.util.Collection<java.io.File> resFolders) Deprecated. Use registerGeneratedResFolders(FileCollection)
void	registerResGeneratingTask(org.gradle.api.Task task, java.io.File... resFolders) Deprecated. Use registerGeneratedResFolders(FileCollection)
void	resValue(java.lang.String type, java.lang.String name, java.lang.String value) Adds a variant-specific res value.
void	setOutputsAreSigned(boolean isSigned) If true, variant outputs will be considered signed.

Method Detail

getName

@NonNull
java.lang.String getName()

Returns the name of the variant. Guaranteed to be unique.

getDescription

@NonNull
java.lang.String getDescription()

Returns a description for the build variant.

getDirName

@NonNull
java.lang.String getDirName()

Returns a subfolder name for the variant. Guaranteed to be unique. This is usually a mix of build type and flavor(s) (if applicable). For instance this could be: "debug" "debug/myflavor" "release/Flavor1Flavor2"

getBaseName

@NonNull
java.lang.String getBaseName()

Returns the base name for the output of the variant. Guaranteed to be unique.

getFlavorName

@NonNull
java.lang.String getFlavorName()

Returns the flavor name of the variant. This is a concatenation of all the applied flavors

Returns:

the name of the flavors, or an empty string if there is not flavors.

getOutputs

@NonNull
org.gradle.api.DomainObjectCollection<BaseVariantOutput> getOutputs()

Returns the variant outputs. There should always be at least one output.

Returns:

a non-null list of variants.

getBuildType

@NonNull
com.android.builder.model.BuildType getBuildType()

Returns the DefaultBuildType for this build variant.

getMergedFlavor

@NonNull
com.android.builder.model.ProductFlavor getMergedFlavor()

Returns a DefaultProductFlavor that represents the merging of the default config and the flavors of this build variant.

getJavaCompileOptions

@NonNull
JavaCompileOptions getJavaCompileOptions()

Returns a JavaCompileOptions that represents the java compile settings for this build variant.

getProductFlavors

@NonNull
java.util.List<com.android.builder.model.ProductFlavor> getProductFlavors()

Returns the list of DefaultProductFlavor for this build variant.

This is always non-null but could be empty.

getSourceSets

@NonNull
java.util.List<com.android.builder.model.SourceProvider> getSourceSets()

Returns a list of sorted SourceProvider in order of ascending order, meaning, the earlier items are meant to be overridden by later items.

Returns:

a list of source provider

getSourceFolders

@NonNull
java.util.List<org.gradle.api.file.ConfigurableFileTree> getSourceFolders(@NonNull
                                                                                   SourceKind folderType)

Returns a list of FileCollection representing the source folders.

Parameters:

folderType - the type of folder to return.

Returns:

a list of folder + dependency as file collections.

getCompileConfiguration

@NonNull
org.gradle.api.artifacts.Configuration getCompileConfiguration()

Returns the configuration object for the compilation

getAnnotationProcessorConfiguration

@NonNull
org.gradle.api.artifacts.Configuration getAnnotationProcessorConfiguration()

Returns the configuration object for the annotation processor.

getRuntimeConfiguration

@NonNull
org.gradle.api.artifacts.Configuration getRuntimeConfiguration()

Returns the configuration object for the runtime

getApplicationId

@NonNull
java.lang.String getApplicationId()

Returns the applicationId of the variant.

getPreBuild

@NonNull
org.gradle.api.Task getPreBuild()

Returns the pre-build anchor task

getCheckManifest

@NonNull
org.gradle.api.Task getCheckManifest()

Returns the check manifest task.

getAidlCompile

@NonNull
AidlCompile getAidlCompile()

Returns the AIDL compilation task.

getRenderscriptCompile

@NonNull
RenderscriptCompile getRenderscriptCompile()

Returns the Renderscript compilation task.

getMergeResources

@Nullable
MergeResources getMergeResources()

Returns the resource merging task.

getMergeAssets

@Nullable
MergeSourceSetFolders getMergeAssets()

Returns the asset merging task.

getGenerateBuildConfig

@Nullable
GenerateBuildConfig getGenerateBuildConfig()

Returns the BuildConfig generation task.

getJavaCompile

@Nullable
 @Deprecated
org.gradle.api.tasks.compile.JavaCompile getJavaCompile()
                                                                        throws java.lang.IllegalStateException

Deprecated. prefer getJavaCompiler() which always return the java compiler task irrespective of which tool chain (javac or jack) used.

Returns the Java Compilation task if javac was configured to compile the source files.

Throws:

java.lang.IllegalStateException

getJavaCompiler

@NonNull
org.gradle.api.Task getJavaCompiler()

Returns the Java Compiler task which can be either javac or jack depending on the project configuration.

getCompileClasspath

@NonNull
org.gradle.api.file.FileCollection getCompileClasspath(@Nullable
                                                                java.lang.Object key)

Returns the java compilation classpath.

The provided key allows controlling how much of the classpath is returned.

• if null, the full classpath is returned
• Otherwise the method returns the classpath up to the generated bytecode associated with the key

Parameters:

key - the key

See Also:

registerGeneratedBytecode(FileCollection)

getCompileClasspathArtifacts

@NonNull
org.gradle.api.artifacts.ArtifactCollection getCompileClasspathArtifacts(@Nullable
                                                                                  java.lang.Object key)

Returns the java compilation classpath as an ArtifactCollection

The provided key allows controlling how much of the classpath is returned.

• if null, the full classpath is returned
• Otherwise the method returns the classpath up to the generated bytecode associated with the key

Parameters:

key - the key

See Also:

registerGeneratedBytecode(FileCollection)

getNdkCompile

@NonNull
NdkCompile getNdkCompile()

Returns the NDK Compilation task.

getExternalNativeBuildTasks

java.util.Collection<ExternalNativeBuildTask> getExternalNativeBuildTasks()

Returns the tasks for building external native projects.

getObfuscation

@Nullable
org.gradle.api.Task getObfuscation()

Returns the obfuscation task. This can be null if obfuscation is not enabled.

getMappingFile

@Nullable
java.io.File getMappingFile()

Returns the obfuscation mapping file. This can be null if obfuscation is not enabled.

getProcessJavaResources

@NonNull
org.gradle.api.tasks.AbstractCopyTask getProcessJavaResources()

Returns the Java resource processing task.

getAssemble

@Nullable
org.gradle.api.Task getAssemble()

Returns the assemble task for all this variant's output

addJavaSourceFoldersToModel

void addJavaSourceFoldersToModel(@NonNull
                                 java.io.File... sourceFolders)

Adds new Java source folders to the model. These source folders will not be used for the default build system, but will be passed along the default Java source folders to whoever queries the model.

Parameters:

sourceFolders - the source folders where the generated source code is.

addJavaSourceFoldersToModel

void addJavaSourceFoldersToModel(@NonNull
                                 java.util.Collection<java.io.File> sourceFolders)

Adds new Java source folders to the model. These source folders will not be used for the default build system, but will be passed along the default Java source folders to whoever queries the model.

Parameters:

sourceFolders - the source folders where the generated source code is.

registerJavaGeneratingTask

void registerJavaGeneratingTask(@NonNull
                                org.gradle.api.Task task,
                                @NonNull
                                java.io.File... sourceFolders)

Adds to the variant a task that generates Java source code. This will make the generate[Variant]Sources task depend on this task and add the new source folders as compilation inputs. The new source folders are also added to the model.

Parameters:

task - the task

sourceFolders - the source folders where the generated source code is.

registerJavaGeneratingTask

void registerJavaGeneratingTask(@NonNull
                                org.gradle.api.Task task,
                                @NonNull
                                java.util.Collection<java.io.File> sourceFolders)

Adds to the variant a task that generates Java source code. This will make the generate[Variant]Sources task depend on this task and add the new source folders as compilation inputs. The new source folders are also added to the model.

Parameters:

task - the task

sourceFolders - the source folders where the generated source code is.

registerExternalAptJavaOutput

void registerExternalAptJavaOutput(@NonNull
                                   org.gradle.api.file.ConfigurableFileTree folder)

Register the output of an external annotation processor.

The output is passed to the javac task, but the source generation hooks does not depend on this.

In order to properly wire up tasks, the FileTree object must include dependency information about the task that generates the content of this folders.

Parameters:

folder - a ConfigurableFileTree that contains a single folder and the task dependency information

registerGeneratedResFolders

void registerGeneratedResFolders(@NonNull
                                 org.gradle.api.file.FileCollection folders)

Adds to the variant new generated resource folders.

In order to properly wire up tasks, the FileCollection object must include dependency information about the task that generates the content of this folders.

Parameters:

folders - a FileCollection that contains the folders and the task dependency information

registerResGeneratingTask

@Deprecated
void registerResGeneratingTask(@NonNull
                                           org.gradle.api.Task task,
                                           @NonNull
                                           java.io.File... resFolders)

Deprecated. Use registerGeneratedResFolders(FileCollection)

Adds to the variant a task that generates Resources. This will make the generate[Variant]Resources task depend on this task and add the new Resource folders as Resource merge inputs. The Resource folders are also added to the model.

Parameters:

task - the task

resFolders - the folders where the generated resources are.

registerResGeneratingTask

@Deprecated
void registerResGeneratingTask(@NonNull
                                           org.gradle.api.Task task,
                                           @NonNull
                                           java.util.Collection<java.io.File> resFolders)

Deprecated. Use registerGeneratedResFolders(FileCollection)

Adds to the variant a task that generates Resources. This will make the generate[Variant]Resources task depend on this task and add the new Resource folders as Resource merge inputs. The Resource folders are also added to the model.

Parameters:

task - the task

resFolders - the folders where the generated resources are.

registerPreJavacGeneratedBytecode

java.lang.Object registerPreJavacGeneratedBytecode(@NonNull
                                                   org.gradle.api.file.FileCollection fileCollection)

Adds to the variant new generated Java byte-code.

This bytecode is passed to the javac classpath. This is typically used by compilers for languages that generate bytecode ahead of javac.

The file collection can contain either a folder of class files or jars.

In order to properly wire up tasks, the FileCollection object must include dependency information about the task that generates the content of these folders. This is generally setup using ConfigurableFileCollection.builtBy(Object...)

The generated byte-code will also be added to the transform pipeline as a QualifiedContent.Scope.PROJECT stream.

The method returns a key that can be used to query for the compilation classpath. This allows each successive call to registerPreJavacGeneratedBytecode(FileCollection) to be associated with a classpath containing everything before the added bytecode.

Parameters:

fileCollection - a FileCollection that contains the files and the task dependency information

Returns:

a key for calls to registerGeneratedBytecode(FileCollection)

registerGeneratedBytecode

@Deprecated
java.lang.Object registerGeneratedBytecode(@NonNull
                                                       org.gradle.api.file.FileCollection fileCollection)

Deprecated. use registerPreJavacGeneratedBytecode(FileCollection)

registerPostJavacGeneratedBytecode

void registerPostJavacGeneratedBytecode(@NonNull
                                        org.gradle.api.file.FileCollection fileCollection)

Adds to the variant new generated Java byte-code.

This bytecode is meant to be post javac, which means javac does not have it on its classpath. It's is only added to the java compilation task's classpath and will be added to the transform pipeline as a QualifiedContent.Scope.PROJECT stream.

The file collection can contain either a folder of class files or jars.

In order to properly wire up tasks, the FileCollection object must include dependency information about the task that generates the content of these folders. This is generally setup using ConfigurableFileCollection.builtBy(Object...)

Parameters:

fileCollection - a FileCollection that contains the files and the task dependency information

buildConfigField

void buildConfigField(@NonNull
                      java.lang.String type,
                      @NonNull
                      java.lang.String name,
                      @NonNull
                      java.lang.String value)

Adds a variant-specific BuildConfig field.

Parameters:

type - the type of the field

name - the name of the field

value - the value of the field

resValue

void resValue(@NonNull
              java.lang.String type,
              @NonNull
              java.lang.String name,
              @NonNull
              java.lang.String value)

Adds a variant-specific res value.

Parameters:

type - the type of the field

name - the name of the field

value - the value of the field

missingDimensionStrategy

void missingDimensionStrategy(@NonNull
                              java.lang.String dimension,
                              @NonNull
                              java.lang.String requestedValue)

Set up a new matching request for a given flavor dimension and value.

To learn more, read Select default flavors for missing dimensions.

Parameters:

dimension - the flavor dimension

requestedValue - the flavor name

missingDimensionStrategy

void missingDimensionStrategy(@NonNull
                              java.lang.String dimension,
                              @NonNull
                              java.lang.String... requestedValues)

Set up a new matching request for a given flavor dimension and value.

To learn more, read Select default flavors for missing dimensions.

Parameters:

dimension - the flavor dimension

requestedValues - the flavor name and fallbacks

missingDimensionStrategy

void missingDimensionStrategy(@NonNull
                              java.lang.String dimension,
                              @NonNull
                              java.util.List<java.lang.String> requestedValues)

Set up a new matching request for a given flavor dimension and value.

To learn more, read Select default flavors for missing dimensions.

Parameters:

dimension - the flavor dimension

requestedValues - the flavor name and fallbacks

setOutputsAreSigned

void setOutputsAreSigned(boolean isSigned)

If true, variant outputs will be considered signed. Only set if you manually set the outputs to point to signed files built by other tasks.

getOutputsAreSigned

boolean getOutputsAreSigned()

See Also:

setOutputsAreSigned(boolean)

register

@Incubating
void register(org.gradle.api.Task task)

Registers a task to be executed before any main output tasks like the assemble or bundle tasks are invoked.

The task will need to set up its dependencies on the build outputs (whether it is an intermediate output or the final one) independently of this call.