Package com.android.builder.model

Interface BaseArtifact

All Known Subinterfaces:
AndroidArtifact, JavaArtifact
public interface BaseArtifact
The base information for all generated artifacts

  • Method Details

    • getName

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

    • getCompileTaskName

      @NonNull String getCompileTaskName()
      Returns:
      the name of the task used to compile the code.

    • getAssembleTaskName

      @NonNull String getAssembleTaskName()
      Returns the name of the task used to generate the artifact output(s).
      Returns:
      the name of the task.

    • getAssembleTaskOutputListingFile

      @NonNull String getAssembleTaskOutputListingFile()
      Returns the absolute path for the listing file that will get updated after each build. The model file will contain deployment related information like applicationId, list of APKs.
      Returns:
      the path to a json file.

    • getClassesFolder

      @NonNull File getClassesFolder()
      Returns the folder containing the class files. This is the output of the java compilation.
      Returns:
      a folder.

    • getAdditionalClassesFolders

      @NonNull Set<File> getAdditionalClassesFolders()
      Folders or jars containing additional classes (e.g., R.jar or those registered by third-party plugins like Kotlin).

    • getJavaResourcesFolder

      @NonNull File getJavaResourcesFolder()
      Returns the folder containing resource files that classes form this artifact expect to find on the classpath.

    • getDependencies

      @NonNull Dependencies getDependencies()
      Return the level 0-1 type dependencies

    • getCompileDependencies

      @Deprecated @NonNull Dependencies getCompileDependencies()
      Deprecated.
      use getDependencies()
      Return the level 0-1 type dependencies.

    • getDependencyGraphs

      @NonNull DependencyGraphs getDependencyGraphs()
      Returns the resolved dependencies for this artifact. This is a composite of all the dependencies for that artifact: default config + build type + flavor(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 Set<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 Collection<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