Base class for all Android plugins
Modifiers | Name | Description |
---|---|---|
static class |
BasePlugin.PostCompilationData |
Class to hold data to setup the many optional post-compilation steps. |
Modifiers | Name | Description |
---|---|---|
static java.lang.String |
DEFAULT_PROGUARD_CONFIG_FILE |
|
static java.lang.String |
DIR_BUNDLES |
|
static java.lang.String |
FILE_JACOCO_AGENT |
|
static java.util.regex.Pattern |
GRADLE_ACCEPTABLE_VERSIONS |
|
static java.lang.String |
GRADLE_TEST_VERSION |
|
static java.lang.String |
INSTALL_GROUP |
|
static java.io.File |
TEST_SDK_DIR |
|
protected org.gradle.api.Task |
assembleTest |
|
protected org.gradle.api.Task |
connectedCheck |
|
protected org.gradle.api.Task |
deviceCheck |
|
protected org.gradle.internal.reflect.Instantiator |
instantiator |
|
protected org.gradle.api.tasks.Copy |
jacocoAgentTask |
|
protected com.android.build.gradle.internal.coverage.JacocoPlugin |
jacocoPlugin |
|
protected org.gradle.api.Task |
lintAll |
|
org.gradle.api.Task |
lintCompile |
|
protected org.gradle.api.Task |
lintVital |
|
protected com.android.build.gradle.internal.tasks.PrepareSdkTask |
mainPreBuild |
|
protected com.android.build.gradle.internal.api.DefaultAndroidSourceSet |
mainSourceSet |
|
protected org.gradle.api.Project |
project |
|
protected com.android.build.gradle.internal.SdkHandler |
sdkHandler |
|
protected com.android.build.gradle.internal.api.DefaultAndroidSourceSet |
testSourceSet |
|
protected org.gradle.api.Task |
uninstallAll |
Constructor and description |
---|
protected BasePlugin
(org.gradle.internal.reflect.Instantiator instantiator, org.gradle.tooling.provider.model.ToolingModelBuilderRegistry registry) |
Type | Name and description |
---|---|
java.lang.Object |
addDependency(org.gradle.api.artifacts.result.ResolvedComponentResult moduleVersion, com.android.build.gradle.internal.dependency.VariantDependencies configDependencies, java.util.Collection<com.android.builder.dependency.LibraryDependency> bundles, java.util.Map<java.io.File, com.android.builder.dependency.JarDependency> jars, java.util.Map<org.gradle.api.artifacts.ModuleVersionIdentifier, java.util.List<com.android.build.gradle.internal.dependency.LibraryDependencyImpl>> modules, java.util.Map<org.gradle.api.artifacts.ModuleVersionIdentifier, java.util.List<org.gradle.api.artifacts.ResolvedArtifact>> artifacts, com.google.common.collect.Multimap<com.android.builder.dependency.LibraryDependency, com.android.build.gradle.internal.dependency.VariantDependencies> reverseMap) |
protected void |
apply(org.gradle.api.Project project) |
MergeResources |
basicCreateMergeResourcesTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, java.lang.String taskNamePrefix, java.lang.String outputLocation, boolean includeDependencies, boolean process9Patch) |
void |
checkTasksAlreadyCreated() |
protected void |
configureProject() |
void |
createAidlTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, java.io.File parcelableDir) |
void |
createAnchorTasks(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createAndroidTasks(boolean force) |
org.gradle.api.Task |
createAssembleTask(com.android.build.gradle.internal.variant.BaseVariantOutputData variantOutputData) |
org.gradle.api.Task |
createAssembleTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createBuildConfigTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createCheckManifestTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createCheckTasks(boolean hasFlavors, boolean isLibraryTest) |
void |
createCompileTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> testedVariantData) |
void |
createGenerateMicroApkDataTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, org.gradle.api.artifacts.Configuration config) |
void |
createGenerateResValuesTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createJackTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> testedVariantData) |
BasePlugin.PostCompilationData |
createJacocoTask(com.android.build.gradle.internal.core.GradleVariantConfiguration config, com.android.build.gradle.internal.variant.BaseVariantData variantData, BasePlugin.PostCompilationData pcData) |
void |
createLintCompileTask() |
void |
createLintTasks() |
void |
createMergeAppManifestsTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createMergeAssetsTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, java.lang.String outputLocation, boolean includeDependencies) |
void |
createMergeLibManifestsTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, java.lang.String manifestOutDir) |
void |
createMergeResourcesTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, boolean process9Patch) |
void |
createNdkTasks(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createPackagingTask(com.android.build.gradle.internal.variant.ApkVariantData variantData, org.gradle.api.Task assembleTask, boolean publishApk) Creates the final packaging task, and optionally the zipalign task (if the variant is signed) |
void |
createPostCompilationTasks(com.android.build.gradle.internal.variant.ApkVariantData variantData) Creates the post-compilation tasks for the given Variant. |
void |
createProcessJavaResTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createProcessResTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, boolean generateResourcePackage) |
void |
createProcessResTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, java.lang.String symbolLocation, boolean generateResourcePackage) |
protected void |
createProcessTestManifestTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, java.lang.String manifestOurDir) |
void |
createProguardTasks(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData, com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> testedVariantData, BasePlugin.PostCompilationData pcData) Creates the proguarding task for the given Variant. |
void |
createRenderscriptTask(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) |
void |
createSplitAbiTasks(com.android.build.gradle.internal.variant.ApplicationVariantData variantData) |
void |
createSplitResourcesTasks(com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData> variantData) Creates the split resources packages task if necessary. |
void |
createTestApkTasks(com.android.build.gradle.internal.variant.TestVariantData variantData) Creates the tasks to build the test apk. |
ZipAlign |
createZipAlignTask(java.lang.String name, java.io.File inputFile, java.io.File outputFile) creates a zip align. |
void |
displayDeprecationWarning(java.lang.String message) |
static void |
displayDeprecationWarning(org.gradle.api.logging.Logger logger, org.gradle.api.Project project, java.lang.String message) |
static void |
displayWarning(com.android.utils.ILogger logger, org.gradle.api.Project project, java.lang.String message) |
static void |
displayWarning(org.gradle.api.logging.Logger logger, org.gradle.api.Project project, java.lang.String message) |
protected void |
doApply() |
protected void |
ensureConfigured(org.gradle.api.artifacts.Configuration config) |
void |
ensureTargetSetup() |
static BasePlugin |
findBasePlugin(org.gradle.api.Project project) Returns a plugin that is an instance of BasePlugin. |
com.android.builder.core.AndroidBuilder |
getAndroidBuilder() |
java.util.List<java.io.File> |
getBootClasspath() |
java.util.List<java.lang.String> |
getBootClasspathAsStrings() |
com.android.build.gradle.internal.ProductFlavorData<com.android.build.gradle.internal.dsl.ProductFlavor> |
getDefaultConfigData() |
BaseExtension |
getExtension() |
protected java.lang.Class<? extends BaseExtension> |
getExtensionClass() |
java.util.Collection<com.android.builder.model.AndroidArtifact> |
getExtraAndroidArtifacts(java.lang.String variantName) |
java.util.Collection<com.android.builder.model.ArtifactMetaData> |
getExtraArtifacts() |
java.util.Collection<com.android.builder.model.SourceProviderContainer> |
getExtraBuildTypeSourceProviders(java.lang.String buildTypeName) |
java.util.Collection<com.android.builder.model.SourceProviderContainer> |
getExtraFlavorSourceProviders(java.lang.String flavorName) |
java.util.Collection<com.android.builder.model.JavaArtifact> |
getExtraJavaArtifacts(java.lang.String variantName) |
java.util.Collection<com.android.builder.model.SourceProviderContainer> |
getExtraVariantSourceProviders(java.lang.String variantName) |
org.gradle.internal.reflect.Instantiator |
getInstantiator() |
org.gradle.api.tasks.Copy |
getJacocoAgentTask() |
java.util.Set<java.io.File> |
getJniFolders(com.android.build.gradle.internal.variant.ApkVariantData variantData) Calculate the list of folders that can contain jni artifacts for this variant. |
static java.lang.Object[] |
getLocalJarFileList(com.android.builder.dependency.DependencyContainer dependencyContainer) |
com.android.utils.ILogger |
getLogger() |
protected java.util.List<com.android.build.gradle.internal.dependency.ManifestDependencyImpl> |
getManifestDependencies(java.util.List<com.android.builder.dependency.LibraryDependency> libraries) |
java.io.File |
getNdkFolder() |
protected static java.io.File |
getOptionalDir(java.io.File dir) |
org.gradle.api.Project |
getProject() |
java.io.File |
getSdkFolder() |
com.android.builder.sdk.SdkInfo |
getSdkInfo() |
protected static java.util.List<com.android.build.gradle.internal.dependency.SymbolFileProviderImpl> |
getTextSymbolDependencies(java.util.List<com.android.builder.dependency.LibraryDependency> libraries) |
java.util.Collection<java.lang.String> |
getUnresolvedDependencies() |
java.util.List<com.android.build.gradle.internal.variant.BaseVariantData<? extends com.android.build.gradle.internal.variant.BaseVariantOutputData>> |
getVariantDataList() |
protected com.android.build.gradle.internal.variant.VariantFactory |
getVariantFactory() |
com.android.build.gradle.internal.VariantManager |
getVariantManager() |
protected com.android.build.gradle.internal.tasks.PrepareLibraryTask |
handleLibrary(org.gradle.api.Project project, com.android.build.gradle.internal.dependency.LibraryDependencyImpl library) Handles the library and returns a task to "prepare" the library (ie unarchive it). |
boolean |
isVerbose() |
static java.lang.String |
normalize(org.gradle.api.artifacts.ModuleVersionIdentifier id, java.lang.String path) Normalize a path to remove all illegal characters for all supported operating systems. |
static void |
optionalDependsOn(org.gradle.api.Task main, org.gradle.api.Task... dependencies) |
static void |
optionalDependsOn(org.gradle.api.Task main, java.util.List<java.lang.Object> dependencies) |
void |
registerArtifactType(java.lang.String name, boolean isTest, int artifactType) |
void |
registerBuildTypeSourceProvider(java.lang.String name, com.android.build.gradle.internal.dsl.BuildType buildType, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerJavaArtifact(java.lang.String name, BaseVariant variant, java.lang.String assembleTaskName, java.lang.String javaCompileTaskName, org.gradle.api.artifacts.Configuration configuration, java.io.File classesFolder, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerMultiFlavorSourceProvider(java.lang.String name, java.lang.String flavorName, com.android.builder.model.SourceProvider sourceProvider) |
void |
registerProductFlavorSourceProvider(java.lang.String name, com.android.build.gradle.internal.dsl.ProductFlavor productFlavor, com.android.builder.model.SourceProvider sourceProvider) |
void |
resolveDependencies(com.android.build.gradle.internal.dependency.VariantDependencies variantDeps) |
void |
setAssembleTest(org.gradle.api.Task assembleTest) |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Creates the final packaging task, and optionally the zipalign task (if the variant is signed)
assembleTask
- an optional assembleTask to be used. If null a new one is created. The
assembleTask is always set in the Variant.publishApk
- if true the generated APK gets published.Creates the post-compilation tasks for the given Variant. These tasks create the dex file from the .class files, plus optional intermediary steps like proguard and jacoco
variantData
- the variant data.Creates the proguarding task for the given Variant.
variantData
- the variant data.testedVariantData
- optional. variant data representing the tested variant, null if the
variant is not a test variantCreates the split resources packages task if necessary. AAPT will produce split packages for all --split provided parameters. These split packages should be signed and moved unchanged to the APK build output directory.
variantData
- the variant configuration.Creates the tasks to build the test apk.
variantData
- the test variantcreates a zip align. This does not use convention mapping, and is meant to let other plugin create zip align tasks.
name
- the name of the taskinputFile
- the input fileoutputFile
- the output fileReturns a plugin that is an instance of BasePlugin. Returns null if a BasePlugin cannot be found.
Calculate the list of folders that can contain jni artifacts for this variant.
variantData
- the variantHandles the library and returns a task to "prepare" the library (ie unarchive it). The task will be reused for all projects using the same library.
project
- the projectlibrary
- the library.Normalize a path to remove all illegal characters for all supported operating systems. {
id
- the module coordinates that generated this pathpath
- the proposed path nameCopyright (C) 2012 The Android Open Source Project