TaskContainer

目录

属性
方法
脚本块
方法详情
API 文档TaskContainer

A TaskContainer 负责管理一组 Task 实例。

您可以通过调用 Project.getTasks()，或者在构建脚本中使用 tasks 属性来获取 TaskContainer 实例。

属性

无属性

方法

方法描述
containerWithType(type)

创建一个常规容器，该容器封装了多态容器，呈现指定类型的所有元素。

create(name)
废弃 (Deprecated)

创建具有给定名称的 Task 并将其添加到此容器。

create(name, configureClosure)
废弃 (Deprecated)

创建具有给定名称的 Task 并将其添加到此容器。给定的闭包用于在任务由此方法返回之前对其进行配置。

create(name, type)
废弃 (Deprecated)

创建具有给定名称和类型的 Task，并将其添加到此容器。

create(name, type, constructorArgs)
废弃 (Deprecated)

创建具有给定名称和类型的 Task，将给定参数传递给带有 @Inject 注解的构造函数，并将其添加到此容器。传递给任务构造函数的所有值都不能为 null；否则将抛出 NullPointerException

create(name, type, configuration)
废弃 (Deprecated)

创建具有给定名称和类型的 Task，使用给定操作对其进行配置，并将其添加到此容器。

create(name, configuration)
废弃 (Deprecated)

创建具有给定名称和 DefaultTask 类型的 Task，使用给定操作对其进行配置，并将其添加到此容器。

create(options)
废弃 (Deprecated)

创建一个 Task 并将其添加到此容器。可以将创建选项的映射传递给此方法以控制任务的创建方式。以下选项可用

create(options, configureClosure)
废弃 (Deprecated)

创建一个 Task 并将其添加到此容器。可以将创建选项的映射传递给此方法以控制任务的创建方式。有关可用选项的列表，请参阅 TaskContainer.create(java.util.Map)。给定的闭包用于在任务由此方法返回之前对其进行配置。

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)

定义一个新任务，该任务将在需要时创建。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。

register(name, type)

定义一个新任务，该任务将在需要时创建。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。

register(name, type, constructorArgs)

定义一个新任务，该任务将在需要时创建，并将给定参数传递给带有 @Inject 注解的构造函数。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。传递给任务构造函数的所有值都不能为 null；否则将抛出 NullPointerException

register(name, type, configurationAction)

定义一个新任务，该任务将在需要时创建和配置。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。

register(name, configurationAction)

定义一个新任务，该任务将在需要时创建和配置。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。

replace(name)

创建具有给定名称的 Task 并将其添加到此容器，替换任何具有相同名称的现有任务。

replace(name, type)

创建具有给定名称和类型的 Task，并将其添加到此容器，替换任何具有相同名称的现有任务。

脚本块

无脚本块

方法详细信息

NamedDomainObjectContainer<U> containerWithType(Class<U> type)

创建一个常规容器，该容器封装了多态容器，呈现指定类型的所有元素。

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

Task create(String name)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建具有给定名称的 Task 并将其添加到此容器。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

Task create(String name, Closure configureClosure)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建具有给定名称的 Task 并将其添加到此容器。给定的闭包用于在任务由此方法返回之前对其进行配置。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

T create(String name, Class<T> type)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建具有给定名称和类型的 Task，并将其添加到此容器。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

T create(String name, Class<T> type, Object... constructorArgs)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建具有给定名称和类型的 Task，将给定参数传递给带有 @Inject 注解的构造函数，并将其添加到此容器。传递给任务构造函数的所有值都不能为 null；否则将抛出 NullPointerException

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

T create(String name, Class<T> type, Action<? super T> configuration)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建具有给定名称和类型的 Task，使用给定操作对其进行配置，并将其添加到此容器。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

Task create(String name, Action<? super Task> configuration)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建具有给定名称和 DefaultTask 类型的 Task，使用给定操作对其进行配置，并将其添加到此容器。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

Task create(Map<String, ?> options)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建一个 Task 并将其添加到此容器。可以将创建选项的映射传递给此方法以控制任务的创建方式。以下选项可用

<caption>允许的映射键</caption>
选项描述默认值
名称要创建的任务的名称。无。必须指定。
类型要创建的任务的类。DefaultTask
动作任务执行时要执行的闭包或 Action。请参阅 Task.doFirst(org.gradle.api.Action)。null
覆盖替换现有任务？false
依赖于任务的依赖项。有关详细信息，请参阅此处。[]
分组任务的分组。null
描述任务的描述。 null
constructorArgs传递给任务类构造函数的参数。 null

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

