org.gradle.api.internal.tasks

Class DefaultTaskInputs

java.lang.Object

org.gradle.api.internal.tasks.DefaultTaskInputs

All Implemented Interfaces:

TaskInputs

public class DefaultTaskInputs
extends Object
implements TaskInputs

Constructor Summary

Constructors

Constructor and Description
DefaultTaskInputs(FileResolver resolver, TaskInternal task)

Method Summary

Methods

Modifier and Type	Method and Description
TaskInputs	dir(Object dirPath) Registers an input directory hierarchy.
TaskInputs	file(Object path) Registers some input file for this task.
TaskInputs	files(Object... paths) Registers some input files for this task.
FileCollection	getFiles() Returns the input files of this task.
boolean	getHasInputs() Returns true if this task has declared the inputs that it consumes.
boolean	getHasSourceFiles() Returns true if this task has declared that it accepts source files.
Map<String,Object>	getProperties() Returns the set of input properties for this task.
FileCollection	getSourceFiles() Returns the set of source files for this task.
TaskInputs	properties(Map<String,?> properties) Registers a set of input properties for this task.
TaskInputs	property(String name, Object value) Registers an input property for this task.
TaskInputs	source(Object... paths) Registers some source files for this task.
TaskInputs	source(Object path) Registers some source files for this task.
TaskInputs	sourceDir(Object path) Registers a source directory for this task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTaskInputs

public DefaultTaskInputs(FileResolver resolver,
                 TaskInternal task)

Method Detail

getHasInputs

public boolean getHasInputs()

Description copied from interface: TaskInputs

Returns true if this task has declared the inputs that it consumes.

Specified by:

getHasInputs in interface TaskInputs

Returns:

true if this task has declared any inputs.

getFiles

public FileCollection getFiles()

Description copied from interface: TaskInputs

Returns the input files of this task.

Specified by:

getFiles in interface TaskInputs

Returns:

The input files. Returns an empty collection if this task has no input files.

files

public TaskInputs files(Object... paths)

Description copied from interface: TaskInputs

Registers some input files for this task.

Specified by:

files in interface TaskInputs

Parameters:

paths - The input files. The given paths are evaluated as for Project.files(Object...).

Returns:

this

file

public TaskInputs file(Object path)

Description copied from interface: TaskInputs

Registers some input file for this task.

Specified by:

file in interface TaskInputs

Parameters:

path - The input file. The given path is evaluated as for Project.files(Object...).

Returns:

this

dir

public TaskInputs dir(Object dirPath)

Description copied from interface: TaskInputs

Registers an input directory hierarchy. All files found under the given directory are treated as input files for this task.

Specified by:

dir in interface TaskInputs

Parameters:

dirPath - The directory. The path is evaluated as for Project.file(Object).

Returns:

this

getHasSourceFiles

public boolean getHasSourceFiles()

Description copied from interface: TaskInputs

Returns true if this task has declared that it accepts source files.

Specified by:

getHasSourceFiles in interface TaskInputs

Returns:

true if this task has source files, false if not.

getSourceFiles

public FileCollection getSourceFiles()

Description copied from interface: TaskInputs

Returns the set of source files for this task. These are the subset of input files which the task actually does work on. A task is skipped if it has declared it accepts source files, and this collection is empty.

Specified by:

getSourceFiles in interface TaskInputs

Returns:

The set of source files for this task.

source

public TaskInputs source(Object... paths)

Description copied from interface: TaskInputs

Registers some source files for this task. Note that source files are also considered input files, so calling this method implies a call to TaskInputs.files(Object...).

Specified by:

source in interface TaskInputs

Parameters:

paths - The paths. These are evaluated as for Project.files(Object...).

Returns:

this

source

public TaskInputs source(Object path)

Description copied from interface: TaskInputs

Registers some source files for this task. Note that source files are also considered input files, so calling this method implies a call to TaskInputs.files(Object...).

Specified by:

source in interface TaskInputs

Parameters:

path - The path. This is evaluated as for Project.files(Object...).

Returns:

this

sourceDir

public TaskInputs sourceDir(Object path)

Description copied from interface: TaskInputs

Registers a source directory for this task. All files under this directory are treated as source files for this task. Note that source files are also considered input files, so calling this method implies a call to TaskInputs.dir(Object).

Specified by:

sourceDir in interface TaskInputs

Parameters:

path - The path. This is evaluated as for Project.file(Object).

Returns:

this

getProperties

public Map<String,Object> getProperties()

Description copied from interface: TaskInputs

Returns the set of input properties for this task.

Specified by:

getProperties in interface TaskInputs

Returns:

The properties.

property

public TaskInputs property(String name,
                  Object value)

Description copied from interface: TaskInputs

Registers an input property for this task. This value is persisted when the task executes, and is compared against the property value for later invocations of the task, to determine if the task is up-to-date.

The given value for the property must be Serializable, so that it can be persisted. It should also provide a useful equals() method.

You can specify a closure or Callable as the value of the property. In which case, the closure or Callable is executed to determine the actual property value.

Specified by:

property in interface TaskInputs

Parameters:

name - The name of the property. Must not be null.

value - The value for the property. Can be null.

properties

public TaskInputs properties(Map<String,?> properties)

Description copied from interface: TaskInputs

Registers a set of input properties for this task. See TaskInputs.property(String, Object) for details.

Specified by:

properties in interface TaskInputs

Parameters:

properties - The properties.