ReportContainer

API 文件報告容器

Report 物件的容器,代表潛在的報告。

生產報告的事物(通常是任務)會公開一個報告容器,其中包含它們可以生產的每個可能報告的 Report 物件。每個報告物件都可以單獨配置,包括是否應通過其 Report.getRequired() required} 屬性來生產。

ReportContainer 實作是 不可變的,因為標準的集合方法(例如 add()remove()clear())將拋出 ImmutableViolationException。但是,實作可能會提供新的方法,允許添加新的報告物件和/或移除現有的報告物件。

屬性

屬性描述
已啟用

返回此容器中所有已啟用的 Report 物件的不可變集合。

方法

方法描述
getByName(name)

依名稱查找物件,如果沒有此物件則失敗。

getByName(name, configureClosure)

依名稱查找物件,如果沒有此物件則失敗。給定的配置閉包在物件從此方法返回之前針對該物件執行。物件作為其委託傳遞給閉包。

getByName(name, configureAction)

依名稱查找物件,如果沒有此物件則失敗。給定的配置動作在物件從此方法返回之前針對該物件執行。

named(name)

依名稱查找物件,如果沒有此物件則失敗。

named(name, type)

依名稱和類型查找物件,如果沒有此物件則失敗。

named(name, type, configurationAction)

依名稱和類型查找物件,如果沒有此物件則失敗。給定的配置動作在物件從提供者返回之前針對該物件執行。

named(name, configurationAction)

依名稱查找物件,如果沒有此物件則失敗。給定的配置動作在物件從提供者返回之前針對該物件執行。

named(nameFilter)
孵化中

返回包含名稱與提供的篩選器匹配的物件的集合。返回的集合是即時的,因此當匹配的物件添加到此集合時,它們也會在篩選後的集合中可見。

腳本區塊

沒有腳本區塊

屬性詳細資訊

NamedDomainObjectSet<T> enabled (唯讀)

返回此容器中所有已啟用的 Report 物件的不可變集合。

返回的集合是即時的。也就是說,隨著報告被啟用/停用,返回的集合始終反映當前已啟用的報告集。

方法詳細資訊

T getByName(String name)

依名稱查找物件,如果沒有此物件則失敗。

此操作是迫切的,將導致返回的元素被實現。

T getByName(String name, Closure configureClosure)

依名稱查找物件,如果沒有此物件則失敗。給定的配置閉包在物件從此方法返回之前針對該物件執行。物件作為其委託傳遞給閉包。

此操作是迫切的,將導致返回的元素被實現。

T getByName(String name, Action<? super T> configureAction)

依名稱查找物件,如果沒有此物件則失敗。給定的配置動作在物件從此方法返回之前針對該物件執行。

此操作是迫切的,將導致返回的元素被實現。

依名稱查找物件,如果沒有此物件則失敗。

此方法是延遲的,不會導致返回的元素被實現。

NamedDomainObjectProvider<S> named(String name, Class<S> type)

依名稱和類型查找物件,如果沒有此物件則失敗。

此方法是延遲的,不會導致返回的元素被實現。

NamedDomainObjectProvider<S> named(String name, Class<S> type, Action<? super S> configurationAction)

依名稱和類型查找物件,如果沒有此物件則失敗。給定的配置動作在物件從提供者返回之前針對該物件執行。

此方法是延遲的,不會導致返回的元素被實現。

NamedDomainObjectProvider<T> named(String name, Action<? super T> configurationAction)

依名稱查找物件,如果沒有此物件則失敗。給定的配置動作在物件從提供者返回之前針對該物件執行。

此方法是延遲的,不會導致返回的元素被實現。

注意:此方法正在孵化中,並可能在 Gradle 的未來版本中變更。

返回包含名稱與提供的篩選器匹配的物件的集合。返回的集合是即時的,因此當匹配的物件添加到此集合時,它們也會在篩選後的集合中可見。

此方法是一個中間操作。它不會更改集合中元素的實現/未實現狀態。