com.android.build.gradle
[Groovy] Class BasePlugin

java.lang.Object
  com.android.build.gradle.BasePlugin

abstract class BasePlugin

Base class for all Android plugins


Field Summary
static java.lang.String DIR_BUNDLES

static java.lang.String FILE_JACOCO_AGENT

static java.lang.String GRADLE_MIN_VERSION

static java.lang.String[] GRADLE_SUPPORTED_VERSIONS

static java.lang.String INSTALL_GROUP

static java.io.File TEST_SDK_DIR

protected Task assembleTest

protected Task connectedCheck

protected Task deviceCheck

protected Instantiator instantiator

protected Copy jacocoAgentTask

protected JacocoPlugin jacocoPlugin

protected Task lintAll

Task lintCompile

protected Task lintVital

protected PrepareSdkTask mainPreBuild

protected DefaultAndroidSourceSet mainSourceSet

protected Project project

protected SdkHandler sdkHandler

protected DefaultAndroidSourceSet testSourceSet

protected Task uninstallAll

 
Property Summary
java.util.Map prepareTaskMap

java.util.Map validateSigningTaskMap

java.util.List variantDataList

 
Constructor Summary
protected BasePlugin(Instantiator instantiator, ToolingModelBuilderRegistry registry)

 
Method Summary
java.lang.Object addDependency(ResolvedComponentResult moduleVersion, VariantDependencies configDependencies, java.util.Collection bundles, java.util.Map jars, java.util.Map modules, java.util.Map artifacts, Multimap reverseMap)

void addPackageTasks(ApkVariantData variantData, Task assembleTask, boolean publishApk)

Creates the packaging tasks for the given Variant.

protected void apply(Project project)

MergeResources basicCreateMergeResourcesTask(BaseVariantData variantData, java.lang.String taskNamePrefix, java.lang.String outputLocation, boolean includeDependencies, boolean process9Patch)

void checkTasksAlreadyCreated()

void createAidlTask(BaseVariantData variantData, java.io.File parcelableDir)

void createAnchorTasks(BaseVariantData variantData)

void createAndroidTasks(boolean force)

Task createAssembleTask(BaseVariantData variantData)

void createBuildConfigTask(BaseVariantData variantData)

void createCheckManifestTask(BaseVariantData variantData)

void createCheckTasks(boolean hasFlavors, boolean isLibraryTest)

void createCompileTask(BaseVariantData variantData, BaseVariantData testedVariantData)

void createCopyMicroApkTask(BaseVariantData variantData, Configuration config)

void createGenerateMicroApkDataTask(BaseVariantData variantData, Configuration config)

void createGenerateResValuesTask(BaseVariantData variantData)

void createLintCompileTask()

void createLintTasks()

void createMergeAssetsTask(BaseVariantData variantData, java.lang.String outputLocation, boolean includeDependencies)

void createMergeManifestsTask(BaseVariantData variantData, java.lang.String manifestOutDir)

void createMergeResourcesTask(BaseVariantData variantData, boolean process9Patch)

void createNdkTasks(BaseVariantData variantData)

void createOldProcessManifestTask(BaseVariantData variantData, java.lang.String manifestOurDir)

void createProcessJavaResTask(BaseVariantData variantData)

void createProcessManifestTask(BaseVariantData variantData, java.lang.String manifestOutDir)

void createProcessResTask(BaseVariantData variantData, boolean generateResourcePackage)

void createProcessResTask(BaseVariantData variantData, java.lang.String symbolLocation, boolean generateResourcePackage)

protected void createProcessTestManifestTask(BaseVariantData variantData, java.lang.String manifestOurDir)

java.io.File createProguardTasks(BaseVariantData variantData, BaseVariantData testedVariantData)

Creates the proguarding task for the given Variant.

void createRenderscriptTask(BaseVariantData variantData)

void createTestApkTasks(TestVariantData variantData, BaseVariantData testedVariantData)

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(ILogger logger, Project project, java.lang.String message)

static void displayDeprecationWarning(Logger logger, Project project, java.lang.String message)

protected void ensureConfigured(Configuration config)

void ensureTargetSetup()

