BaseVariant (Gradle API 1.0.0)

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

Methods Summary

Methods
Type	Name and description
`void`	`addJavaSourceFoldersToModel(File... sourceFolders)` Adds new Java source folders to the model.
`void`	`addJavaSourceFoldersToModel(Collection<File> sourceFolders)` Adds new Java source folders to the model.
`void`	`buildConfigField(String type, String name, String value)` Adds a variant-specific BuildConfig field.
`AidlCompile`	`getAidlCompile()` Returns the AIDL compilation task.
`String`	`getApplicationId()` Returns the applicationId of the variant.
`org.gradle.api.Task`	`getAssemble()` Returns the assemble task for all this variant's output
`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.
`String`	`getDescription()` Returns a description for the build variant.
`String`	`getDirName()` Returns a subfolder name for the variant.
`String`	`getFlavorName()` Returns the flavor name of the variant.
`GenerateBuildConfig`	`getGenerateBuildConfig()` Returns the BuildConfig generation task.
`org.gradle.api.tasks.compile.JavaCompile`	`getJavaCompile()` Returns the Java Compilation task.
`File`	`getMappingFile()` Returns the obfuscation mapping file.
`MergeAssets`	`getMergeAssets()` Returns the asset merging task.
`MergeResources`	`getMergeResources()` Returns the resource 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.
`String`	`getName()` Returns the name of the variant.
`NdkCompile`	`getNdkCompile()` Returns the NDK Compilation task.
`org.gradle.api.Task`	`getObfuscation()` Returns the obfuscation task.
`List<BaseVariantOutput>`	`getOutputs()` Returns the variant outputs.
`boolean`	`getOutputsAreSigned()` @see #setOutputsAreSigned(boolean)
`org.gradle.api.Task`	`getPreBuild()` Returns the pre-build anchor task
`org.gradle.api.tasks.Copy`	`getProcessJavaResources()` Returns the Java resource processing task.
`List<GroupableProductFlavor>`	`getProductFlavors()` Returns the list of DefaultProductFlavor for this build variant.
`RenderscriptCompile`	`getRenderscriptCompile()` Returns the Renderscript compilation task.
`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`	`registerJavaGeneratingTask(org.gradle.api.Task task, File... sourceFolders)` Adds to the variant a task that generates Java source code.
`void`	`registerJavaGeneratingTask(org.gradle.api.Task task, Collection<File> sourceFolders)` Adds to the variant a task that generates Java source code.
`void`	`resValue(String type, String name, String value)` Adds a variant-specific res value.
`void`	`setOutputsAreSigned(boolean isSigned)` If true, variant outputs will be considered signed.

- Method Detail
  - public void addJavaSourceFoldersToModel(@com.android.annotations.NonNull 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.
  - public void addJavaSourceFoldersToModel(@com.android.annotations.NonNull Collection<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.
  - public void buildConfigField(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull 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
  - @com.android.annotations.NonNull public AidlCompile getAidlCompile()
    
    Returns the AIDL compilation task.
  - @com.android.annotations.NonNull public String getApplicationId()
    
    Returns the applicationId of the variant.
  - @com.android.annotations.Nullable public org.gradle.api.Task getAssemble()
    
    Returns the assemble task for all this variant's output
  - @com.android.annotations.NonNull public String getBaseName()
    
    Returns the base name for the output of the variant. Guaranteed to be unique.
  - @com.android.annotations.NonNull public com.android.builder.model.BuildType getBuildType()
    
    Returns the DefaultBuildType for this build variant.
  - @com.android.annotations.NonNull public org.gradle.api.Task getCheckManifest()
    
    Returns the check manifest task.
  - @com.android.annotations.NonNull public String getDescription()
    
    Returns a description for the build variant.
  - @com.android.annotations.NonNull public 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"
  - @com.android.annotations.NonNull public 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.
  - @com.android.annotations.Nullable public GenerateBuildConfig getGenerateBuildConfig()
    
    Returns the BuildConfig generation task.
  - @com.android.annotations.NonNull public org.gradle.api.tasks.compile.JavaCompile getJavaCompile()
    
    Returns the Java Compilation task.
  - @com.android.annotations.Nullable public File getMappingFile()
    
    Returns the obfuscation mapping file. This can be null if obfuscation is not enabled.
  - @com.android.annotations.Nullable public MergeAssets getMergeAssets()
    
    Returns the asset merging task.
  - @com.android.annotations.Nullable public MergeResources getMergeResources()
    
    Returns the resource merging task.
  - @com.android.annotations.NonNull public com.android.builder.model.ProductFlavor getMergedFlavor()
    
    Returns a DefaultProductFlavor that represents the merging of the default config and the flavors of this build variant.
  - @com.android.annotations.NonNull public String getName()
    
    Returns the name of the variant. Guaranteed to be unique.
  - @com.android.annotations.NonNull public NdkCompile getNdkCompile()
    
    Returns the NDK Compilation task.
  - @com.android.annotations.Nullable public org.gradle.api.Task getObfuscation()
    
    Returns the obfuscation task. This can be null if obfuscation is not enabled.
  - @com.android.annotations.NonNull public List<BaseVariantOutput> getOutputs()
    
    Returns the variant outputs. There should always be at least one output.
    Returns:
    a non-null list of variants.
  - public boolean getOutputsAreSigned()
    
    See Also:
    setOutputsAreSigned(boolean)
  - @com.android.annotations.NonNull public org.gradle.api.Task getPreBuild()
    
    Returns the pre-build anchor task
  - @com.android.annotations.NonNull public org.gradle.api.tasks.Copy getProcessJavaResources()
    
    Returns the Java resource processing task.
  - @com.android.annotations.NonNull public List<GroupableProductFlavor> getProductFlavors()
    
    Returns the list of DefaultProductFlavor for this build variant. This is always non-null but could be empty.
  - @com.android.annotations.NonNull public RenderscriptCompile getRenderscriptCompile()
    
    Returns the Renderscript compilation task.
  - @com.android.annotations.NonNull public 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
  - public void registerJavaGeneratingTask(@com.android.annotations.NonNull org.gradle.api.Task task, @com.android.annotations.NonNull 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.
  - public void registerJavaGeneratingTask(@com.android.annotations.NonNull org.gradle.api.Task task, @com.android.annotations.NonNull Collection<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.
  - public void resValue(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull 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
  - public 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.

Summary:
Method

| Detail:
Method

Gradle API 1.0.0

[Java] Interface BaseVariant

Methods Summary

Method Detail

public void addJavaSourceFoldersToModel(@com.android.annotations.NonNull File... sourceFolders)

public void addJavaSourceFoldersToModel(@com.android.annotations.NonNull Collection<File> sourceFolders)

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

@com.android.annotations.NonNull public AidlCompile getAidlCompile()

@com.android.annotations.NonNull public String getApplicationId()

@com.android.annotations.Nullable public org.gradle.api.Task getAssemble()

@com.android.annotations.NonNull public String getBaseName()

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

@com.android.annotations.NonNull public org.gradle.api.Task getCheckManifest()

@com.android.annotations.NonNull public String getDescription()

@com.android.annotations.NonNull public String getDirName()

@com.android.annotations.NonNull public String getFlavorName()

@com.android.annotations.Nullable public GenerateBuildConfig getGenerateBuildConfig()

@com.android.annotations.NonNull public org.gradle.api.tasks.compile.JavaCompile getJavaCompile()

@com.android.annotations.Nullable public File getMappingFile()

@com.android.annotations.Nullable public MergeAssets getMergeAssets()

@com.android.annotations.Nullable public MergeResources getMergeResources()

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

@com.android.annotations.NonNull public String getName()

@com.android.annotations.NonNull public NdkCompile getNdkCompile()

@com.android.annotations.Nullable public org.gradle.api.Task getObfuscation()

@com.android.annotations.NonNull public List<BaseVariantOutput> getOutputs()

public boolean getOutputsAreSigned()

@com.android.annotations.NonNull public org.gradle.api.Task getPreBuild()

@com.android.annotations.NonNull public org.gradle.api.tasks.Copy getProcessJavaResources()

@com.android.annotations.NonNull public List<GroupableProductFlavor> getProductFlavors()

@com.android.annotations.NonNull public RenderscriptCompile getRenderscriptCompile()

@com.android.annotations.NonNull public List<com.android.builder.model.SourceProvider> getSourceSets()

public void registerJavaGeneratingTask(@com.android.annotations.NonNull org.gradle.api.Task task, @com.android.annotations.NonNull File... sourceFolders)

public void registerJavaGeneratingTask(@com.android.annotations.NonNull org.gradle.api.Task task, @com.android.annotations.NonNull Collection<File> sourceFolders)

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

public void setOutputsAreSigned(boolean isSigned)