PluginAware

目录

属性
方法
脚本块
属性详情
方法详情
API 文档PluginAware
已知子类型
Project
Gradle
Settings

可以应用插件的对象。

可以使用 PluginAware.getPluginManager() 来应用和检测插件是否已应用。

有关编写和应用插件的更多信息，请参阅 Plugin。

属性

属性描述
pluginManager

此 PluginAware 对象的插件管理器。

plugins

已应用到此对象的插件容器。

方法

方法描述
apply(closure)

应用零个或多个插件或脚本。

apply(options)

应用一个插件或脚本，使用作为 map 提供的给定选项。如果插件已经应用，则不做任何事情。

apply(action)

应用零个或多个插件或脚本。

脚本块

无脚本块

属性详情

PluginManager pluginManager (只读)

此 PluginAware 对象的插件管理器。

PluginContainer plugins (只读)

已应用到此对象的插件容器。

虽然没有弃用，但相比于使用插件容器，更推荐使用此接口或 PluginAware.getPluginManager() 的方法。

使用此接口或 PluginAware.getPluginManager() 上的 'apply' 方法之一来应用插件，而不是通过插件容器应用。

使用 PluginManager.hasPlugin(java.lang.String) 或类似方法查询插件的应用情况，而不是通过插件容器这样做。

方法详情

void apply(Closure closure)

应用零个或多个插件或脚本。

给定的 closure 用于配置一个 ObjectConfigurationAction，它“构建”插件应用。

此方法与 PluginAware.apply(java.util.Map) 不同之处在于，它允许多次调用配置 action 的方法。

void apply(Map<String, ?> options)

应用一个插件或脚本，使用作为 map 提供的给定选项。如果插件已经应用，则不做任何事情。

给定的 map 作为一系列方法调用应用到一个新创建的 ObjectConfigurationAction。也就是说，map 中的每个 key 预计是 ObjectConfigurationAction 的方法名，而 value 是该方法的兼容参数。

以下选项可用：

  • from: 要应用的脚本。接受 Project.uri(java.lang.Object) 支持的任何路径。
  • plugin: 要应用的插件 ID 或实现类。
  • to: 目标委托对象或对象集合。默认为此 PluginAware 对象。使用此选项配置除此对象以外的对象。

void apply(Action<? super ObjectConfigurationAction> action)

应用零个或多个插件或脚本。

给定的 closure 用于配置一个 ObjectConfigurationAction，它“构建”插件应用。

此方法与 PluginAware.apply(java.util.Map) 不同之处在于，它允许多次调用配置 action 的方法。