com.android.build.gradle

Class BasePlugin

java.lang.Object

com.android.build.gradle.BasePlugin

All Implemented Interfaces:

com.android.tools.lint.gradle.api.ToolingRegistryProvider, org.gradle.api.Plugin<org.gradle.api.Project>

Direct Known Subclasses:

AbstractAppPlugin, InstantAppPlugin, LibraryPlugin, TestPlugin

public abstract class BasePlugin
extends java.lang.Object
implements org.gradle.api.Plugin<org.gradle.api.Project>, com.android.tools.lint.gradle.api.ToolingRegistryProvider

Base class for all Android plugins

Field Summary

Fields

Modifier and Type	Field and Description
protected com.android.build.gradle.internal.ExtraModelInfo	extraModelInfo
static com.android.ide.common.repository.GradleVersion	GRADLE_MIN_VERSION
protected org.gradle.api.Project	project
protected ProjectOptions	projectOptions
protected com.android.build.gradle.internal.TaskManager	taskManager

Method Summary

Modifier and Type	Method and Description
void	apply(org.gradle.api.Project project)
protected abstract BaseExtension	createExtension(org.gradle.api.Project project, ProjectOptions projectOptions, com.android.build.gradle.internal.scope.GlobalScope globalScope, org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.BuildType> buildTypeContainer, org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.ProductFlavor> productFlavorContainer, org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.SigningConfig> signingConfigContainer, org.gradle.api.NamedDomainObjectContainer<BaseVariantOutput> buildOutputs, com.android.build.gradle.internal.dependency.SourceSetManager sourceSetManager, com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)
static void	createLintClasspathConfiguration(org.gradle.api.Project project) Creates a lint class path Configuration for the given project
protected abstract com.android.build.gradle.internal.TaskManager	createTaskManager(com.android.build.gradle.internal.scope.GlobalScope globalScope, org.gradle.api.Project project, ProjectOptions projectOptions, android.databinding.tool.DataBindingBuilder dataBindingBuilder, BaseExtension extension, com.android.build.gradle.internal.variant.VariantFactory variantFactory, org.gradle.tooling.provider.model.ToolingModelBuilderRegistry toolingRegistry, com.android.builder.profile.Recorder threadRecorder)
protected abstract com.android.build.gradle.internal.variant.VariantFactory	createVariantFactory(com.android.build.gradle.internal.scope.GlobalScope globalScope)
protected abstract com.google.wireless.android.sdk.stats.GradleBuildProject.PluginType	getAnalyticsPluginType()
BaseExtension	getExtension()
org.gradle.tooling.provider.model.ToolingModelBuilderRegistry	getModelBuilderRegistry()
protected abstract int	getProjectType()
com.android.build.gradle.internal.VariantManager	getVariantManager()
protected boolean	isPackagePublished() If overridden in a subclass to return "true," the package Configuration will be named "publish" instead of "apk"
protected abstract void	pluginSpecificApply(org.gradle.api.Project project)
protected void	registerModelBuilder(org.gradle.tooling.provider.model.ToolingModelBuilderRegistry registry, com.android.build.gradle.internal.scope.GlobalScope globalScope, com.android.build.gradle.internal.VariantManager variantManager, BaseExtension extension, com.android.build.gradle.internal.ExtraModelInfo extraModelInfo) Registers a builder for the custom tooling model.
protected void	registerModels(org.gradle.tooling.provider.model.ToolingModelBuilderRegistry registry, com.android.build.gradle.internal.scope.GlobalScope globalScope, com.android.build.gradle.internal.VariantManager variantManager, BaseExtension extension, com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)

Methods inherited from class java.lang.Object

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

Field Detail

GRADLE_MIN_VERSION

public static final com.android.ide.common.repository.GradleVersion GRADLE_MIN_VERSION

taskManager

protected com.android.build.gradle.internal.TaskManager taskManager

project

protected org.gradle.api.Project project

projectOptions

protected ProjectOptions projectOptions

extraModelInfo

protected com.android.build.gradle.internal.ExtraModelInfo extraModelInfo

Method Detail

createExtension

