Google is committed to advancing racial equity for Black communities. See how.

BuiltArtifactsLoader

@Incubating interface BuiltArtifactsLoader
com.android.build.api.variant.BuiltArtifactsLoader

Facility to load BuiltArtifacts instances from metadata files in the file system.

When an artifact can have more than one output file, its com.android.build.api.artifact.ArtifactType is annotated with com.android.build.api.artifact.ArtifactType.ContainsMany. com.android.build.api.artifact.ArtifactTypes.APK is an example of such an artifact: the folder produced can contain multiple APK files when multi-apk build is configured.

To be able to understand the content of such a folder, and in particular to know which file is associated with which VariantFilter, a metadata file is stored along side the artifact files.

BuiltArtifactsLoader will allow to load the content of the metadata file is obtained information about each file produced by AGP.

This interface should not be implemented by third party.

Implementation of this interface can be obtained from com.android.build.api.artifact.Artifacts.getBuiltArtifactsLoader

Summary

Public methods

abstract BuiltArtifacts?
load(folder: Directory)

Loads a metadata file from the provided folder and returns a new BuiltArtifacts containing the Collection of BuiltArtifact that are present in the folder

abstract BuiltArtifacts?
load(fileCollection: FileCollection)

Loads a metadata file from the provided FileCollection and returns a new BuiltArtifacts containing the Collection of BuiltArtifact that are present in the FileCollection

Public methods

load

abstract fun load(folder: Directory): BuiltArtifacts?

Loads a metadata file from the provided folder and returns a new BuiltArtifacts containing the Collection of BuiltArtifact that are present in the folder

Parameters
folder: Directory the directory abstraction that should contain built artifacts and associated metadata file saved using the BuiltArtifacts.save methods.

load

abstract fun load(fileCollection: FileCollection): BuiltArtifacts?

Loads a metadata file from the provided FileCollection and returns a new BuiltArtifacts containing the Collection of BuiltArtifact that are present in the FileCollection

Parameters
fileCollection: FileCollection the file collection that should contain built artifacts and associated metadata file saved using the BuiltArtifacts.save methods.