TaskProvider (grolifant 0.17.0 API)

org.ysb33r.grolifant.api.TaskProvider

Utilities dealing with the creating of tasks allowing for lazy creation of tasks on Gradle 4.9+, but still use the standard Gradle TaskContainer.create API methods for earlier versions. In this way plugin authors can maintain compatibility back to older versions of Gradle that does not have lazy creation.
deprecated:
Use{@Link org.ysb33r.grolifant.api.v4.TaskProvider} instead.

Since:
0.11

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`configureByName(Project project, String name, Action<? super Task> configurator)` Configures a task by name.
	`static void`	`configureByName(Project project, String name, groovy.lang.Closure configurator)` Configures a task by name.
	`static TaskProvider<DefaultTask>`	`registerTask(Project project, String name)` Depending on the version of Gradle creates or registers a new task.
`<T extends Task>`	`static TaskProvider<T>`	`registerTask(Project project, String name, Class<T> type)` Depending on the version of Gradle creates or registers a new task.
`<T extends Task>`	`static TaskProvider<T>`	`registerTask(Project project, String name, Class<T> type, groovy.lang.Closure cfg)` Depending on the version of Gradle creates or registers a new task.
`<T extends Task>`	`static TaskProvider<T>`	`registerTask(Project project, String name, Class<T> type, Action<? extends Task> cfg)` Depending on the version of Gradle creates or registers a new task.
`<T extends Task>`	`static TaskProvider<T>`	`registerTask(Project project, String name, Class<T> type, Object... args)` Depending on the version of Gradle creates or registers a new task.
	`static TaskProvider`	`taskByName(Project project, String name)` Finds a task on the given project by name
`<T>`	`static TaskProvider<? extends Task>`	`taskByTypeAndName(Project project, Class type, String name)` Finds a task by both type and name

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class TaskProvider`	`configure, configure, configureByName, configureByName, configureEach, get, getName, registerTask, registerTask, registerTask, registerTask, registerTask, taskByName, taskByTypeAndName`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - static void configureByName(Project project, String name, Action<? super Task> configurator)
    
    Configures a task by name. Depending on the version on Gradle this can be done in a lazy manner.
    Parameters:
    project - Project the task is attached to
    name - Name of the task
    configurator - Configuration closure.
  - static void configureByName(Project project, String name, groovy.lang.Closure configurator)
    
    Configures a task by name. Depending on the version on Gradle this can be done in a lazy manner.
    Parameters:
    project - Project the task is attached to
    name - Name of the task
    configurator - Configuration closure.
  - static TaskProvider<DefaultTask> registerTask(Project project, String name)
    
    Depending on the version of Gradle creates or registers a new task.
    Parameters:
    project - Project to attach task to.
    name - Name of task to register.
    Returns:
    Task provider proxy.
  - <T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type)
    
    Depending on the version of Gradle creates or registers a new task.
    Parameters:
    project - Project to attach task to.
    name - Name of task to register.
    type - Task type.
    Returns:
    Task provider proxy.
  - <T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type, @groovy.lang.DelegatesTo(strategy = DELEGATE_FIRST, type = 'T') groovy.lang.Closure cfg)
    
    Depending on the version of Gradle creates or registers a new task.
    Parameters:
    project - Project to attach task to.
    name - Name of task to register.
    type - Task type.
    cfg - Configuration closure.
    Returns:
    Task provider proxy.
  - <T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type, Action<? extends Task> cfg)
    
    Depending on the version of Gradle creates or registers a new task.
    Parameters:
    project - Project to attach task to.
    name - Name of task to register.
    type - Task type.
    action - Configuration action.
    Returns:
    Task provider proxy.
  - <T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type, Object... args)
    
    Depending on the version of Gradle creates or registers a new task.
    Parameters:
    project - Project to attach task to.
    name - Name of task to register.
    type - Task type.
    args - Task constructor arguments.
    Returns:
    Task provider proxy.
  - static TaskProvider taskByName(Project project, String name)
    
    Finds a task on the given project by name
    Parameters:
    project - Project to query.
    name - Name of task.
    Returns:
    A task provider proxy.
  - <T> static TaskProvider<? extends Task> taskByTypeAndName(Project project, Class type, String name)
    
    Finds a task by both type and name
    Parameters:
    project - Project to query
    type - Types to restrict query to.
    name - Name of task.
    Returns:
    A task provider proxy.

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class TaskProvider<T extends Task>

Methods Summary

Inherited Methods Summary

Method Detail

static void configureByName(Project project, String name, Action<? super Task> configurator)

static void configureByName(Project project, String name, groovy.lang.Closure configurator)

static TaskProvider<DefaultTask> registerTask(Project project, String name)

<T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type)

<T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type, @groovy.lang.DelegatesTo(strategy = DELEGATE_FIRST, type = 'T') groovy.lang.Closure cfg)

<T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type, Action<? extends Task> cfg)

<T extends Task> static TaskProvider<T> registerTask(Project project, String name, Class<T> type, Object... args)

static TaskProvider taskByName(Project project, String name)

<T> static TaskProvider<? extends Task> taskByTypeAndName(Project project, Class type, String name)