@NonNull
protected abstract BaseExtension createExtension(@NonNull
                                                          org.gradle.api.Project project,
                                                          @NonNull
                                                          ProjectOptions projectOptions,
                                                          @NonNull
                                                          com.android.build.gradle.internal.scope.GlobalScope globalScope,
                                                          @NonNull
                                                          org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.BuildType> buildTypeContainer,
                                                          @NonNull
                                                          org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.ProductFlavor> productFlavorContainer,
                                                          @NonNull
                                                          org.gradle.api.NamedDomainObjectContainer<com.android.build.gradle.internal.dsl.SigningConfig> signingConfigContainer,
                                                          @NonNull
                                                          org.gradle.api.NamedDomainObjectContainer<BaseVariantOutput> buildOutputs,
                                                          @NonNull
                                                          com.android.build.gradle.internal.dependency.SourceSetManager sourceSetManager,
                                                          @NonNull
                                                          com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)

getAnalyticsPluginType

@NonNull
protected abstract com.google.wireless.android.sdk.stats.GradleBuildProject.PluginType getAnalyticsPluginType()

createVariantFactory

@NonNull
protected abstract com.android.build.gradle.internal.variant.VariantFactory createVariantFactory(@NonNull
                                                                                                          com.android.build.gradle.internal.scope.GlobalScope globalScope)

createTaskManager

@NonNull
protected abstract com.android.build.gradle.internal.TaskManager createTaskManager(@NonNull
                                                                                            com.android.build.gradle.internal.scope.GlobalScope globalScope,
                                                                                            @NonNull
                                                                                            org.gradle.api.Project project,
                                                                                            @NonNull
                                                                                            ProjectOptions projectOptions,
                                                                                            @NonNull
                                                                                            android.databinding.tool.DataBindingBuilder dataBindingBuilder,
                                                                                            @NonNull
                                                                                            BaseExtension extension,
                                                                                            @NonNull
                                                                                            com.android.build.gradle.internal.variant.VariantFactory variantFactory,
                                                                                            @NonNull
                                                                                            org.gradle.tooling.provider.model.ToolingModelBuilderRegistry toolingRegistry,
                                                                                            @NonNull
                                                                                            com.android.builder.profile.Recorder threadRecorder)

getProjectType

protected abstract int getProjectType()

getVariantManager

public com.android.build.gradle.internal.VariantManager getVariantManager()

getExtension

public BaseExtension getExtension()

apply

public final void apply(@NonNull
                        org.gradle.api.Project project)

Specified by:

apply in interface org.gradle.api.Plugin<org.gradle.api.Project>

pluginSpecificApply

protected abstract void pluginSpecificApply(@NonNull
                                            org.gradle.api.Project project)

createLintClasspathConfiguration

public static void createLintClasspathConfiguration(@NonNull
                                                    org.gradle.api.Project project)

Creates a lint class path Configuration for the given project

registerModels

protected void registerModels(@NonNull
                              org.gradle.tooling.provider.model.ToolingModelBuilderRegistry registry,
                              @NonNull
                              com.android.build.gradle.internal.scope.GlobalScope globalScope,
                              @NonNull
                              com.android.build.gradle.internal.VariantManager variantManager,
                              @NonNull
                              BaseExtension extension,
                              @NonNull
                              com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)

registerModelBuilder

protected void registerModelBuilder(@NonNull
                                    org.gradle.tooling.provider.model.ToolingModelBuilderRegistry registry,
                                    @NonNull
                                    com.android.build.gradle.internal.scope.GlobalScope globalScope,
                                    @NonNull
                                    com.android.build.gradle.internal.VariantManager variantManager,
                                    @NonNull
                                    BaseExtension extension,
                                    @NonNull
                                    com.android.build.gradle.internal.ExtraModelInfo extraModelInfo)

Registers a builder for the custom tooling model.

getModelBuilderRegistry

@NonNull
public org.gradle.tooling.provider.model.ToolingModelBuilderRegistry getModelBuilderRegistry()

Specified by:

getModelBuilderRegistry in interface com.android.tools.lint.gradle.api.ToolingRegistryProvider

isPackagePublished

protected boolean isPackagePublished()

If overridden in a subclass to return "true," the package Configuration will be named "publish" instead of "apk"