Constructor Detail

• public AndroidBuilder(@com.android.annotations.NonNull String projectId, @com.android.annotations.Nullable String createdBy, @com.android.annotations.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

• public void compileAidlFile(@com.android.annotations.NonNull File sourceFolder, @com.android.annotations.NonNull File aidlFile, @com.android.annotations.NonNull File sourceOutputDir, @com.android.annotations.Nullable File parcelableOutputDir, @com.android.annotations.NonNull List<File> importFolders, @com.android.annotations.Nullable DependencyFileProcessor dependencyFileProcessor)

  Compiles the given aidl file.

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  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.

• public void compileAllAidlFiles(@com.android.annotations.NonNull List<File> sourceFolders, @com.android.annotations.NonNull File sourceOutputDir, @com.android.annotations.Nullable File parcelableOutputDir, @com.android.annotations.NonNull List<File> importFolders, @com.android.annotations.Nullable DependencyFileProcessor dependencyFileProcessor)

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

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  Parameters:

  sourceFolders - all the source folders to find files to compile

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

  importFolders - import folders

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

• public void compileAllRenderscriptFiles(@com.android.annotations.NonNull List<File> sourceFolders, @com.android.annotations.NonNull List<File> importFolders, @com.android.annotations.NonNull File sourceOutputDir, @com.android.annotations.NonNull File resOutputDir, @com.android.annotations.NonNull File objOutputDir, @com.android.annotations.NonNull File libOutputDir, int targetApi, boolean debugBuild, int optimLevel, boolean ndkMode, boolean supportMode, @com.android.annotations.Nullable Set<String> abiFilters)

  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.

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  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

  supportMode - support mode flag to generate .so files.

  abiFilters - ABI filters in case of support mode

• public void convertByteCode(@com.android.annotations.NonNull Collection<File> inputs, @com.android.annotations.NonNull Collection<File> preDexedLibraries, @com.android.annotations.NonNull File outDexFolder, boolean multidex, boolean multidexLegacy, @com.android.annotations.Nullable File mainDexList, @com.android.annotations.NonNull DexOptions dexOptions, @com.android.annotations.Nullable List<String> additionalParameters, @com.android.annotations.NonNull File tmpFolder, boolean incremental, boolean optimize)

  Converts the bytecode to Dalvik format

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  Parameters:

  inputs - the input files

  preDexedLibraries - the list of pre-dexed libraries

  outDexFolder - the location of the output folder

  dexOptions - dex options

  additionalParameters - list of additional parameters to give to dx

  incremental - true if it should attempt incremental dex if applicable

• public void convertLibraryToJack(@com.android.annotations.NonNull File inputFile, @com.android.annotations.NonNull File outFile, @com.android.annotations.NonNull DexOptions dexOptions)

  Converts the bytecode of a library to the jack format

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  Parameters:

  inputFile - the input file

  outFile - the location of the output classes.dex file

  dexOptions - dex options

• public static List<File> convertLibraryToJack(@com.android.annotations.NonNull File inputFile, @com.android.annotations.NonNull File outFile, @com.android.annotations.NonNull DexOptions dexOptions, @com.android.annotations.NonNull com.android.sdklib.BuildToolInfo buildToolInfo, boolean verbose, @com.android.annotations.NonNull com.android.ide.common.internal.CommandLineRunner commandLineRunner)

• @com.android.annotations.NonNull public static com.android.builder.model.ClassField createClassField(@com.android.annotations.NonNull String type, @com.android.annotations.NonNull String name, @com.android.annotations.NonNull String value)

• public void generateApkData(@com.android.annotations.NonNull File apkFile, @com.android.annotations.NonNull File outResFolder, @com.android.annotations.NonNull String mainPkgName, @com.android.annotations.NonNull String resName)

• public void generateApkDataEntryInManifest(int minSdkVersion, int targetSdkVersion, @com.android.annotations.NonNull File manifestFile)

• @com.android.annotations.NonNull public com.android.ide.common.internal.PngCruncher getAaptCruncher()

  Returns an com.android.ide.common.internal.PngCruncher using aapt underneath

  Returns:

  an PngCruncher object

• @com.android.annotations.NonNull public List<File> getBootClasspath()

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

• @com.android.annotations.NonNull public List<String> getBootClasspathAsStrings()

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

• @com.android.annotations.NonNull public com.android.ide.common.internal.CommandLineRunner getCommandLineRunner()

• @com.android.annotations.NonNull public Set<File> getCompileClasspath(@com.android.annotations.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.

• @com.android.annotations.NonNull public File getDxJar()

• @com.android.annotations.NonNull public List<File> getLeafFolders(@com.android.annotations.NonNull String extension, List<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.

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

• @com.android.annotations.NonNull public Set<File> getPackagedJars(@com.android.annotations.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.

• @com.android.annotations.Nullable public 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(com.android.builder.sdk.SdkInfo, com.android.builder.sdk.TargetInfo)

• @com.android.annotations.Nullable public SdkInfo getSdkInfo()

  Returns the SdkInfo, if set.

• @com.android.annotations.Nullable public 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(com.android.builder.sdk.SdkInfo, com.android.builder.sdk.TargetInfo)

• @com.android.annotations.Nullable public com.android.sdklib.IAndroidTarget getTarget()

  Returns the compilation target, if set.

• public String getTargetCodename()

• @com.android.annotations.Nullable public TargetInfo getTargetInfo()

  Returns the TargetInfo, if set.

• public boolean isPreviewTarget()

  Returns whether the compilation target is a preview.

• public void mergeManifests(@com.android.annotations.NonNull File mainManifest, @com.android.annotations.NonNull List<File> manifestOverlays, @com.android.annotations.NonNull List<? extends ManifestDependency> libraries, String packageOverride, int versionCode, String versionName, @com.android.annotations.Nullable String minSdkVersion, @com.android.annotations.Nullable String targetSdkVersion, @com.android.annotations.Nullable Integer maxSdkVersion, @com.android.annotations.NonNull String outManifestLocation, com.android.manifmerger.ManifestMerger2$MergeType mergeType, Map<String, String> placeHolders, @com.android.annotations.Nullable File reportFile)

  Invoke the Manifest Merger version 2.

• public void packageApk(@com.android.annotations.NonNull String androidResPkgLocation, @com.android.annotations.Nullable File dexFolder, @com.android.annotations.NonNull Collection<File> dexedLibraries, @com.android.annotations.NonNull Collection<File> packagedJars, @com.android.annotations.Nullable String javaResourcesLocation, @com.android.annotations.Nullable Collection<File> jniLibsFolders, @com.android.annotations.Nullable Set<String> abiFilters, boolean jniDebugBuild, @com.android.annotations.Nullable com.android.builder.model.SigningConfig signingConfig, @com.android.annotations.Nullable com.android.builder.model.PackagingOptions packagingOptions, @com.android.annotations.NonNull String outApkLocation)

  Packages the apk.

  throws:

  DuplicateFileException

  throws:

  FileNotFoundException if the store location was not found

  throws:

  KeytoolException

  throws:

  PackagerException

  throws:

  SigningException when the key cannot be read from the keystore

  Parameters:

  androidResPkgLocation - the location of the packaged resource file

  dexFolder - the folder with the dex file.

  dexedLibraries - optional collection of additional dex files to put in the apk.

  packagedJars - the jars that are packaged (libraries + jar dependencies)

  javaResourcesLocation - the processed Java resource folder

  jniLibsFolders - the folders containing jni shared libraries

  abiFilters - optional ABI filter

  jniDebugBuild - whether the app should include jni debug data

  signingConfig - the signing configuration

  packagingOptions - the packaging options

  outApkLocation - location of the APK.

  See Also:

  VariantConfiguration.getPackagedJars

• public void preDexLibrary(@com.android.annotations.NonNull File inputFile, @com.android.annotations.NonNull File outFile, boolean multiDex, @com.android.annotations.NonNull DexOptions dexOptions)

  Converts the bytecode to Dalvik format

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  Parameters:

  inputFile - the input file

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

  multiDex - whether multidex is enabled.

  dexOptions - dex options

• @com.android.annotations.NonNull public static List<File> preDexLibrary(@com.android.annotations.NonNull File inputFile, @com.android.annotations.NonNull File outFile, boolean multiDex, @com.android.annotations.NonNull DexOptions dexOptions, @com.android.annotations.NonNull com.android.sdklib.BuildToolInfo buildToolInfo, boolean verbose, @com.android.annotations.NonNull com.android.ide.common.internal.CommandLineRunner commandLineRunner)

  Converts the bytecode to Dalvik format

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  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

  buildToolInfo - the build tools info

  verbose - verbose flag

  commandLineRunner - the command line runner

  Returns:

  the list of generated files.

• public void processResources(@com.android.annotations.NonNull AaptPackageCommandBuilder aaptCommand, boolean enforceUniquePackageName)

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

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  LoggedErrorException

  Parameters:

  aaptCommand - aapt command invocation parameters.

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

• public void processTestManifest(@com.android.annotations.NonNull String testApplicationId, @com.android.annotations.Nullable String minSdkVersion, @com.android.annotations.Nullable String targetSdkVersion, @com.android.annotations.NonNull String testedApplicationId, @com.android.annotations.NonNull String instrumentationRunner, @com.android.annotations.NonNull Boolean handleProfiling, @com.android.annotations.NonNull Boolean functionalTest, @com.android.annotations.Nullable File testManifestFile, @com.android.annotations.NonNull List<? extends ManifestDependency> libraries, @com.android.annotations.NonNull File outManifest, @com.android.annotations.NonNull File tmpDir)

  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

  testManifestFile - optionally user provided AndroidManifest.xml for testing application

  libraries - the library dependency graph

  outManifest - the output location for the merged manifest

  See Also:

  VariantConfiguration.getApplicationId

  VariantConfiguration.getTestedConfig

  VariantConfiguration.getMinSdkVersion

  VariantConfiguration.getTestedApplicationId

  VariantConfiguration.getInstrumentationRunner

  VariantConfiguration.getHandleProfiling

  VariantConfiguration.getFunctionalTest

  VariantConfiguration.getDirectLibraries

• public void setTargetInfo(@com.android.annotations.NonNull SdkInfo sdkInfo, @com.android.annotations.NonNull TargetInfo targetInfo)

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

  Parameters:

  sdkInfo - the SdkInfo

  targetInfo - the TargetInfo

  See Also:

  SdkLoader

• public void signApk(File in, com.android.builder.model.SigningConfig signingConfig, File out)

  Signs a single jar file using the passed com.android.builder.model.SigningConfig.

  throws:

  IOException

  throws:

  KeytoolException

  throws:

  SigningException

  throws:

  NoSuchAlgorithmException

  throws:

  SignedJarBuilder.IZipEntryFilter.ZipAbortException

  throws:

  com.android.builder.signing.SigningException

  Parameters:

  in - the jar file to sign.

  signingConfig - the signing configuration

  out - the file path for the signed jar.