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