Package org.gradle.api.tasks

Interface TaskContainer

All Superinterfaces:
Collection<Task>, org.gradle.util.Configurable<NamedDomainObjectContainer<Task>>, DomainObjectCollection<Task>, Iterable<Task>, NamedDomainObjectCollection<Task>, NamedDomainObjectContainer<Task>, NamedDomainObjectSet<Task>, PolymorphicDomainObjectContainer<Task>, Set<Task>, TaskCollection<Task>
public interface TaskContainer extends TaskCollection<Task>, PolymorphicDomainObjectContainer<Task>

A TaskContainer is responsible for managing a set of Task instances.

You can obtain a TaskContainer instance by calling Project.getTasks(), or using the tasks property in your build script.

  • Method Details

    • findByPath

      @Nullable Task findByPath(String path)

      Locates a task by path. You can supply a task name, a relative path, or an absolute path. Relative paths are interpreted relative to the project for this container. This method returns null if no task with the given path exists.

      Parameters:
      path - the path of the task to be returned
      Returns:
      The task. Returns null if so such task exists.

    • getByPath

      Task getByPath(String path) throws UnknownTaskException

      Locates a task by path. You can supply a task name, a relative path, or an absolute path. Relative paths are interpreted relative to the project for this container. This method throws an exception if no task with the given path exists.

      Parameters:
      path - the path of the task to be returned
      Returns:
      The task. Never returns null
      Throws:
      UnknownTaskException - If no task with the given path exists.

    • create

      Task create(Map<String,?> options) throws InvalidUserDataException

      Creates a Task and adds it to this container. A map of creation options can be passed to this method to control how the task is created. The following options are available:

      OptionDescriptionDefault Value
      "name"The name of the task to create.None. Must be specified.
      "type"The class of the task to create.DefaultTask
      "action"The closure or Action to execute when the task executes. See Task.doFirst(Action).null
      "overwrite"Replace an existing task?false
      "dependsOn"The dependencies of the task. See here for more details.[]
      "group"The group of the task.null
      "description"The description of the task. null

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      If a task with the given name already exists in this container and the "overwrite" option is not set to true, an exception is thrown.

      Parameters:
      options - The task creation options.
      Returns:
      The newly created task object
      Throws:
      InvalidUserDataException - If a task with the given name already exists in this project.

    • create

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

      Creates a Task adds it to this container. A map of creation options can be passed to this method to control how the task is created. See create(java.util.Map) for the list of options available. The given closure is used to configure the task before it is returned by this method.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Parameters:
      options - The task creation options.
      configureClosure - The closure to use to configure the task.
      Returns:
      The newly created task object
      Throws:
      InvalidUserDataException - If a task with the given name already exists in this project.

    • create

      Task create(String name, Closure configureClosure) throws InvalidUserDataException

      Creates a Task with the given name adds it to this container. The given closure is used to configure the task before it is returned by this method.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Specified by:
      create in interface NamedDomainObjectContainer<Task>
      Parameters:
      name - The name of the task to be created
      configureClosure - The closure to use to configure the task.
      Returns:
      The newly created task object
      Throws:
      InvalidUserDataException - If a task with the given name already exists in this project.

    • create

      Task create(String name) throws InvalidUserDataException

      Creates a Task with the given name and adds it to this container.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Specified by:
      create in interface NamedDomainObjectContainer<Task>
      Parameters:
      name - The name of the task to be created
      Returns:
      The newly created task object
      Throws:
      InvalidUserDataException - If a task with the given name already exists in this project.

    • create

      <T extends Task> T create(String name, Class<T> type) throws InvalidUserDataException

      Creates a Task with the given name and type, and adds it to this container.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Specified by:
      create in interface PolymorphicDomainObjectContainer<Task>
      Type Parameters:
      T - the type of the domain object to be created
      Parameters:
      name - The name of the task to be created.
      type - The type of task to create.
      Returns:
      The newly created task object
      Throws:
      InvalidUserDataException - If a task with the given name already exists in this project.

    • create

      <T extends Task> T create(String name, Class<T> type, Action<? super T> configuration) throws InvalidUserDataException

      Creates a Task with the given name and type, configures it with the given action, and adds it to this container.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Specified by:
      create in interface PolymorphicDomainObjectContainer<Task>
      Type Parameters:
      T - the type of the domain object to be created
      Parameters:
      name - The name of the task to be created.
      type - The type of task to create.
      configuration - The action to configure the task with.
      Returns:
      The newly created task object.
      Throws:
      InvalidUserDataException - If a task with the given name already exists in this project.

    • replace

      Task replace(String name)

      Creates a Task with the given name and adds it to this container, replacing any existing task with the same name.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Parameters:
      name - The name of the task to be created
      Returns:
      The newly created task object

    • replace

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

      Creates a Task with the given name and type, and adds it to this container, replacing any existing task of the same name.

      After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file. See here for more details.

      Parameters:
      name - The name of the task to be created.
      type - The type of task to create.
      Returns:
      The newly created task object