PluginManager

API 文档PluginManager

用于方便地应用插件以及确定哪些插件已应用于一个 PluginAware 对象。

属性

无属性

方法

方法描述
apply(type)

应用指定的插件。如果插件已应用,则不执行任何操作。

apply(pluginId)

应用具有指定 ID 的插件。如果插件已应用,则不执行任何操作。

findPlugin(id)

返回已应用指定 ID 的插件的信息,如果指定 ID 的插件尚未应用,则返回 null。

hasPlugin(id)

如果具有指定 ID 的插件已应用,则返回 true,否则返回 false

withPlugin(id, action)

当应用指定插件时,执行给定的操作。

脚本块

无脚本块

方法详情

void apply(Class<?> type)

应用指定的插件。如果插件已应用,则不执行任何操作。

给定的类应实现 Plugin 接口,并针对与 this 兼容的类型进行参数化。

以下两行是等效的…

pluginManager.apply org.gradle.api.plugins.JavaPlugin
pluginManager.apply "org.gradle.java"

void apply(String pluginId)

应用具有指定 ID 的插件。如果插件已应用,则不执行任何操作。

位于 "org.gradle" 命名空间中的插件可以直接通过名称应用。也就是说,以下两行是等效的…

pluginManager.apply "org.gradle.java"
pluginManager.apply "java"

AppliedPlugin findPlugin(String id)

返回已应用指定 ID 的插件的信息,如果指定 ID 的插件尚未应用,则返回 null。

位于 "org.gradle" 命名空间中的插件(即核心 Gradle 插件)可以通过名称(例如 "java")或 ID("org.gradle.java")指定。所有其他插件必须通过其完整 ID(例如 "org.company.some-plugin")进行查询。

一些 Gradle 插件尚未迁移到完全限定的插件 ID。此类插件可以通过此方法使用非限定 ID(例如 "some-third-party-plugin")轻松检测到。

boolean hasPlugin(String id)

如果具有指定 ID 的插件已应用,则返回 true,否则返回 false

void withPlugin(String id, Action<? super AppliedPlugin> action)

当应用指定插件时,执行给定的操作。

如果指定 ID 的插件已应用,则会立即执行提供的操作。否则,将在指定 ID 的插件应用后立即执行该操作。

给定的操作总是在插件应用后执行。