com.android.builder.model
Interface BaseArtifact

All Known Subinterfaces:

AndroidArtifact, JavaArtifact

public interface BaseArtifact

The base information for all generated artifacts

Method Summary

java.lang.String	getAssembleTaskName() Returns the name of the task used to generate the artifact output(s).
java.io.File	getClassesFolder() Returns the folder containing the class files.
java.lang.String	getCompileTaskName()
Dependencies	getDependencies() Returns the resolved dependencies for this artifact.
java.util.Collection<java.io.File>	getGeneratedSourceFolders() Returns all the source folders that are generated.
java.util.Set<java.lang.String>	getIdeSetupTaskNames() Returns names of tasks that need to be run when setting up the IDE project.
java.io.File	getJavaResourcesFolder() Returns the folder containing resource files that classes form this artifact expect to find on the classpath.
SourceProvider	getMultiFlavorSourceProvider() A SourceProvider specific to the flavor combination.
java.lang.String	getName() Name of the artifact.
SourceProvider	getVariantSourceProvider() A SourceProvider specific to the variant.

Method Detail

getName

@NonNull
java.lang.String getName()

Name of the artifact. This should match ArtifactMetaData.getName().

getCompileTaskName

@NonNull
java.lang.String getCompileTaskName()

Returns:

the name of the task used to compile the code.

getAssembleTaskName

@NonNull
java.lang.String getAssembleTaskName()

Returns the name of the task used to generate the artifact output(s).

Returns:

the name of the task.

getClassesFolder

@NonNull
java.io.File getClassesFolder()

Returns the folder containing the class files. This is the output of the java compilation.

Returns:

a folder.

getJavaResourcesFolder

@NonNull
java.io.File getJavaResourcesFolder()

Returns the folder containing resource files that classes form this artifact expect to find on the classpath.

getDependencies

@NonNull
Dependencies getDependencies()

Returns the resolved dependencies for this artifact. This is a composite of all the dependencies for that artifact: default config + build type + flavor(s).s

Returns:

The dependencies.

getVariantSourceProvider

@Nullable
SourceProvider getVariantSourceProvider()

A SourceProvider specific to the variant. This can be null if there is no flavors as the "variant" is equal to the build type.

Returns:

the variant specific source provider

getMultiFlavorSourceProvider

@Nullable
SourceProvider getMultiFlavorSourceProvider()

A SourceProvider specific to the flavor combination. For instance if there are 2 dimensions, then this would be Flavor1Flavor2, and would be common to all variant using these two flavors and any of the build type. This can be null if there is less than 2 flavors.

Returns:

the multi flavor specific source provider

getIdeSetupTaskNames

@NonNull
java.util.Set<java.lang.String> getIdeSetupTaskNames()

Returns names of tasks that need to be run when setting up the IDE project. After these tasks have run, all the generated source files etc. that the IDE needs to know about should be in place.

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.

Returns:

a list of folders.

Since:

1.2