com.android.build.api.transform

Interface TransformOutputProvider

public interface TransformOutputProvider

The output of a transform.

There is no direct access to a location to write. Instead, Transforms can ask to get the location for given scopes, content-types and a format.

Method Summary

Modifier and Type	Method and Description
void	deleteAll() Delete all content.
java.io.File	getContentLocation(java.lang.String name, java.util.Set<QualifiedContent.ContentType> types, java.util.Set<? super QualifiedContent.Scope> scopes, Format format) Returns the location of content for a given set of Scopes, Content Types, and Format.

Method Detail

deleteAll

void deleteAll()
        throws java.io.IOException

Delete all content. This is useful when running in non-incremental mode

Throws:

java.io.IOException - if deleting the output failed.

getContentLocation

@NonNull
java.io.File getContentLocation(@NonNull
                                         java.lang.String name,
                                         @NonNull
                                         java.util.Set<QualifiedContent.ContentType> types,
                                         @NonNull
                                         java.util.Set<? super QualifiedContent.Scope> scopes,
                                         @NonNull
                                         Format format)

Returns the location of content for a given set of Scopes, Content Types, and Format.

If the format is Format.DIRECTORY then the result is the file location of the directory.
If the format is Format.JAR then the result is a file representing the jar to create.

Non of the directories or files are created by querying this method, and there is no checks regarding the existence of content in this location.

In case of incremental processing of removed files, it is safe to query the method to get the location of the files to removed.

Parameters:

name - a unique name for the content. For a given set of scopes/types/format it must be unique.

types - the content types associated with this content.

scopes - the scopes associated with this content.

format - the format of the content.

Returns:

the location of the content.