PluginAware

API 文件PluginAware
已知子類型
專案
Gradle
設定

可以套用插件的東西。

可以使用 PluginAware.getPluginManager() 來套用和偵測插件是否已套用。

有關編寫和套用插件的更多資訊,請參閱 Plugin

屬性

屬性描述
pluginManager

此插件感知物件的插件管理器。

plugins

已套用至此物件的插件容器。

方法

方法描述
apply(closure)

套用零或多個插件或腳本。

apply(options)

使用以 Map 形式提供的指定選項來套用插件或腳本。如果插件已套用,則不執行任何操作。

apply(action)

套用零或多個插件或腳本。

腳本區塊

無腳本區塊

屬性詳細資訊

PluginManager pluginManager (唯讀)

此插件感知物件的插件管理器。

PluginContainer plugins (唯讀)

已套用至此物件的插件容器。

雖然不建議使用,但建議使用此介面的方法或 PluginAware.getPluginManager(),而不是使用插件容器。

使用此介面或 PluginAware.getPluginManager() 上的 'apply' 方法之一來套用插件,而不是透過插件容器套用。

使用 PluginManager.hasPlugin(java.lang.String) 或類似方法來查詢插件的套用情況,而不是透過插件容器查詢。

方法詳細資訊

void apply(Closure closure)

套用零或多個插件或腳本。

給定的 Closure 用於配置 ObjectConfigurationAction,它「建置」插件應用程式。

此方法與 PluginAware.apply(java.util.Map) 的不同之處在於,它允許多次調用組態動作的方法。

void apply(Map<String, ?> options)

使用以 Map 形式提供的指定選項來套用插件或腳本。如果插件已套用,則不執行任何操作。

給定的 Map 會作為一系列方法調用套用至新建立的 ObjectConfigurationAction。也就是說,Map 中的每個鍵都應該是 ObjectConfigurationAction 方法的名稱,而值應該是該方法的相容參數。

以下選項可用

  • from:要套用的腳本。接受 Project.uri(java.lang.Object) 支援的任何路徑。
  • plugin:要套用的插件的 ID 或實作類別。
  • to:目標委派物件或多個物件。預設為此插件感知物件。使用此選項來配置此物件以外的物件。

void apply(Action<? super ObjectConfigurationAction> action)

套用零或多個插件或腳本。

給定的 Closure 用於配置 ObjectConfigurationAction,它「建置」插件應用程式。

此方法與 PluginAware.apply(java.util.Map) 的不同之處在於,它允許多次調用組態動作的方法。