TaskTools (Grolifant Core API)

```
public interface TaskTools
```
Utilities for working with tasks in a consistent manner across Gradle versions.
Authors:
Schalk W. Cronjé
Since:
1.3

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`ignoreEmptyDirectories(TaskInputs inputs, Object files)` This is similar to putting both a SkipWhenEmpty and a `org.gradle.api.tasks.IgnoreEmptyDirectories` annotation on a property, but it deals with both backwards and forward compatibility around Gradle 6.8.
	`public void`	`inputFiles(TaskInputs inputs, Object files, TaskInputFileOptions options)` Configure a collection of files as a task input.
	`public void`	`inputFiles(TaskInputs inputs, Object files, PathSensitivity ps, TaskInputFileOptions options)` Configure a collection of files as a task input.
	`public void`	`named(String taskName, Action<Task> configurator)` Configures a task, preferably in a lazy-manner.
`<T extends DefaultTask>`	`public void`	`named(String taskName, Class<T> taskType, Action<T> configurator)` Configures a task, preferably in a lazy-manner.
`<T extends DefaultTask>`	`public void`	`register(String taskName, Class<T> taskType)` Configures a task, preferably in a lazy-manner.
`<T extends DefaultTask>`	`public void`	`register(String taskName, Class<T> taskType, Action<T> configurator)` Registers a task in a lazy-manner.
`<T extends DefaultTask>`	`public void`	`register(String taskName, Class<T> taskType, Iterable<Object> args, Action<T> configurator)` Registers a task in a lazy-manner.
`<T extends DefaultTask>`	`public void`	`register(String taskName, Class<T> taskType, java.util.List<Object> args)` Registers a task in a lazy-manner.
	`public Provider<? extends Task>`	`taskProviderFrom(TaskContainer tasks, ProviderFactory providerFactory, Object o)` Creates a basic task Provider instance from an object.
	`public Provider<? extends Task>`	`taskProviderFrom(Object o)` Creates a basic task Provider instance from an object.
	`public Provider<java.util.List<? extends Task>>`	`taskize(Object taskies)` Resolves a list of many objects to tasks items to a provider of tasks.
	`public Provider<java.util.List<? extends Task>>`	`taskize(Iterable<Object> taskies)` Resolves a list of many objects to tasks items to a provider of tasks.
	`public void`	`whenNamed(String taskName, Action<Task> configurator)` Adds a configuration for a task, for when a task is created.
`<T extends DefaultTask>`	`public void`	`whenNamed(String taskName, Class<T> taskType, Action<T> configurator)` Adds a configuration for a task, for when a task is created.

