|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.android.builder.AndroidBuilder
public class AndroidBuilder
This is the main builder class. It is given all the data to process the build (such as
DefaultProductFlavor
s, DefaultBuildType
and dependencies) and use them when doing specific
build steps.
To use:
create a builder with AndroidBuilder(SdkParser, String, ILogger, boolean)
then build steps can be done with
processManifest(java.io.File, java.util.List, java.util.List, String, int, String, int, int, String)
processTestManifest(String, int, int, String, String, Boolean, Boolean, java.util.List, String)
#processResources(java.io.File, java.io.File, java.io.File, java.util.List, String, String, String, String, String, com.android.builder.VariantConfiguration.Type, boolean, com.android.builder.model.AaptOptions)
compileAllAidlFiles(java.util.List, java.io.File, java.util.List, com.android.builder.compiling.DependencyFileProcessor)
convertByteCode(Iterable, Iterable, File, DexOptions, boolean)
packageApk(String, String, java.util.List, String, java.util.Collection, java.util.Set, boolean, com.android.builder.model.SigningConfig, String)
Java compilation is not handled but the builder provides the bootclasspath with
getBootClasspath(SdkParser)
.
Constructor Summary | |
---|---|
AndroidBuilder(SdkParser sdkParser,
java.lang.String createdBy,
com.android.utils.ILogger logger,
boolean verboseExec)
Creates an AndroidBuilder This receives an SdkParser to provide the build with information about the SDK, as
well as an ILogger to display output. |
Method Summary | |
---|---|
void |
compileAidlFile(java.io.File aidlFile,
java.io.File sourceOutputDir,
java.util.List<java.io.File> importFolders,
DependencyFileProcessor dependencyFileProcessor)
Compiles the given aidl file. |
void |
compileAllAidlFiles(java.util.List<java.io.File> sourceFolders,
java.io.File sourceOutputDir,
java.util.List<java.io.File> importFolders,
DependencyFileProcessor dependencyFileProcessor)
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)
Compiles all the renderscript files found in the given source folders. |
void |
convertByteCode(java.lang.Iterable<java.io.File> inputs,
java.lang.Iterable<java.io.File> preDexedLibraries,
java.io.File outDexFile,
DexOptions dexOptions,
boolean incremental)
Converts the bytecode to Dalvik format |
static com.android.builder.model.ClassField |
createClassField(java.lang.String type,
java.lang.String name,
java.lang.String value)
|
com.android.ide.common.internal.AaptRunner |
getAaptRunner()
Returns an AaptRunner able to run aapt commands. |
static java.util.List<java.lang.String> |
getBootClasspath(SdkParser sdkParser)
Helper method to get the boot classpath to be used during compilation. |
com.android.ide.common.internal.CommandLineRunner |
getCommandLineRunner()
|
java.util.Set<java.io.File> |
getCompileClasspath(VariantConfiguration variantConfiguration)
Returns the compile classpath for this config. |
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. |
java.util.List<java.io.File> |
getPackagedJars(VariantConfiguration variantConfiguration)
Returns the list of packaged jars for this config. |
java.io.File |
getSupportNativeLibFolder()
|
boolean |
isBuildingLibrary()
Sets whether this builder is currently used to build a library |
boolean |
isInsertSourceMarkers()
Returns whether we should insert source markers in generated files (such as XML resources and merged manifest files) |
void |
packageApk(java.lang.String androidResPkgLocation,
java.lang.String classesDexLocation,
java.util.List<java.io.File> packagedJars,
java.lang.String javaResourcesLocation,
java.util.Collection<java.io.File> jniLibsFolders,
java.util.Set<java.lang.String> abiFilters,
boolean jniDebugBuild,
com.android.builder.model.SigningConfig signingConfig,
java.lang.String outApkLocation)
Packages the apk. |
void |
preDexLibrary(java.io.File inputFile,
java.io.File outFile,
DexOptions dexOptions)
Converts the bytecode to Dalvik format |
void |
processManifest(java.io.File mainManifest,
java.util.List<java.io.File> manifestOverlays,
java.util.List<? extends ManifestDependency> libraries,
java.lang.String packageOverride,
int versionCode,
java.lang.String versionName,
int minSdkVersion,
int targetSdkVersion,
java.lang.String outManifestLocation)
Merges all the manifests into a single manifest |
void |
processResources(java.io.File manifestFile,
java.io.File resFolder,
java.io.File assetsDir,
java.util.List<? extends SymbolFileProvider> libraries,
java.lang.String packageForR,
java.lang.String sourceOutputDir,
java.lang.String symbolOutputDir,
java.lang.String resPackageOutput,
java.lang.String proguardOutput,
VariantConfiguration.Type type,
boolean debuggable,
com.android.builder.model.AaptOptions options,
java.util.Collection<java.lang.String> resourceConfigs)
Process the resources and generate R.java and/or the packaged resources. |
void |
processTestManifest(java.lang.String testPackageName,
int minSdkVersion,
int targetSdkVersion,
java.lang.String testedPackageName,
java.lang.String instrumentationRunner,
java.lang.Boolean handleProfiling,
java.lang.Boolean functionalTest,
java.util.List<? extends ManifestDependency> libraries,
java.lang.String outManifestLocation)
Creates the manifest for a test variant |
AndroidBuilder |
setBuildingLibrary(boolean library)
Sets whether this builder is currently used to build a library. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AndroidBuilder(@NonNull SdkParser sdkParser, @Nullable java.lang.String createdBy, @NonNull com.android.utils.ILogger logger, boolean verboseExec)
SdkParser
to provide the build with information about the SDK, as
well as an ILogger
to display output.
verboseExec is needed on top of the ILogger due to remote exec tools not being
able to output info and verbose messages separately.
sdkParser
- the SdkParserlogger
- the LoggerverboseExec
- whether external tools are launched in verbose modeMethod Detail |
---|
@NonNull public static java.util.List<java.lang.String> getBootClasspath(@NonNull SdkParser sdkParser)
public AndroidBuilder setBuildingLibrary(boolean library)
public boolean isBuildingLibrary()
@NonNull public java.util.Set<java.io.File> getCompileClasspath(@NonNull VariantConfiguration variantConfiguration)
@NonNull public java.util.List<java.io.File> getPackagedJars(@NonNull VariantConfiguration variantConfiguration)
@NonNull public java.io.File getSupportNativeLibFolder()
@NonNull public com.android.ide.common.internal.AaptRunner getAaptRunner()
AaptRunner
able to run aapt commands.
@NonNull public com.android.ide.common.internal.CommandLineRunner getCommandLineRunner()
@NonNull public static com.android.builder.model.ClassField createClassField(@NonNull java.lang.String type, @NonNull java.lang.String name, @NonNull java.lang.String value)
public void processManifest(@NonNull java.io.File mainManifest, @NonNull java.util.List<java.io.File> manifestOverlays, @NonNull java.util.List<? extends ManifestDependency> libraries, java.lang.String packageOverride, int versionCode, java.lang.String versionName, int minSdkVersion, int targetSdkVersion, @NonNull java.lang.String outManifestLocation)
mainManifest
- The main manifest of the application.manifestOverlays
- manifest overlays coming from flavors and build typeslibraries
- the library dependency graphpackageOverride
- a package name override. Can be null.versionCode
- a version code to inject in the manifest or -1 to do nothing.versionName
- a version name to inject in the manifest or null to do nothing.minSdkVersion
- a minSdkVersion to inject in the manifest or -1 to do nothing.targetSdkVersion
- a targetSdkVersion to inject in the manifest or -1 to do nothing.outManifestLocation
- the output location for the merged manifestVariantConfiguration.getMainManifest()
,
VariantConfiguration.getManifestOverlays()
,
VariantConfiguration.getDirectLibraries()
,
VariantConfiguration.getMergedFlavor()
,
DefaultProductFlavor.getVersionCode()
,
DefaultProductFlavor.getVersionName()
,
DefaultProductFlavor.getMinSdkVersion()
,
DefaultProductFlavor.getTargetSdkVersion()
public void processTestManifest(@NonNull java.lang.String testPackageName, int minSdkVersion, int targetSdkVersion, @NonNull java.lang.String testedPackageName, @NonNull java.lang.String instrumentationRunner, @NonNull java.lang.Boolean handleProfiling, @NonNull java.lang.Boolean functionalTest, @NonNull java.util.List<? extends ManifestDependency> libraries, @NonNull java.lang.String outManifestLocation)
testPackageName
- the package name of the test applicationminSdkVersion
- the minSdkVersion of the test applicationtargetSdkVersion
- the targetSdkVersion of the test applicationtestedPackageName
- the package name of the tested applicationinstrumentationRunner
- the name of the instrumentation runnerhandleProfiling
- whether or not the Instrumentation object will turn profiling on and offfunctionalTest
- whether or not the Instrumentation class should run as a functional testlibraries
- the library dependency graphoutManifestLocation
- the output location for the merged manifestVariantConfiguration.getPackageName()
,
VariantConfiguration.getTestedConfig()
,
VariantConfiguration.getMinSdkVersion()
,
VariantConfiguration.getTestedPackageName()
,
VariantConfiguration.getInstrumentationRunner()
,
VariantConfiguration.getHandleProfiling()
,
VariantConfiguration.getFunctionalTest()
,
VariantConfiguration.getDirectLibraries()
public boolean isInsertSourceMarkers()
public void processResources(@NonNull java.io.File manifestFile, @NonNull java.io.File resFolder, @Nullable java.io.File assetsDir, @NonNull java.util.List<? extends SymbolFileProvider> libraries, @Nullable java.lang.String packageForR, @Nullable java.lang.String sourceOutputDir, @Nullable java.lang.String symbolOutputDir, @Nullable java.lang.String resPackageOutput, @Nullable java.lang.String proguardOutput, VariantConfiguration.Type type, boolean debuggable, @NonNull com.android.builder.model.AaptOptions options, @NonNull java.util.Collection<java.lang.String> resourceConfigs) throws java.io.IOException, java.lang.InterruptedException, com.android.ide.common.internal.LoggedErrorException
manifestFile
- the location of the manifest fileresFolder
- the merged res folderassetsDir
- the merged asset folderlibraries
- the flat list of librariespackageForR
- Package override to generate the R class in a different package.sourceOutputDir
- optional source folder to generate R.javaresPackageOutput
- optional filepath for packaged resourcesproguardOutput
- optional filepath for proguard file to generatetype
- the type of the variant being builtdebuggable
- whether the app is debuggableoptions
- the AaptOptions
java.io.IOException
java.lang.InterruptedException
com.android.ide.common.internal.LoggedErrorException
public void compileAllAidlFiles(@NonNull java.util.List<java.io.File> sourceFolders, @NonNull java.io.File sourceOutputDir, @NonNull java.util.List<java.io.File> importFolders, @Nullable DependencyFileProcessor dependencyFileProcessor) throws java.io.IOException, java.lang.InterruptedException, com.android.ide.common.internal.LoggedErrorException
sourceFolders
- all the source folders to find files to compilesourceOutputDir
- the output dir in which to generate the source codeimportFolders
- import foldersdependencyFileProcessor
- the dependencyFileProcessor to record the dependencies
of the compilation.
java.io.IOException
java.lang.InterruptedException
com.android.ide.common.internal.LoggedErrorException
public void compileAidlFile(@NonNull java.io.File aidlFile, @NonNull java.io.File sourceOutputDir, @NonNull java.util.List<java.io.File> importFolders, @Nullable DependencyFileProcessor dependencyFileProcessor) throws java.io.IOException, java.lang.InterruptedException, com.android.ide.common.internal.LoggedErrorException
aidlFile
- the AIDL file to compilesourceOutputDir
- the output dir in which to generate the source codeimportFolders
- all the import folders, including the source folders.dependencyFileProcessor
- the dependencyFileProcessor to record the dependencies
of the compilation.
java.io.IOException
java.lang.InterruptedException
com.android.ide.common.internal.LoggedErrorException
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) throws java.io.IOException, java.lang.InterruptedException, com.android.ide.common.internal.LoggedErrorException
sourceFolders
- all the source folders to find files to compileimportFolders
- all the import folders.sourceOutputDir
- the output dir in which to generate the source coderesOutputDir
- the output dir in which to generate the bitcode filetargetApi
- the target apidebugBuild
- whether the build is debugoptimLevel
- the optimization level
java.io.IOException
java.lang.InterruptedException
com.android.ide.common.internal.LoggedErrorException
@NonNull public java.util.List<java.io.File> getLeafFolders(@NonNull java.lang.String extension, java.util.List<java.io.File>... importFolders)
extension
- the extension to search for.importFolders
- an array of list of root folders.
public void convertByteCode(@NonNull java.lang.Iterable<java.io.File> inputs, @NonNull java.lang.Iterable<java.io.File> preDexedLibraries, @NonNull java.io.File outDexFile, @NonNull DexOptions dexOptions, boolean incremental) throws java.io.IOException, java.lang.InterruptedException, com.android.ide.common.internal.LoggedErrorException
inputs
- the input filespreDexedLibraries
- the list of pre-dexed librariesoutDexFile
- the location of the output classes.dex filedexOptions
- dex optionsincremental
- true if it should attempt incremental dex if applicable
java.io.IOException
java.lang.InterruptedException
com.android.ide.common.internal.LoggedErrorException
public void preDexLibrary(@NonNull java.io.File inputFile, @NonNull java.io.File outFile, @NonNull DexOptions dexOptions) throws java.io.IOException, java.lang.InterruptedException, com.android.ide.common.internal.LoggedErrorException
inputFile
- the input fileoutFile
- the location of the output classes.dex filedexOptions
- dex options
java.io.IOException
java.lang.InterruptedException
com.android.ide.common.internal.LoggedErrorException
public void packageApk(@NonNull java.lang.String androidResPkgLocation, @NonNull java.lang.String classesDexLocation, @NonNull java.util.List<java.io.File> packagedJars, @Nullable java.lang.String javaResourcesLocation, @Nullable java.util.Collection<java.io.File> jniLibsFolders, @Nullable java.util.Set<java.lang.String> abiFilters, boolean jniDebugBuild, @Nullable com.android.builder.model.SigningConfig signingConfig, @NonNull java.lang.String outApkLocation) throws DuplicateFileException, java.io.FileNotFoundException, KeytoolException, PackagerException, SigningException
androidResPkgLocation
- the location of the packaged resource fileclassesDexLocation
- the location of the classes.dex filepackagedJars
- the jars that are packaged (libraries + jar dependencies)javaResourcesLocation
- the processed Java resource folderjniLibsFolders
- the folders containing jni shared librariesabiFilters
- optional ABI filterjniDebugBuild
- whether the app should include jni debug datasigningConfig
- the signing configurationoutApkLocation
- location of the APK.
DuplicateFileException
java.io.FileNotFoundException
- if the store location was not found
KeytoolException
PackagerException
SigningException
- when the key cannot be read from the keystoreVariantConfiguration.getPackagedJars()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |