com.android.builder.model

Interface AndroidArtifact

All Superinterfaces:

BaseArtifact

public interface AndroidArtifact
extends BaseArtifact

An Android Artifact. This is the entry point for the output of a Variant. This can be more than one output in the case of multi-apk where more than one APKs are generated from the same set of sources.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAbiFilters() Returns the ABI filters associated with the artifact, or null if there are no filters.
java.util.Collection<java.io.File>	getAdditionalRuntimeApks() Returns a list of additional APKs that need to installed on the device for this artifact to work correctly.
java.lang.String	getApkFromBundleTaskName() Returns the name of the task used to generate APKs via the bundle file (.aab), or null if the task is not supported.
java.lang.String	getApplicationId() Returns the application id of this artifact.
java.util.Map<java.lang.String,ClassField>	getBuildConfigFields() Map of Build Config Fields where the key is the field name.
java.lang.String	getBundleTaskName() Returns the name of the task used to generate the bundle file (.aab), or null if the task is not supported.
java.util.Collection<java.io.File>	getGeneratedResourceFolders() Returns all the resource folders that are generated.
java.util.Collection<java.io.File>	getGeneratedSourceFolders() Returns all the source folders that are generated.
InstantRun	getInstantRun() Returns the InstantRun feature related model.
java.lang.String	getInstrumentedTestTaskName() Returns the name of the task used to run instrumented tests or null if the variant is not a test variant.
java.util.Collection<NativeLibrary>	getNativeLibraries() Returns the native libraries associated with the artifact.
java.util.Collection<AndroidArtifactOutput>	getOutputs() Deprecated. Use post-build model instead. See ProjectBuildOutput
java.util.Map<java.lang.String,ClassField>	getResValues() Map of generated res values where the key is the res name.
java.lang.String	getSigningConfigName() Returns the name of the SigningConfig used for the signing.
java.lang.String	getSourceGenTaskName() Returns the name of the task used to generate the source code.
TestOptions	getTestOptions() Returns the test options only if the variant type is testing.
boolean	isSigned() Returns whether the output file is signed.

Methods inherited from interface com.android.builder.model.BaseArtifact

getAdditionalClassesFolders, getAssembleTaskName, getClassesFolder, getCompileDependencies, getCompileTaskName, getDependencies, getDependencyGraphs, getIdeSetupTaskNames, getJavaResourcesFolder, getMultiFlavorSourceProvider, getName, getVariantSourceProvider

Method Detail

getOutputs

@Deprecated
 @NonNull
java.util.Collection<AndroidArtifactOutput> getOutputs()

Deprecated. Use post-build model instead. See ProjectBuildOutput

isSigned

boolean isSigned()

Returns whether the output file is signed. This is always false for the main artifact of a library project.

Returns:

true if the app is signed.

getSigningConfigName

@Nullable
java.lang.String getSigningConfigName()

Returns the name of the SigningConfig used for the signing. If none are setup or if this is the main artifact of a library project, then this is null.

Returns:

the name of the setup signing config.

getApplicationId

@NonNull
java.lang.String getApplicationId()

Returns the application id of this artifact.

Returns:

the application id.

getSourceGenTaskName

@NonNull
java.lang.String getSourceGenTaskName()

Returns the name of the task used to generate the source code. The actual value might depend on the build system front end.

Returns:

the name of the code generating task.

getGeneratedSourceFolders

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

Returns all the source folders that are generated. This is typically folders for the R, the aidl classes, and the renderscript classes. Deprecated, as of 1.2, present in super interface.

Specified by:

getGeneratedSourceFolders in interface BaseArtifact

Returns:

a list of folders.

getGeneratedResourceFolders

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

Returns all the resource folders that are generated. This is typically the renderscript output and the merged resources.

Returns:

a list of folder.

getAbiFilters

@Nullable
java.util.Set<java.lang.String> getAbiFilters()

Returns the ABI filters associated with the artifact, or null if there are no filters. If the list contains values, then the artifact only contains these ABIs and excludes others.

getNativeLibraries

@Nullable
java.util.Collection<NativeLibrary> getNativeLibraries()

Returns the native libraries associated with the artifact.

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).

getInstantRun

@NonNull
InstantRun getInstantRun()

Returns the InstantRun feature related model.

Returns:

the model for all InstantRun related information.

getAdditionalRuntimeApks

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

Returns a list of additional APKs that need to installed on the device for this artifact to work correctly.

For test artifacts, these will be "buddy APKs" from the androidTestUtil configuration.

Since:

3.0

getTestOptions

@Nullable
TestOptions getTestOptions()

Returns the test options only if the variant type is testing.

Since:

3.0

getInstrumentedTestTaskName

@Nullable
java.lang.String getInstrumentedTestTaskName()

Returns the name of the task used to run instrumented tests or null if the variant is not a test variant.

Returns:

name of the task used to run instrumented tests

Since:

3.1

getBundleTaskName

@Nullable
java.lang.String getBundleTaskName()

Returns the name of the task used to generate the bundle file (.aab), or null if the task is not supported.

Returns:

name of the task used to generate the bundle file (.aab)

Since:

3.2

getApkFromBundleTaskName

@Nullable
java.lang.String getApkFromBundleTaskName()

Returns the name of the task used to generate APKs via the bundle file (.aab), or null if the task is not supported.

Returns:

name of the task used to generate the APKs via the bundle

Since:

3.2