AndroidBuilder getAndroidBuilder()

java.util.List getBootClasspath()

ProductFlavorData getDefaultConfigData()

BaseExtension getExtension()

protected java.lang.Class getExtensionClass()

java.util.Collection getExtraAndroidArtifacts(java.lang.String variantName)

java.util.Collection getExtraArtifacts()

java.util.Collection getExtraBuildTypeSourceProviders(java.lang.String buildTypeName)

java.util.Collection getExtraFlavorSourceProviders(java.lang.String flavorName)

java.util.Collection getExtraJavaArtifacts(java.lang.String variantName)

java.util.Collection getExtraVariantSourceProviders(java.lang.String variantName)

Instantiator getInstantiator()

Copy getJacocoAgentTask()

static java.lang.Object[] getLocalJarFileList(DependencyContainer dependencyContainer)

ILogger getLogger()

protected java.util.List getManifestDependencies(java.util.List libraries)

java.io.File getNdkFolder()

protected static java.io.File getOptionalDir(java.io.File dir)

Project getProject()

java.io.File getSdkFolder()

SdkInfo getSdkInfo()

protected static java.util.List getTextSymbolDependencies(java.util.List libraries)

java.util.Collection getUnresolvedDependencies()

protected VariantFactory getVariantFactory()

VariantManager getVariantManager()

protected PrepareLibraryTask handleLibrary(Project project, LibraryDependencyImpl library)

Handles the library and returns a task to "prepare" the library (ie unarchive it).

boolean isVerbose()

void registerArtifactType(java.lang.String name, boolean isTest, int artifactType)

void registerBuildTypeSourceProvider(java.lang.String name, BuildType buildType, SourceProvider sourceProvider)

void registerJavaArtifact(java.lang.String name, BaseVariant variant, java.lang.String assembleTaskName, java.lang.String javaCompileTaskName, Configuration configuration, java.io.File classesFolder, SourceProvider sourceProvider)

void registerMultiFlavorSourceProvider(java.lang.String name, java.lang.String flavorName, SourceProvider sourceProvider)

void registerProductFlavorSourceProvider(java.lang.String name, ProductFlavor productFlavor, SourceProvider sourceProvider)

void resolveDependencies(VariantDependencies variantDeps)

void setAssembleTest(Task assembleTest)

 
Methods inherited from 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()
 

Field Detail

DIR_BUNDLES

public static final java.lang.String DIR_BUNDLES


FILE_JACOCO_AGENT

public static final java.lang.String FILE_JACOCO_AGENT


GRADLE_MIN_VERSION

public static final java.lang.String GRADLE_MIN_VERSION


GRADLE_SUPPORTED_VERSIONS

public static final java.lang.String[] GRADLE_SUPPORTED_VERSIONS


INSTALL_GROUP

public static final java.lang.String INSTALL_GROUP


TEST_SDK_DIR

public static java.io.File TEST_SDK_DIR


assembleTest

protected Task assembleTest


connectedCheck

protected Task connectedCheck


deviceCheck

protected Task deviceCheck


instantiator

protected Instantiator instantiator


jacocoAgentTask

protected Copy jacocoAgentTask


jacocoPlugin

protected JacocoPlugin jacocoPlugin


lintAll

protected Task lintAll


lintCompile

public Task lintCompile


lintVital

protected Task lintVital


mainPreBuild

protected PrepareSdkTask mainPreBuild


mainSourceSet

protected DefaultAndroidSourceSet mainSourceSet


project

protected Project project


sdkHandler

protected SdkHandler sdkHandler


testSourceSet

protected DefaultAndroidSourceSet testSourceSet


uninstallAll

protected Task uninstallAll


 
Property Detail

prepareTaskMap

final java.util.Map prepareTaskMap


validateSigningTaskMap

final java.util.Map validateSigningTaskMap


variantDataList

final java.util.List variantDataList


 
Constructor Detail

BasePlugin

protected BasePlugin(Instantiator instantiator, ToolingModelBuilderRegistry registry)


 
Method Detail

addDependency

