com.android.builder.core

Class AndroidBuilder

java.lang.Object

com.android.builder.core.AndroidBuilder

public class AndroidBuilder
extends java.lang.Object

This is the main builder class. It is given all the data to process the build (such as DefaultProductFlavors, DefaultBuildType and dependencies) and use them when doing specific build steps. To use: create a builder with AndroidBuilder(String, String, ProcessExecutor, JavaProcessExecutor, ErrorReporter, ILogger, boolean) then build steps can be done with mergeManifestsForApplication(File, List, List, String, int, String, String, String, Integer, String, String, String, ManifestMerger2.MergeType, Map, List, File) mergeManifestsForTestVariant(String, String, String, String, String, Boolean, Boolean, String, File, List, Map, File, File) processResources(Aapt, AaptPackageConfig.Builder, boolean) compileAllAidlFiles(List, File, File, Collection, List, DependencyFileProcessor, ProcessOutputHandler) getDexByteCodeConverter() Java compilation is not handled but the builder provides the boot classpath with getBootClasspath(boolean).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AndroidBuilder.MainDexListOption

Field Summary

Fields

Modifier and Type	Field and Description
static com.android.repository.Revision	MIN_BUILD_TOOLS_REV Minimal supported version of build tools.

Constructor Summary

Constructors

Constructor and Description
AndroidBuilder(java.lang.String projectId, java.lang.String createdBy, com.android.ide.common.process.ProcessExecutor processExecutor, com.android.ide.common.process.JavaProcessExecutor javaProcessExecutor, ErrorReporter errorReporter, com.android.utils.ILogger logger, boolean verboseExec) Creates an AndroidBuilder.

Method Summary