- Method Detail
  - public void ignoreEmptyDirectories(TaskInputs inputs, Object files)
    
    This is similar to putting both a SkipWhenEmpty and a org.gradle.api.tasks.IgnoreEmptyDirectories annotation on a property, but it deals with both backwards and forward compatibility around Gradle 6.8.
    Accepts any of the following
    - FileCollection
    - Directory
    - File as long as it points to a directory
    - ANy Provider, Supplier, Optional, Callable
    Parameters:
    inputs - Inputs for a specific task
    files - File collections
  - public void inputFiles(TaskInputs inputs, Object files, TaskInputFileOptions options)
    
    Configure a collection of files as a task input.
    Parameters:
    inputs - The inputs for a specific task.
    files - The inputs for a specific task.
    options - Various additional options to set. Some might be ignored, depending on the version of Gradle.
  - public void inputFiles(TaskInputs inputs, Object files, PathSensitivity ps, TaskInputFileOptions options)
    
    Configure a collection of files as a task input.
    Parameters:
    inputs - The inputs for a specific task.
    files - The inputs for a specific task.
    ps - The PathSensitivity of the file collection
    options - Various additional options to set. Some might be ignored, depending on the version of Gradle.
  - public void named(String taskName, Action<Task> configurator)
    
    Configures a task, preferably in a lazy-manner.
    On Gradle 4.9 or earlier it will use getByName internally.
    Parameters:
    taskName - Name of task to configure. Task must have been registered or configured previously.
    configurator - Configurating action.
  - <T extends DefaultTask> public void named(String taskName, Class<T> taskType, Action<T> configurator)
    
    Configures a task, preferably in a lazy-manner.
    On Gradle 4.9 or earlier it will use getByName internally.
    Parameters:
    taskName - Name of task to configure. Task must have been registered or configured previously.
    taskType - Type of task.
    configurator - Configurating action.
    Type Parameters:
    T - Type of task.
  - <T extends DefaultTask> public void register(String taskName, Class<T> taskType)
    
    Configures a task, preferably in a lazy-manner.
    On Gradle 4.9 or earlier it will use getByName internally.
    Parameters:
    taskName - Name of task to configure. Task must have been registered or configured previously.
    taskType - Type of task.
    Type Parameters:
    T - Type of task.
    Since:
    2.0
  - <T extends DefaultTask> public void register(String taskName, Class<T> taskType, Action<T> configurator)
    
    Registers a task in a lazy-manner.
    On Gradle 4.9 or earlier it create the task.
    Parameters:
    taskName - Name of task to register. Task must have been registered or configured previously.
    taskType - Type of task.
    configurator - Configurating action.
    Type Parameters:
    T - Type of task.
  - <T extends DefaultTask> public void register(String taskName, Class<T> taskType, Iterable<Object> args, Action<T> configurator)
    
    Registers a task in a lazy-manner.
    On Gradle 4.9 or earlier it create the task.
    Parameters:
    taskName - Name of task to register. Task must have been registered or configured previously.
    taskType - Type of task.
    args - C-tor arguments.
    configurator - Configurating action.
    Type Parameters:
    T - Type of task.
  - <T extends DefaultTask> public void register(String taskName, Class<T> taskType, java.util.List<Object> args)
    
    Registers a task in a lazy-manner.
    On Gradle 4.9 or earlier it create the task.
    Parameters:
    taskName - Name of task to register. Task must have been registered or configured previously.
    taskType - Type of task.
    args - C-tor arguments.
    Type Parameters:
    T - Type of task.
    Since:
    2.0
  - public Provider<? extends Task> taskProviderFrom(TaskContainer tasks, ProviderFactory providerFactory, Object o)
    
    Creates a basic task Provider instance from an object.
    Parameters:
    tasks - Override the task containerto use.
    providerFactory - Override the provider factory to use.
    o - Object to be evaluated to a task.
    Returns:
    Lazy-evaluatable task.
    Since:
    2.0
  - public Provider<? extends Task> taskProviderFrom(Object o)
    
    Creates a basic task Provider instance from an object.
    Parameters:
    o - Object to be evaluated to a task.
    Returns:
    Lazy-evaluatable task.
    Since:
    2.0
  - public Provider<java.util.List<? extends Task>> taskize(Object taskies)
    
    Resolves a list of many objects to tasks items to a provider of tasks.
    Parameters:
    taskies - Things that can be converted to Task or TaskProvider
    Returns:
    A provider to the list of resolved tasks.
  - public Provider<java.util.List<? extends Task>> taskize(Iterable<Object> taskies)
    
    Resolves a list of many objects to tasks items to a provider of tasks.
    Parameters:
    taskies - Things that can be converted to Task or TaskProvider
    Returns:
    A provider to the list of resolved tasks.
  - public void whenNamed(String taskName, Action<Task> configurator)
    
    Adds a configuration for a task, for when a task is created.
    Parameters:
    taskName - Name of task to configure.
    configurator - Configurating action.
  - <T extends DefaultTask> public void whenNamed(String taskName, Class<T> taskType, Action<T> configurator)
    
    Adds a configuration for a task, for when a task is created.
    Parameters:
    taskName - Name of task to configure.
    taskType - Type of task.
    configurator - Configurating action.
    Type Parameters:
    T - Type of task.

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface TaskTools

Methods Summary

Method Detail

public void ignoreEmptyDirectories(TaskInputs inputs, Object files)

public void inputFiles(TaskInputs inputs, Object files, TaskInputFileOptions options)

public void inputFiles(TaskInputs inputs, Object files, PathSensitivity ps, TaskInputFileOptions options)

public void named(String taskName, Action<Task> configurator)

<T extends DefaultTask> public void named(String taskName, Class<T> taskType, Action<T> configurator)

<T extends DefaultTask> public void register(String taskName, Class<T> taskType)

<T extends DefaultTask> public void register(String taskName, Class<T> taskType, Action<T> configurator)

<T extends DefaultTask> public void register(String taskName, Class<T> taskType, Iterable<Object> args, Action<T> configurator)

<T extends DefaultTask> public void register(String taskName, Class<T> taskType, java.util.List<Object> args)

public Provider<? extends Task> taskProviderFrom(TaskContainer tasks, ProviderFactory providerFactory, Object o)

public Provider<? extends Task> taskProviderFrom(Object o)

public Provider<java.util.List<? extends Task>> taskize(Object taskies)

public Provider<java.util.List<? extends Task>> taskize(Iterable<Object> taskies)

public void whenNamed(String taskName, Action<Task> configurator)

<T extends DefaultTask> public void whenNamed(String taskName, Class<T> taskType, Action<T> configurator)