java.lang.Object addDependency(ResolvedComponentResult moduleVersion, VariantDependencies configDependencies, java.util.Collection bundles, java.util.Map jars, java.util.Map modules, java.util.Map artifacts, Multimap reverseMap)


addPackageTasks

void addPackageTasks(@NonNull ApkVariantData variantData, @Nullable Task assembleTask, boolean publishApk)
Creates the packaging tasks for the given Variant.
Parameters:
variantData - the variant data.
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.


apply

protected void apply(Project project)


basicCreateMergeResourcesTask

MergeResources basicCreateMergeResourcesTask(@NonNull BaseVariantData variantData, @NonNull java.lang.String taskNamePrefix, @NonNull java.lang.String outputLocation, boolean includeDependencies, boolean process9Patch)


checkTasksAlreadyCreated

void checkTasksAlreadyCreated()


createAidlTask

void createAidlTask(@NonNull BaseVariantData variantData, @Nullable java.io.File parcelableDir)


createAnchorTasks

void createAnchorTasks(@NonNull BaseVariantData variantData)


createAndroidTasks

final void createAndroidTasks(boolean force)


createAssembleTask

Task createAssembleTask(BaseVariantData variantData)


createBuildConfigTask

void createBuildConfigTask(BaseVariantData variantData)


createCheckManifestTask

void createCheckManifestTask(@NonNull BaseVariantData variantData)


createCheckTasks

void createCheckTasks(boolean hasFlavors, boolean isLibraryTest)


createCompileTask

void createCompileTask(BaseVariantData variantData, BaseVariantData testedVariantData)


createCopyMicroApkTask

void createCopyMicroApkTask(@NonNull BaseVariantData variantData, @NonNull Configuration config)


createGenerateMicroApkDataTask

void createGenerateMicroApkDataTask(@NonNull BaseVariantData variantData, @NonNull Configuration config)


createGenerateResValuesTask

void createGenerateResValuesTask(BaseVariantData variantData)


createLintCompileTask

void createLintCompileTask()


createLintTasks

void createLintTasks()


createMergeAssetsTask

void createMergeAssetsTask(@NonNull BaseVariantData variantData, @Nullable java.lang.String outputLocation, boolean includeDependencies)


createMergeManifestsTask

void createMergeManifestsTask(BaseVariantData variantData, java.lang.String manifestOutDir)


createMergeResourcesTask

void createMergeResourcesTask(@NonNull BaseVariantData variantData, boolean process9Patch)


createNdkTasks

void createNdkTasks(@NonNull BaseVariantData variantData)


createOldProcessManifestTask

void createOldProcessManifestTask(BaseVariantData variantData, java.lang.String manifestOurDir)


createProcessJavaResTask

void createProcessJavaResTask(BaseVariantData variantData)


createProcessManifestTask

void createProcessManifestTask(BaseVariantData variantData, java.lang.String manifestOutDir)


createProcessResTask

void createProcessResTask(@NonNull BaseVariantData variantData, boolean generateResourcePackage)


createProcessResTask

void createProcessResTask(@NonNull BaseVariantData variantData, @NonNull java.lang.String symbolLocation, boolean generateResourcePackage)


createProcessTestManifestTask

protected void createProcessTestManifestTask(BaseVariantData variantData, java.lang.String manifestOurDir)


createProguardTasks

@NonNull
java.io.File createProguardTasks(@NonNull BaseVariantData variantData, @Nullable BaseVariantData testedVariantData)
Creates the proguarding task for the given Variant.
Parameters:
variantData - the variant data.
testedVariantData - optional. variant data representing the tested variant, null if the variant is not a test variant
Returns:
outFile file outputted by proguard


createRenderscriptTask

void createRenderscriptTask(BaseVariantData variantData)


createTestApkTasks

void createTestApkTasks(@NonNull TestVariantData variantData, @NonNull BaseVariantData testedVariantData)
Creates the tasks to build the test apk.
Parameters:
variant - the test variant
testedVariant - the tested variant
configDependencies - the list of config dependencies


createZipAlignTask

@NonNull
ZipAlign createZipAlignTask(@NonNull java.lang.String name, @NonNull java.io.File inputFile, @NonNull java.io.File outputFile)
creates a zip align. This does not use convention mapping, and is meant to let other plugin create zip align tasks.
Parameters:
name - the name of the task
inputFile - the input file
outputFile - the output file
Returns:
the task