Modifier and Type	Method and Description
void	compileAidlFile(java.io.File sourceFolder, java.io.File aidlFile, java.io.File sourceOutputDir, java.io.File packagedOutputDir, java.util.Collection<java.lang.String> packageWhitelist, java.util.List<java.io.File> importFolders, DependencyFileProcessor dependencyFileProcessor, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Compiles the given aidl file.
void	compileAllAidlFiles(java.util.List<java.io.File> sourceFolders, java.io.File sourceOutputDir, java.io.File packagedOutputDir, java.util.Collection<java.lang.String> packageWhiteList, java.util.List<java.io.File> importFolders, DependencyFileProcessor dependencyFileProcessor, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Compiles all the aidl files found in the given source folders.
void	compileAllRenderscriptFiles(java.util.List<java.io.File> sourceFolders, java.util.List<java.io.File> importFolders, java.io.File sourceOutputDir, java.io.File resOutputDir, java.io.File objOutputDir, java.io.File libOutputDir, int targetApi, boolean debugBuild, int optimLevel, boolean ndkMode, boolean supportMode, java.util.Set<java.lang.String> abiFilters, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Compiles all the renderscript files found in the given source folders.
void	compileAllShaderFiles(java.io.File sourceFolder, java.io.File outputDir, java.util.List<java.lang.String> defaultArgs, java.util.Map<java.lang.String,java.util.List<java.lang.String>> scopedArgs, java.io.File nkdLocation, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Compiles all the shader files found in the given source folders.
void	compileShaderFile(java.io.File sourceFolder, java.io.File shaderFile, java.io.File outputDir, java.util.List<java.lang.String> defaultArgs, java.util.Map<java.lang.String,java.util.List<java.lang.String>> scopedArgs, java.io.File nkdLocation, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Compiles the given aidl file.
void	convertByteCode(java.util.Collection<java.io.File> inputs, java.io.File outDexFolder, boolean multidex, java.io.File mainDexList, DexOptions dexOptions, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Converts the bytecode to Dalvik format
void	createJacocoReportWithJackReporter(java.io.File coverageFile, java.io.File reportDir, java.util.List<java.io.File> sourceDirs, java.lang.String reportName, java.io.File metadataFile)
java.util.Set<java.lang.String>	createMainDexList(java.io.File allClassesJarFile, java.io.File jarOfRoots, java.util.EnumSet<AndroidBuilder.MainDexListOption> options)
com.android.ide.common.process.ProcessResult	executeProcess(com.android.ide.common.process.ProcessInfo processInfo, com.android.ide.common.process.ProcessOutputHandler handler)
void	generateApkData(java.io.File apkFile, java.io.File outResFolder, java.lang.String mainPkgName, java.lang.String resName)
static void	generateApkDataEntryInManifest(int minSdkVersion, int targetSdkVersion, java.io.File manifestFile)
void	generateUnbundledWearApkData(java.io.File outResFolder, java.lang.String mainPkgName)
java.util.Set<java.io.File>	getAdditionalPackagedJars(VariantConfiguration<?,?,?> variantConfiguration) Returns the list of packaged jars for this config.
java.util.Set<java.io.File>	getAllPackagedJars(VariantConfiguration<?,?,?> variantConfiguration) Returns the list of packaged jars for this config.
java.util.List<java.io.File>	getBootClasspath(boolean includeOptionalLibraries) Helper method to get the boot classpath to be used during compilation.
java.util.List<java.lang.String>	getBootClasspathAsStrings(boolean includeOptionalLibraries) Helper method to get the boot classpath to be used during compilation.
com.android.sdklib.BuildToolInfo	getBuildToolInfo() Returns the build tools for this builder.
java.util.Set<java.io.File>	getCompileClasspath(VariantConfiguration<?,?,?> variantConfiguration) Returns the compile classpath for this config.
java.lang.String	getCreatedBy() Obtains the "created by" tag for the packaged manifest.
DexByteCodeConverter	getDexByteCodeConverter()
ErrorReporter	getErrorReporter()
com.android.ide.common.process.JavaProcessExecutor	getJavaProcessExecutor()
static java.util.List<java.io.File>	getLeafFolders(java.lang.String extension, java.util.List<java.io.File>... importFolders) Computes and returns the leaf folders based on a given file extension.
com.android.utils.ILogger	getLogger()
com.android.ide.common.process.ProcessExecutor	getProcessExecutor()
java.io.File	getRenderScriptSupportJar() Returns the jar file for the renderscript mode.
SdkInfo	getSdkInfo() Returns the SdkInfo, if set.
java.io.File	getSupportBlasLibFolder() Returns the BLAS lib folder for renderscript support mode.
java.io.File	getSupportNativeLibFolder() Returns the native lib folder for the renderscript mode.
com.android.sdklib.IAndroidTarget	getTarget() Returns the compilation target, if set.
java.lang.String	getTargetCodename()
TargetInfo	getTargetInfo() Returns the TargetInfo, if set.
boolean	isPreviewTarget() Returns whether the compilation target is a preview.
void	mergeManifestsForApplication(java.io.File mainManifest, java.util.List<java.io.File> manifestOverlays, java.util.List<? extends com.android.manifmerger.ManifestProvider> dependencies, java.lang.String packageOverride, int versionCode, java.lang.String versionName, java.lang.String minSdkVersion, java.lang.String targetSdkVersion, java.lang.Integer maxSdkVersion, java.lang.String outManifestLocation, java.lang.String outAaptSafeManifestLocation, java.lang.String outInstantRunManifestLocation, com.android.manifmerger.ManifestMerger2.MergeType mergeType, java.util.Map<java.lang.String,java.lang.Object> placeHolders, java.util.List<com.android.manifmerger.ManifestMerger2.Invoker.Feature> optionalFeatures, java.io.File reportFile) Invoke the Manifest Merger version 2.
void	mergeManifestsForTestVariant(java.lang.String testApplicationId, java.lang.String minSdkVersion, java.lang.String targetSdkVersion, java.lang.String testedApplicationId, java.lang.String instrumentationRunner, java.lang.Boolean handleProfiling, java.lang.Boolean functionalTest, java.lang.String testLabel, java.io.File testManifestFile, java.util.List<? extends com.android.manifmerger.ManifestProvider> manifestProviders, java.util.Map<java.lang.String,java.lang.Object> manifestPlaceholders, java.io.File outManifest, java.io.File tmpDir) Creates the manifest for a test variant
void	packageCodeSplitApk(java.io.File androidResPkg, java.util.Set<java.io.File> dexFiles, com.android.builder.model.SigningConfig signingConfig, java.io.File outApkLocation, java.io.File incrementalDir, com.android.apkzlib.zfile.ApkCreatorFactory apkCreatorFactory) Creates a new split APK containing only code.
void	preDexLibrary(java.io.File inputFile, java.io.File outFile, boolean multiDex, DexOptions dexOptions, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Converts the bytecode to Dalvik format, using the PreDexCache layer.
com.google.common.collect.ImmutableList<java.io.File>	preDexLibraryNoCache(java.io.File inputFile, java.io.File outFile, boolean multiDex, DexOptions dexOptions, com.android.ide.common.process.ProcessOutputHandler processOutputHandler) Converts the bytecode to Dalvik format, ignoring the PreDexCache layer.
void	processResources(com.android.builder.internal.aapt.Aapt aapt, com.android.builder.internal.aapt.AaptPackageConfig.Builder aaptConfigBuilder, boolean enforceUniquePackageName) Process the resources and generate R.java and/or the packaged resources.
void	setLibraryRequests(java.util.Collection<LibraryRequest> libraryRequests)
void	setSdkInfo(SdkInfo sdkInfo)
void	setTargetInfo(TargetInfo targetInfo) Sets the SdkInfo and the targetInfo on the builder.
static void	signApk(java.io.File in, com.android.builder.model.SigningConfig signingConfig, java.io.File out) Signs a single jar file using the passed SigningConfig.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_BUILD_TOOLS_REV

public static final com.android.repository.Revision MIN_BUILD_TOOLS_REV

Minimal supported version of build tools.

Constructor Detail

AndroidBuilder

public AndroidBuilder(@NonNull
                      java.lang.String projectId,
                      @Nullable
                      java.lang.String createdBy,
                      @NonNull
                      com.android.ide.common.process.ProcessExecutor processExecutor,
                      @NonNull
                      com.android.ide.common.process.JavaProcessExecutor javaProcessExecutor,
                      @NonNull
                      ErrorReporter errorReporter,
                      @NonNull
                      com.android.utils.ILogger logger,
                      boolean verboseExec)

Creates an AndroidBuilder.

verboseExec is needed on top of the ILogger due to remote exec tools not being able to output info and verbose messages separately.

Parameters:

createdBy - the createdBy String for the apk manifest.

logger - the Logger

verboseExec - whether external tools are launched in verbose mode

Method Detail

setTargetInfo

public void setTargetInfo(@NonNull
                          TargetInfo targetInfo)

Sets the SdkInfo and the targetInfo on the builder. This is required to actually build (some of the steps).

See Also:

SdkLoader

setSdkInfo

public void setSdkInfo(@NonNull
                       SdkInfo sdkInfo)

setLibraryRequests

public void setLibraryRequests(@NonNull
                               java.util.Collection<LibraryRequest> libraryRequests)

getSdkInfo

@Nullable
public SdkInfo getSdkInfo()

Returns the SdkInfo, if set.

getTargetInfo

@Nullable
public TargetInfo getTargetInfo()

Returns the TargetInfo, if set.

getBuildToolInfo

@NonNull
public com.android.sdklib.BuildToolInfo getBuildToolInfo()

Returns the build tools for this builder.

getLogger

@NonNull
public com.android.utils.ILogger getLogger()

getErrorReporter

@NonNull
public ErrorReporter getErrorReporter()

getTarget

@NonNull
public com.android.sdklib.IAndroidTarget getTarget()

Returns the compilation target, if set.

isPreviewTarget

public boolean isPreviewTarget()

Returns whether the compilation target is a preview.

getTargetCodename

public java.lang.String getTargetCodename()

getBootClasspath

@NonNull
public java.util.List<java.io.File> getBootClasspath(boolean includeOptionalLibraries)

Helper method to get the boot classpath to be used during compilation.

Parameters:

includeOptionalLibraries - if true, optional libraries are included even if not required by the project setup.

getBootClasspathAsStrings

@NonNull
public java.util.List<java.lang.String> getBootClasspathAsStrings(boolean includeOptionalLibraries)

Helper method to get the boot classpath to be used during compilation.

Parameters:

includeOptionalLibraries - if true, optional libraries are included even if not required by the project setup.

getRenderScriptSupportJar

@Nullable
public java.io.File getRenderScriptSupportJar()

Returns the jar file for the renderscript mode. This may return null if the SDK has not been loaded yet.

Returns:

the jar file, or null.

See Also:

setTargetInfo(TargetInfo)

getCompileClasspath

@NonNull
public java.util.Set<java.io.File> getCompileClasspath(@NonNull
                                                                VariantConfiguration<?,?,?> variantConfiguration)

Returns the compile classpath for this config. If the config tests a library, this will include the classpath of the tested config. If the SDK was loaded, this may include the renderscript support jar.

Returns:

a non null, but possibly empty set.

getAllPackagedJars

@NonNull
public java.util.Set<java.io.File> getAllPackagedJars(@NonNull
                                                               VariantConfiguration<?,?,?> variantConfiguration)

Returns the list of packaged jars for this config. If the config tests a library, this will include the jars of the tested config If the SDK was loaded, this may include the renderscript support jar.

Returns:

a non null, but possibly empty list.

getAdditionalPackagedJars

@NonNull
public java.util.Set<java.io.File> getAdditionalPackagedJars(@NonNull
                                                                      VariantConfiguration<?,?,?> variantConfiguration)

Returns the list of packaged jars for this config. If the config tests a library, this will include the jars of the tested config If the SDK was loaded, this may include the renderscript support jar.

Returns:

a non null, but possibly empty list.

getSupportNativeLibFolder

@Nullable
public java.io.File getSupportNativeLibFolder()

Returns the native lib folder for the renderscript mode. This may return null if the SDK has not been loaded yet.

Returns:

the folder, or null.

See Also:

setTargetInfo(TargetInfo)

getSupportBlasLibFolder

@Nullable
public java.io.File getSupportBlasLibFolder()

Returns the BLAS lib folder for renderscript support mode. This may return null if the SDK has not been loaded yet.

Returns:

the folder, or null.

See Also:

setTargetInfo(TargetInfo)

getProcessExecutor

@NonNull
public com.android.ide.common.process.ProcessExecutor getProcessExecutor()

getJavaProcessExecutor

@NonNull
public com.android.ide.common.process.JavaProcessExecutor getJavaProcessExecutor()

executeProcess

@NonNull
public com.android.ide.common.process.ProcessResult executeProcess(@NonNull
                                                                            com.android.ide.common.process.ProcessInfo processInfo,
                                                                            @NonNull
                                                                            com.android.ide.common.process.ProcessOutputHandler handler)

mergeManifestsForApplication

public void mergeManifestsForApplication(@NonNull
                                         java.io.File mainManifest,
                                         @NonNull
                                         java.util.List<java.io.File> manifestOverlays,
                                         @NonNull
                                         java.util.List<? extends com.android.manifmerger.ManifestProvider> dependencies,
                                         java.lang.String packageOverride,
                                         int versionCode,
                                         java.lang.String versionName,
                                         @Nullable
                                         java.lang.String minSdkVersion,
                                         @Nullable
                                         java.lang.String targetSdkVersion,
                                         @Nullable
                                         java.lang.Integer maxSdkVersion,
                                         @NonNull
                                         java.lang.String outManifestLocation,
                                         @Nullable
                                         java.lang.String outAaptSafeManifestLocation,
                                         @Nullable
                                         java.lang.String outInstantRunManifestLocation,
                                         com.android.manifmerger.ManifestMerger2.MergeType mergeType,
                                         java.util.Map<java.lang.String,java.lang.Object> placeHolders,
                                         @NonNull
                                         java.util.List<com.android.manifmerger.ManifestMerger2.Invoker.Feature> optionalFeatures,
                                         @Nullable
                                         java.io.File reportFile)

Invoke the Manifest Merger version 2.

mergeManifestsForTestVariant

public void mergeManifestsForTestVariant(@NonNull
                                         java.lang.String testApplicationId,
                                         @NonNull
                                         java.lang.String minSdkVersion,
                                         @NonNull
                                         java.lang.String targetSdkVersion,
                                         @NonNull
                                         java.lang.String testedApplicationId,
                                         @NonNull
                                         java.lang.String instrumentationRunner,
                                         @NonNull
                                         java.lang.Boolean handleProfiling,
                                         @NonNull
                                         java.lang.Boolean functionalTest,
                                         @Nullable
                                         java.lang.String testLabel,
                                         @Nullable
                                         java.io.File testManifestFile,
                                         @NonNull
                                         java.util.List<? extends com.android.manifmerger.ManifestProvider> manifestProviders,
                                         @NonNull
                                         java.util.Map<java.lang.String,java.lang.Object> manifestPlaceholders,
                                         @NonNull
                                         java.io.File outManifest,
                                         @NonNull
                                         java.io.File tmpDir)
                                  throws java.io.IOException

Creates the manifest for a test variant

Parameters:

testApplicationId - the application id of the test application

minSdkVersion - the minSdkVersion of the test application

targetSdkVersion - the targetSdkVersion of the test application

testedApplicationId - the application id of the tested application

instrumentationRunner - the name of the instrumentation runner

handleProfiling - whether or not the Instrumentation object will turn profiling on and off

functionalTest - whether or not the Instrumentation class should run as a functional test

testLabel - the label for the tests

testManifestFile - optionally user provided AndroidManifest.xml for testing application

manifestProviders - the manifest providers

manifestPlaceholders - used placeholders in the manifest

outManifest - the output location for the merged manifest

tmpDir - temporary dir used for processing

Throws:

java.io.IOException

See Also:

VariantConfiguration.getApplicationId(), VariantConfiguration.getTestedConfig(), VariantConfiguration.getMinSdkVersion(), VariantConfiguration.getTestedApplicationId(), VariantConfiguration.getInstrumentationRunner(), VariantConfiguration.getHandleProfiling(), VariantConfiguration.getFunctionalTest(), VariantConfiguration.getTestLabel(), ()

processResources

public void processResources(@NonNull
                             com.android.builder.internal.aapt.Aapt aapt,
                             @NonNull
                             com.android.builder.internal.aapt.AaptPackageConfig.Builder aaptConfigBuilder,
                             boolean enforceUniquePackageName)
                      throws java.io.IOException,
                             java.lang.InterruptedException,
                             com.android.ide.common.process.ProcessException

Process the resources and generate R.java and/or the packaged resources.

Parameters:

aapt - the interface to the aapt tool

aaptConfigBuilder - aapt command invocation parameters; this will receive some additional data (build tools, Android target and logger) and will be used to request package invocation in aapt (see Aapt.link(AaptPackageConfig))

enforceUniquePackageName - if true method will fail if some libraries share the same package name

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.process.ProcessException - failed

generateApkData

public void generateApkData(@NonNull
                            java.io.File apkFile,
                            @NonNull
                            java.io.File outResFolder,
                            @NonNull
                            java.lang.String mainPkgName,
                            @NonNull
                            java.lang.String resName)
                     throws com.android.ide.common.process.ProcessException,
                            java.io.IOException

Throws:

com.android.ide.common.process.ProcessException

java.io.IOException

generateUnbundledWearApkData

public void generateUnbundledWearApkData(@NonNull
                                         java.io.File outResFolder,
                                         @NonNull
                                         java.lang.String mainPkgName)
                                  throws com.android.ide.common.process.ProcessException,
                                         java.io.IOException

Throws:

com.android.ide.common.process.ProcessException

java.io.IOException

generateApkDataEntryInManifest

public static void generateApkDataEntryInManifest(int minSdkVersion,
                                                  int targetSdkVersion,
                                                  @NonNull
                                                  java.io.File manifestFile)
                                           throws java.lang.InterruptedException,
                                                  com.android.ide.common.internal.LoggedErrorException,
                                                  java.io.IOException

Throws:

java.lang.InterruptedException

com.android.ide.common.internal.LoggedErrorException

java.io.IOException

compileAllAidlFiles

public void compileAllAidlFiles(@NonNull
                                java.util.List<java.io.File> sourceFolders,
                                @NonNull
                                java.io.File sourceOutputDir,
                                @Nullable
                                java.io.File packagedOutputDir,
                                @Nullable
                                java.util.Collection<java.lang.String> packageWhiteList,
                                @NonNull
                                java.util.List<java.io.File> importFolders,
                                @Nullable
                                DependencyFileProcessor dependencyFileProcessor,
                                @NonNull
                                com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                         throws java.io.IOException,
                                java.lang.InterruptedException,
                                com.android.ide.common.internal.LoggedErrorException,
                                com.android.ide.common.process.ProcessException

Compiles all the aidl files found in the given source folders.

Parameters:

sourceFolders - all the source folders to find files to compile

sourceOutputDir - the output dir in which to generate the source code

packagedOutputDir - the output dir for the AIDL files that will be packaged in an aar

packageWhiteList - a list of AIDL FQCNs that are not parcelable that should also be packaged in an aar

importFolders - import folders

dependencyFileProcessor - the dependencyFileProcessor to record the dependencies of the compilation.

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.internal.LoggedErrorException - failed

com.android.ide.common.process.ProcessException

compileAidlFile

public void compileAidlFile(@NonNull
                            java.io.File sourceFolder,
                            @NonNull
                            java.io.File aidlFile,
                            @NonNull
                            java.io.File sourceOutputDir,
                            @Nullable
                            java.io.File packagedOutputDir,
                            @Nullable
                            java.util.Collection<java.lang.String> packageWhitelist,
                            @NonNull
                            java.util.List<java.io.File> importFolders,
                            @Nullable
                            DependencyFileProcessor dependencyFileProcessor,
                            @NonNull
                            com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                     throws java.io.IOException,
                            java.lang.InterruptedException,
                            com.android.ide.common.internal.LoggedErrorException,
                            com.android.ide.common.process.ProcessException

Compiles the given aidl file.

Parameters:

aidlFile - the AIDL file to compile

sourceOutputDir - the output dir in which to generate the source code

importFolders - all the import folders, including the source folders.

dependencyFileProcessor - the dependencyFileProcessor to record the dependencies of the compilation.

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.internal.LoggedErrorException - failed

com.android.ide.common.process.ProcessException

compileAllShaderFiles

public void compileAllShaderFiles(@NonNull
                                  java.io.File sourceFolder,
                                  @NonNull
                                  java.io.File outputDir,
                                  @NonNull
                                  java.util.List<java.lang.String> defaultArgs,
                                  @NonNull
                                  java.util.Map<java.lang.String,java.util.List<java.lang.String>> scopedArgs,
                                  @Nullable
                                  java.io.File nkdLocation,
                                  @NonNull
                                  com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                           throws java.io.IOException,
                                  java.lang.InterruptedException,
                                  com.android.ide.common.internal.LoggedErrorException,
                                  com.android.ide.common.process.ProcessException

Compiles all the shader files found in the given source folders.

Parameters:

sourceFolder - the source folder with the merged shaders

outputDir - the output dir in which to generate the output

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.internal.LoggedErrorException - failed

com.android.ide.common.process.ProcessException

compileShaderFile

public void compileShaderFile(@NonNull
                              java.io.File sourceFolder,
                              @NonNull
                              java.io.File shaderFile,
                              @NonNull
                              java.io.File outputDir,
                              @NonNull
                              java.util.List<java.lang.String> defaultArgs,
                              @NonNull
                              java.util.Map<java.lang.String,java.util.List<java.lang.String>> scopedArgs,
                              @Nullable
                              java.io.File nkdLocation,
                              @NonNull
                              com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                       throws java.io.IOException,
                              java.lang.InterruptedException,
                              com.android.ide.common.internal.LoggedErrorException,
                              com.android.ide.common.process.ProcessException

Compiles the given aidl file.

Parameters:

sourceFolder - the source folder containing the file

shaderFile - the shader file to compile

outputDir - the output dir

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.internal.LoggedErrorException - failed

com.android.ide.common.process.ProcessException

compileAllRenderscriptFiles

public void compileAllRenderscriptFiles(@NonNull
                                        java.util.List<java.io.File> sourceFolders,
                                        @NonNull
                                        java.util.List<java.io.File> importFolders,
                                        @NonNull
                                        java.io.File sourceOutputDir,
                                        @NonNull
                                        java.io.File resOutputDir,
                                        @NonNull
                                        java.io.File objOutputDir,
                                        @NonNull
                                        java.io.File libOutputDir,
                                        int targetApi,
                                        boolean debugBuild,
                                        int optimLevel,
                                        boolean ndkMode,
                                        boolean supportMode,
                                        @Nullable
                                        java.util.Set<java.lang.String> abiFilters,
                                        @NonNull
                                        com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                                 throws java.lang.InterruptedException,
                                        com.android.ide.common.process.ProcessException,
                                        com.android.ide.common.internal.LoggedErrorException,
                                        java.io.IOException

Compiles all the renderscript files found in the given source folders. Right now this is the only way to compile them as the renderscript compiler requires all renderscript files to be passed for all compilation. Therefore whenever a renderscript file or header changes, all must be recompiled.

Parameters:

sourceFolders - all the source folders to find files to compile

importFolders - all the import folders.

sourceOutputDir - the output dir in which to generate the source code

resOutputDir - the output dir in which to generate the bitcode file

targetApi - the target api

debugBuild - whether the build is debug

optimLevel - the optimization level

ndkMode - whether the renderscript code should be compiled to generate C/C++ bindings

supportMode - support mode flag to generate .so files.

abiFilters - ABI filters in case of support mode

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.internal.LoggedErrorException - failed

com.android.ide.common.process.ProcessException

getLeafFolders

@NonNull
 @SafeVarargs
public static java.util.List<java.io.File> getLeafFolders(@NonNull
                                                                                 java.lang.String extension,
                                                                                 java.util.List<java.io.File>... importFolders)

Computes and returns the leaf folders based on a given file extension. This looks through all the given root import folders, and recursively search for leaf folders containing files matching the given extensions. All the leaf folders are gathered and returned in the list.

Parameters:

extension - the extension to search for.

importFolders - an array of list of root folders.

Returns:

a list of leaf folder, never null.

getDexByteCodeConverter

@NonNull
public DexByteCodeConverter getDexByteCodeConverter()

convertByteCode

public void convertByteCode(@NonNull
                            java.util.Collection<java.io.File> inputs,
                            @NonNull
                            java.io.File outDexFolder,
                            boolean multidex,
                            @Nullable
                            java.io.File mainDexList,
                            @NonNull
                            DexOptions dexOptions,
                            @NonNull
                            com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                     throws java.io.IOException,
                            java.lang.InterruptedException,
                            com.android.ide.common.process.ProcessException

Converts the bytecode to Dalvik format

Parameters:

inputs - the input files

outDexFolder - the location of the output folder

dexOptions - dex options

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.process.ProcessException - failed

createMainDexList

public java.util.Set<java.lang.String> createMainDexList(@NonNull
                                                         java.io.File allClassesJarFile,
                                                         @NonNull
                                                         java.io.File jarOfRoots,
                                                         @NonNull
                                                         java.util.EnumSet<AndroidBuilder.MainDexListOption> options)
                                                  throws com.android.ide.common.process.ProcessException

Throws:

com.android.ide.common.process.ProcessException

preDexLibrary

public void preDexLibrary(@NonNull
                          java.io.File inputFile,
                          @NonNull
                          java.io.File outFile,
                          boolean multiDex,
                          @NonNull
                          DexOptions dexOptions,
                          @NonNull
                          com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                   throws java.io.IOException,
                          java.lang.InterruptedException,
                          com.android.ide.common.process.ProcessException

Converts the bytecode to Dalvik format, using the PreDexCache layer.

Parameters:

inputFile - the input file

outFile - the output file or folder if multi-dex is enabled

multiDex - whether multidex is enabled

dexOptions - dex options

processOutputHandler - output handler to use

Throws:

java.io.IOException - failed

java.lang.InterruptedException - failed

com.android.ide.common.process.ProcessException - failed

preDexLibraryNoCache

@NonNull
public com.google.common.collect.ImmutableList<java.io.File> preDexLibraryNoCache(@NonNull
                                                                                           java.io.File inputFile,
                                                                                           @NonNull
                                                                                           java.io.File outFile,
                                                                                           boolean multiDex,
                                                                                           @NonNull
                                                                                           DexOptions dexOptions,
                                                                                           @NonNull
                                                                                           com.android.ide.common.process.ProcessOutputHandler processOutputHandler)
                                                                                    throws com.android.ide.common.process.ProcessException,
                                                                                           java.io.IOException,
                                                                                           java.lang.InterruptedException

Converts the bytecode to Dalvik format, ignoring the PreDexCache layer.

Parameters:

inputFile - the input file

outFile - the output file or folder if multi-dex is enabled.

multiDex - whether multidex is enabled.

dexOptions - the dex options

Returns:

the list of generated files.

Throws:

com.android.ide.common.process.ProcessException - failed

java.io.IOException

java.lang.InterruptedException

createJacocoReportWithJackReporter

public void createJacocoReportWithJackReporter(@NonNull
                                               java.io.File coverageFile,
                                               @NonNull
                                               java.io.File reportDir,
                                               @NonNull
                                               java.util.List<java.io.File> sourceDirs,
                                               @NonNull
                                               java.lang.String reportName,
                                               @NonNull
                                               java.io.File metadataFile)
                                        throws com.android.ide.common.process.ProcessException

Throws:

com.android.ide.common.process.ProcessException

packageCodeSplitApk

public void packageCodeSplitApk(@NonNull
                                java.io.File androidResPkg,
                                @NonNull
                                java.util.Set<java.io.File> dexFiles,
                                @Nullable
                                com.android.builder.model.SigningConfig signingConfig,
                                @NonNull
                                java.io.File outApkLocation,
                                @NonNull
                                java.io.File incrementalDir,
                                @NonNull
                                com.android.apkzlib.zfile.ApkCreatorFactory apkCreatorFactory)
                         throws com.android.ide.common.signing.KeytoolException,
                                PackagerException,
                                java.io.IOException

Creates a new split APK containing only code.

This is used for instant run cold swaps on N and above.

Throws:

com.android.ide.common.signing.KeytoolException

PackagerException

java.io.IOException

signApk

public static void signApk(@NonNull
                           java.io.File in,
                           @Nullable
                           com.android.builder.model.SigningConfig signingConfig,
                           @NonNull
                           java.io.File out)
                    throws com.android.ide.common.signing.KeytoolException,
                           SigningException,
                           java.security.NoSuchAlgorithmException,
                           ZipAbortException,
                           SigningException,
                           java.io.IOException

Signs a single jar file using the passed SigningConfig.

Parameters:

in - the jar file to sign.

signingConfig - the signing configuration

out - the file path for the signed jar.

Throws:

java.io.IOException - failed

com.android.ide.common.signing.KeytoolException - failed

SigningException - failed

java.security.NoSuchAlgorithmException - failed

ZipAbortException - failed

SigningException - failed

getCreatedBy

@Nullable
public java.lang.String getCreatedBy()

Obtains the "created by" tag for the packaged manifest.

Returns:

the "created by" tag or null if no tag was defined