API 文档 | ReportContainer |
---|
一个包含 Report
对象的容器,这些对象代表潜在的报告。
生成报告的事物(通常是任务)会暴露一个报告容器,其中包含它们可以生成的每个潜在报告的 Report
对象。每个报告对象都可以单独配置,包括是否应通过其 Report.getRequired()
required} 属性生成该报告。
ReportContainer
的实现是 不可变的,标准集合方法如 add()
, remove()
和 clear()
将会抛出 ImmutableViolationException
。然而,实现可能会提供允许添加新的报告对象和/或移除现有报告对象的新方法。
方法 | 描述 |
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
(只读)
NamedDomainObjectSet
<T
>返回此容器中所有已启用的 Report
对象的不可变集合。
返回的集合是活的。也就是说,随着报告启用/禁用,返回的集合始终反映当前已启用报告的集合。
按名称定位对象,如果不存在则失败。给定的配置闭包在对象从该方法返回之前执行。对象作为委托传递给闭包。
此操作是急切的,将导致返回的元素被实例化。
按名称定位对象,如果不存在则失败。给定的配置动作在对象从该方法返回之前执行。
此操作是急切的,将导致返回的元素被实例化。
NamedDomainObjectProvider
<S
>
named
(String
name, Class
<S
>
type)
NamedDomainObjectProvider
<S
>Class
<S
>按名称和类型定位对象,如果不存在则失败。
此方法是惰性的,不会导致返回的元素被实例化。
NamedDomainObjectProvider
<S
>
named
(String
name, Class
<S
>
type, Action
<? super S
>
configurationAction)
NamedDomainObjectProvider
<S
>Class
<S
>Action
<? super S
>按名称和类型定位对象,如果不存在则失败。给定的配置动作在对象从提供者返回之前执行。
此方法是惰性的,不会导致返回的元素被实例化。
NamedDomainObjectProvider
<T
>
named
(String
name, Action
<? super T
>
configurationAction)
NamedDomainObjectProvider
<T
>Action
<? super T
>按名称定位对象,如果不存在则失败。给定的配置动作在对象从提供者返回之前执行。
此方法是惰性的,不会导致返回的元素被实例化。
NamedDomainObjectCollection
<T
>
named
(Spec
<String
>
nameFilter)
NamedDomainObjectCollection
<T
>Spec
<String
>注意:此方法尚在 孵化中,可能在未来的 Gradle 版本中发生变化。
返回包含名称与提供的过滤器匹配的对象的集合。返回的集合是活的,当匹配的对象添加到此集合时,它们也会在此过滤后的集合中可见。
此方法是一个中间操作。它不会改变集合中元素的实例化/未实例化状态。