如果此容器中已存在具有给定名称的任务，且 overwrite 选项未设置为 true，则抛出异常。

Task create(Map<String, ?> options, Closure configureClosure)

注意：此方法已弃用，并将在 Gradle 的下一个主要版本中移除。

创建一个 Task 并将其添加到此容器。可以将创建选项的映射传递给此方法以控制任务的创建方式。有关可用选项的列表，请参阅 TaskContainer.create(java.util.Map)。给定的闭包用于在任务由此方法返回之前对其进行配置。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

Task findByPath(String path)

按路径查找任务。您可以提供任务名称、相对路径或绝对路径。相对路径相对于此容器的项目进行解释。如果不存在具有给定路径的任务，此方法将返回 null。

T getByName(String name)

按名称查找对象，如果不存在此类对象，则失败。

此操作是急切的，并将导致返回的元素被实现。

T getByName(String name, Closure configureClosure)

按名称查找对象，如果不存在此类对象，则失败。给定的配置闭包在对象由此方法返回之前针对对象执行。对象作为其委托传递给闭包。

此操作是急切的，并将导致返回的元素被实现。

T getByName(String name, Action<? super T> configureAction)

按名称查找对象，如果不存在此类对象，则失败。给定的配置操作在对象由此方法返回之前针对对象执行。

此操作是急切的，并将导致返回的元素被实现。

Task getByPath(String path)

按路径查找任务。您可以提供任务名称、相对路径或绝对路径。相对路径相对于此容器的项目进行解释。如果不存在具有给定路径的任务，此方法将抛出异常。

T maybeCreate(String name)

查找具有给定名称的项，如果不存在，则创建并将其添加到此容器。

此操作是急切的，元素在返回之前被实现。

U maybeCreate(String name, Class<U> type)

查找具有给定名称和类型的项，如果不存在，则创建并将其添加到此容器。

此操作是急切的，元素在返回之前被实现。

TaskProvider<T> named(String name)

按名称查找任务，而不触发其创建或配置，如果不存在此类对象，则失败。

TaskProvider<S> named(String name, Class<S> type)

按名称和类型查找对象，如果不存在此类对象，则失败。

此方法是惰性的，不会导致返回的元素被实现。

TaskProvider<S> named(String name, Class<S> type, Action<? super S> configurationAction)

按名称和类型查找对象，如果不存在此类对象，则失败。给定的配置操作在对象从提供者返回之前针对对象执行。

此方法是惰性的，不会导致返回的元素被实现。

TaskProvider<T> named(String name, Action<? super T> configurationAction)

按名称查找对象，如果不存在此类对象，则失败。给定的配置操作在对象从提供者返回之前针对对象执行。

此方法是惰性的，不会导致返回的元素被实现。

TaskCollection<T> named(Spec<String> nameFilter)

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

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

TaskProvider<Task> register(String name)

定义一个新任务，该任务将在需要时创建。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。

通常，使用此方法比使用 TaskContainer.create(java.lang.String) 更高效，因为后者会急切地创建任务，无论当前构建是否需要该任务。而此方法将推迟创建直到需要。

TaskProvider<T> register(String name, Class<T> type)

定义一个新任务，该任务将在需要时创建。当使用查询方法（例如 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)

定义一个新任务，该任务将在需要时创建，并将给定参数传递给带有 @Inject 注解的构造函数。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。传递给任务构造函数的所有值都不能为 null；否则将抛出 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)

定义一个新任务，该任务将在需要时创建和配置。当使用查询方法（例如 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)

定义一个新任务，该任务将在需要时创建和配置。当使用查询方法（例如 TaskCollection.getByName(java.lang.String)）定位任务时，或者当任务添加到任务执行图时，或者当此方法的返回值调用 Provider.get() 时，任务即为“必需”。

通常，使用此方法比使用 NamedDomainObjectContainer.create(java.lang.String, org.gradle.api.Action) 或 TaskContainer.create(java.lang.String) 更高效，因为后者会急切地创建和配置任务，无论当前构建是否需要该任务。而此方法将推迟创建和配置直到需要。

Task replace(String name)

创建具有给定名称的 Task 并将其添加到此容器，替换任何具有相同名称的现有任务。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。

T replace(String name, Class<T> type)

创建具有给定名称和类型的 Task，并将其添加到此容器，替换任何具有相同名称的现有任务。

添加任务后，它将作为项目的属性可用，以便您可以在构建文件中按名称引用任务。