API 文档 | ReportContainer |
---|
一个 Report
对象的容器,表示潜在的报告。
产生报告的事物(通常是 task)公开一个报告容器,其中包含每个它们可以生成的可能报告的 Report
对象。每个报告对象都可以单独配置,包括是否应通过其 Report.getRequired()
required} 属性生成。
ReportContainer
实现是不可变的,因为诸如 add()
、remove()
和 clear()
等标准集合方法将抛出 ImmutableViolationException
。但是,实现可以提供允许添加新报告对象和/或删除现有报告对象的新方法。
方法 | 描述 |
getByName(name) | 按名称查找对象,如果不存在此类对象则失败。 |
getByName(name, configureClosure) | 按名称查找对象,如果不存在此类对象则失败。 给定的配置闭包在从该方法返回对象之前针对该对象执行。对象作为其委托传递给闭包。 |
getByName(name, configureAction) | 按名称查找对象,如果不存在此类对象则失败。 给定的配置 action 在从该方法返回对象之前针对该对象执行。 |
named(name) | 按名称查找对象,如果不存在此类对象则失败。 |
named(name, type) | 按名称和类型查找对象,如果不存在此类对象则失败。 |
named(name, type, configurationAction) | 按名称和类型查找对象,如果不存在此类对象则失败。 给定的配置 action 在从 provider 返回对象之前针对该对象执行。 |
named(name, configurationAction) | 按名称查找对象,如果不存在此类对象则失败。 给定的配置 action 在从 provider 返回对象之前针对该对象执行。 |
named(nameFilter) | 孵化中的功能 返回一个集合,其中包含名称与提供的过滤器匹配的对象。 返回的集合是实时的,因此当匹配的对象添加到此集合时,它们在过滤后的集合中也是可见的。 |
NamedDomainObjectSet
<T
>
enabled
(只读)
NamedDomainObjectSet
<T
>返回此容器中所有已启用的 Report
对象的不可变集合。
返回的集合是实时的。也就是说,随着报告被启用/禁用,返回的集合始终反映当前已启用的报告集。
按名称查找对象,如果不存在此类对象则失败。 给定的配置闭包在从该方法返回对象之前针对该对象执行。对象作为其委托传递给闭包。
此操作是立即执行的,并将导致返回的元素被实现。
按名称查找对象,如果不存在此类对象则失败。 给定的配置 action 在从该方法返回对象之前针对该对象执行。
此操作是立即执行的,并将导致返回的元素被实现。
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
>按名称和类型查找对象,如果不存在此类对象则失败。 给定的配置 action 在从 provider 返回对象之前针对该对象执行。
此方法是延迟加载的,不会导致返回的元素被实现。
NamedDomainObjectProvider
<T
>
named
(String
name, Action
<? super T
>
configurationAction)
NamedDomainObjectProvider
<T
>Action
<? super T
>按名称查找对象,如果不存在此类对象则失败。 给定的配置 action 在从 provider 返回对象之前针对该对象执行。
此方法是延迟加载的,不会导致返回的元素被实现。
NamedDomainObjectCollection
<T
>
named
(Spec
<String
>
nameFilter)
NamedDomainObjectCollection
<T
>Spec
<String
>注意:此方法是孵化中的功能,并且可能在 Gradle 的未来版本中更改。
返回一个集合,其中包含名称与提供的过滤器匹配的对象。 返回的集合是实时的,因此当匹配的对象添加到此集合时,它们在过滤后的集合中也是可见的。
此方法是中间操作。它不会更改集合中元素的已实现/未实现状态。