displayDeprecationWarning

void displayDeprecationWarning(java.lang.String message)


displayDeprecationWarning

static void displayDeprecationWarning(ILogger logger, Project project, java.lang.String message)


displayDeprecationWarning

static void displayDeprecationWarning(Logger logger, Project project, java.lang.String message)


ensureConfigured

protected void ensureConfigured(Configuration config)


ensureTargetSetup

void ensureTargetSetup()


getAndroidBuilder

AndroidBuilder getAndroidBuilder()


getBootClasspath

java.util.List getBootClasspath()


getDefaultConfigData

ProductFlavorData getDefaultConfigData()


getExtension

BaseExtension getExtension()


getExtensionClass

protected java.lang.Class getExtensionClass()


getExtraAndroidArtifacts

java.util.Collection getExtraAndroidArtifacts(@NonNull java.lang.String variantName)


getExtraArtifacts

java.util.Collection getExtraArtifacts()


getExtraBuildTypeSourceProviders

java.util.Collection getExtraBuildTypeSourceProviders(@NonNull java.lang.String buildTypeName)


getExtraFlavorSourceProviders

java.util.Collection getExtraFlavorSourceProviders(@NonNull java.lang.String flavorName)


getExtraJavaArtifacts

java.util.Collection getExtraJavaArtifacts(@NonNull java.lang.String variantName)


getExtraVariantSourceProviders

java.util.Collection getExtraVariantSourceProviders(@NonNull java.lang.String variantName)


getInstantiator

Instantiator getInstantiator()


getJacocoAgentTask

Copy getJacocoAgentTask()


getLocalJarFileList

static java.lang.Object[] getLocalJarFileList(DependencyContainer dependencyContainer)


getLogger

ILogger getLogger()


getManifestDependencies

@NonNull
protected java.util.List getManifestDependencies(java.util.List libraries)


getNdkFolder

java.io.File getNdkFolder()


getOptionalDir

protected static java.io.File getOptionalDir(java.io.File dir)


getProject

Project getProject()


getSdkFolder

java.io.File getSdkFolder()


getSdkInfo

SdkInfo getSdkInfo()


getTextSymbolDependencies

@NonNull
protected static java.util.List getTextSymbolDependencies(java.util.List libraries)


getUnresolvedDependencies

java.util.Collection getUnresolvedDependencies()


getVariantFactory

protected VariantFactory getVariantFactory()


getVariantManager

VariantManager getVariantManager()


handleLibrary

protected PrepareLibraryTask handleLibrary(@NonNull Project project, @NonNull LibraryDependencyImpl library)
Handles 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.
Parameters:
project - the project
library - the library.
Returns:
the prepare task.


isVerbose

boolean isVerbose()


registerArtifactType

void registerArtifactType(@NonNull java.lang.String name, boolean isTest, int artifactType)


registerBuildTypeSourceProvider

void registerBuildTypeSourceProvider(@NonNull java.lang.String name, @NonNull BuildType buildType, @NonNull SourceProvider sourceProvider)


registerJavaArtifact

void registerJavaArtifact(@NonNull java.lang.String name, @NonNull BaseVariant variant, @NonNull java.lang.String assembleTaskName, @NonNull java.lang.String javaCompileTaskName, @NonNull Configuration configuration, @NonNull java.io.File classesFolder, @Nullable SourceProvider sourceProvider)


registerMultiFlavorSourceProvider

void registerMultiFlavorSourceProvider(@NonNull java.lang.String name, @NonNull java.lang.String flavorName, @NonNull SourceProvider sourceProvider)


registerProductFlavorSourceProvider

void registerProductFlavorSourceProvider(@NonNull java.lang.String name, @NonNull ProductFlavor productFlavor, @NonNull SourceProvider sourceProvider)


resolveDependencies

void resolveDependencies(VariantDependencies variantDeps)


setAssembleTest

void setAssembleTest(Task assembleTest)


 

Copyright (C) 2012 The Android Open Source Project