API文档: | TaskContainer |
---|
ATaskContainer
负责管理一组Task
实例。
您可以TaskContainer
通过调用Project.getTasks()
或使用
tasks
构建脚本中的属性来获取实例。
方法 | 描述 |
containerWithType(type) | 创建一个常规容器,该容器包装呈现指定类型的所有元素的多态容器。 |
create(name) |
|
create(name, configureClosure) |
|
create(name, type) | 创建 |
create(name, type, constructorArgs) | 创建 |
create(name, type, configuration) |
|
create(name, configureAction) | 使用给定名称创建一个新项目,将其添加到此容器中,然后使用给定操作对其进行配置。 |
create(options) | 创建一个 |
create(options, configureClosure) | 创建一个 |
findByPath(path) | 按路径定位任务。您可以提供任务名称、相对路径或绝对路径。相对路径是相对于该容器的项目进行解释的。如果不存在具有给定路径的任务,则此方法返回 null。 |
getByName(name) | 按名称查找对象,如果不存在该对象则失败。 |
getByName(name, configureClosure) | 按名称查找对象,如果不存在该对象则失败。在从此方法返回对象之前,将针对该对象执行给定的配置闭包。该对象作为其委托传递给闭包。 |
getByName(name, configureAction) | 按名称查找对象,如果不存在该对象则失败。在从此方法返回对象之前,将针对该对象执行给定的配置操作。 |
getByPath(path) | 按路径定位任务。您可以提供任务名称、相对路径或绝对路径。相对路径是相对于该容器的项目进行解释的。如果不存在具有给定路径的任务,则此方法将引发异常。 |
maybeCreate(name) | 查找具有给定名称的项目,如果不存在,则创建并将其添加到此容器中。 |
maybeCreate(name, type) | 查找具有给定名称和类型的项目,如果不存在,则创建并将其添加到此容器中。 |
named(name) | 按名称定位任务,不触发其创建或配置,如果不存在此类对象,则失败。 |
named(name, type) | 按名称和类型定位对象,不触发其创建或配置,如果不存在该对象则失败。 |
named(name, type, configurationAction) | 按名称和类型定位对象,不触发其创建或配置,如果不存在该对象则失败。在从提供者返回对象之前,对对象执行给定的配置操作。 |
named(name, configurationAction) | 按名称定位对象,不触发其创建或配置,如果不存在该对象则失败。在从提供者返回对象之前,对对象执行给定的配置操作。 |
named(nameFilter) | 返回一个集合,其中包含名称与提供的过滤器匹配的对象。返回的集合是实时的,因此当匹配的对象添加到该集合中时,它们在过滤后的集合中也可见。此方法不会导致该容器中的任何待处理对象被实现。 |
register(name) | 定义一个新任务,该任务将在需要时创建。当使用查询方法(例如 |
register(name, type) | 定义一个新任务,该任务将在需要时创建。当使用查询方法(例如 |
register(name, type, constructorArgs) | 定义一个新任务,当需要将给定参数传递给 |
register(name, type, configurationAction) | 定义一个新任务,将在需要时创建和配置。当使用查询方法(例如 |
register(name, configurationAction) | 定义一个新任务,将在需要时创建和配置。当使用查询方法(例如 |
replace(name) | 创建 |
replace(name, type) | 创建 |
NamedDomainObjectContainer
<U
>
containerWithType
(类型)Class
<U
>
NamedDomainObjectContainer
<U
>Class
<U
>创建一个常规容器,该容器包装呈现指定类型的所有元素的多态容器。
Task
使用给定名称创建一个并将其添加到此容器中。给定的闭包用于在此方法返回任务之前配置任务。
添加任务后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。
创建Task
具有给定名称和类型的 a,将给定参数传递给带@Inject
注释的构造函数,并将其添加到此容器中。传递给任务构造函数的所有值都必须为非空;否则 a
NullPointerException
将被抛出
添加任务后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。
Task
使用给定的名称和类型创建一个,使用给定的操作对其进行配置,并将其添加到此容器中。
添加任务后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。
创建一个Task
并将其添加到此容器中。可以将创建选项映射传递给此方法来控制任务的创建方式。可以使用以下选项:
选项 | 描述 | 默认值 |
| 要创建的任务的名称。 | 没有任何。必须指定。 |
| 要创建的任务的类。 | DefaultTask |
| Action 任务执行时关闭或执行。看Task.doFirst(org.gradle.api.Action) 。 | null |
| 替换现有任务? | false |
| 任务的依赖关系。请参阅此处了解更多详细信息。 | [] |
| 任务组。 | null
|
| 任务的描述。 |
null |
| 要传递给任务类构造函数的参数。 |
null |
添加任务后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。
如果此容器中已存在具有给定名称的任务并且该
选项未设置为 true,则会引发异常。overwrite
创建一个Task
将其添加到此容器中。可以将创建选项映射传递给此方法来控制任务的创建方式。请参阅TaskContainer.create(java.util.Map)
参考资料 中的可用选项列表。给定的闭包用于在此方法返回任务之前配置任务。
添加任务后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。
按路径定位任务。您可以提供任务名称、相对路径或绝对路径。相对路径是相对于该容器的项目进行解释的。如果不存在具有给定路径的任务,则此方法返回 null。
T
getByName
(String
姓名)
按名称查找对象,如果不存在该对象则失败。
T
maybeCreate
(String
姓名)
查找具有给定名称的项目,如果不存在,则创建并将其添加到此容器中。
TaskProvider
<T
>
named
(String
姓名)
TaskProvider
<T
>按名称定位任务,不触发其创建或配置,如果不存在此类对象,则失败。
TaskProvider
<S
>
named
(String
名称、类型)Class
<S
>
TaskProvider
<S
>Class
<S
>按名称和类型定位对象,不触发其创建或配置,如果不存在该对象则失败。
TaskProvider
<S
>
named
(String
名称、类型、配置操作)Class
<S
>
Action
<? super S
>
TaskProvider
<S
>Class
<S
>Action
<? super S
>按名称和类型定位对象,不触发其创建或配置,如果不存在该对象则失败。在从提供者返回对象之前,对对象执行给定的配置操作。
TaskProvider
<T
>
named
(String
名称、配置操作)Action
<? super T
>
TaskProvider
<T
>Action
<? super T
>按名称定位对象,不触发其创建或配置,如果不存在该对象则失败。在从提供者返回对象之前,对对象执行给定的配置操作。
TaskCollection
<T
>
named
(名称过滤器)Spec
<String
>
TaskCollection
<T
>Spec
<String
>返回一个集合,其中包含名称与提供的过滤器匹配的对象。返回的集合是实时的,因此当匹配的对象添加到该集合中时,它们在过滤后的集合中也可见。此方法不会导致该容器中的任何待处理对象被实现。
TaskProvider
<Task
>
register
(String
姓名)
TaskProvider
<Task
>定义一个新任务,该任务将在需要时创建。当使用查询方法(例如TaskCollection.getByName(java.lang.String)
,将任务添加到任务图中以供执行时)或Provider.get()
在该方法的返回值上调用任务
时,任务是“必需的” 。
使用此方法通常比使用此方法更有效TaskContainer.create(java.lang.String)
,因为该方法将急切地创建任务,无论当前构建是否需要该任务。另一方面,此方法会将创建推迟到需要时。
TaskProvider
<T
>
register
(String
名称、类型)Class
<T
>
TaskProvider
<T
>Class
<T
>定义一个新任务,该任务将在需要时创建。当使用查询方法(例如TaskCollection.getByName(java.lang.String)
,将任务添加到任务图中以供执行时)或Provider.get()
在该方法的返回值上调用任务
时,任务是“必需的” 。
使用此方法而不是TaskContainer.create(java.lang.String, java.lang.Class, org.gradle.api.Action)
或通常更有效TaskContainer.create(java.lang.String, java.lang.Class)
,因为这些方法将急切地创建和配置任务,无论当前构建是否需要该任务。另一方面,此方法会将创建推迟到需要时。
TaskProvider
<T
>
register
(String
名称、类型、构造函数参数)Class
<T
>
Object
...
TaskProvider
<T
>Class
<T
>Object
...定义一个新任务,当需要将给定参数传递给@Inject
带注释的构造函数时将创建该任务。当使用查询方法(例如TaskCollection.getByName(java.lang.String)
,将任务添加到任务图中以供执行时)或Provider.get()
在该方法的返回值上调用任务时,任务是“必需的” 。传递给任务构造函数的所有值都必须为非空;否则 aNullPointerException
将被抛出
使用此方法而不是TaskContainer.create(java.lang.String, java.lang.Class, org.gradle.api.Action)
或通常更有效TaskContainer.create(java.lang.String, java.lang.Class)
,因为这些方法将急切地创建和配置任务,无论当前构建是否需要该任务。另一方面,此方法会将创建推迟到需要时。
TaskProvider
<T
>
register
(String
名称、类型、配置操作)Class
<T
>
Action
<? super T
>
TaskProvider
<T
>Class
<T
>Action
<? super T
>定义一个新任务,将在需要时创建和配置。当使用查询方法(例如TaskCollection.getByName(java.lang.String)
,将任务添加到任务图中以供执行时)或Provider.get()
在该方法的返回值上调用任务
时,任务是“必需的” 。
使用此方法而不是TaskContainer.create(java.lang.String, java.lang.Class, org.gradle.api.Action)
或通常更有效TaskContainer.create(java.lang.String, java.lang.Class)
,因为这些方法将急切地创建和配置任务,无论当前构建是否需要该任务。另一方面,此方法将推迟创建和配置,直到需要为止。
TaskProvider
<Task
>
register
(String
名称、配置操作)Action
<? super Task
>
TaskProvider
<Task
>Action
<? super Task
>定义一个新任务,将在需要时创建和配置。当使用查询方法(例如TaskCollection.getByName(java.lang.String)
,将任务添加到任务图中以供执行时)或Provider.get()
在该方法的返回值上调用任务
时,任务是“必需的” 。
使用此方法而不是NamedDomainObjectContainer.create(java.lang.String, org.gradle.api.Action)
或通常更有效TaskContainer.create(java.lang.String)
,因为这些方法将急切地创建和配置任务,无论当前构建是否需要该任务。另一方面,此方法将推迟创建和配置,直到需要为止。
创建Task
具有给定名称的任务并将其添加到此容器中,替换具有相同名称的任何现有任务。
添加任务后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。