ReportContainer

API 文档ReportContainer

一个包含 Report 对象的容器,这些对象表示潜在的报告。

生成报告的事物(通常是任务)会暴露一个报告容器,其中包含它们可以生成的每个可能报告的 Report 对象。每个报告对象都可以单独配置,包括是否应该通过其 Report.getRequired() 必需} 属性来生成报告。

ReportContainer 实现是不可变的,即标准集合方法如 add()remove()clear() 将抛出 ImmutableViolationException。但是,实现可以提供新方法,允许添加新的报告对象和/或移除现有报告对象。

属性

属性描述
enabled

返回此容器中所有已启用的 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 的未来版本中更改。

返回一个包含名称与所提供过滤器匹配的对象的集合。返回的集合是实时的,因此当匹配的对象添加到此集合时,它们也会在过滤后的集合中可见。

此方法是一个中间操作。它不改变集合中元素的已实现/未实现状态。