org.gradle.api.file

Interface ConfigurableFileTree

All Superinterfaces:

org.gradle.api.tasks.AntBuilderAware, Buildable, DirectoryTree, FileCollection, FileTree, Iterable<File>, PatternFilterable

All Known Implementing Classes:

DefaultConfigurableFileTree

public interface ConfigurableFileTree
extends FileTree, DirectoryTree, PatternFilterable, Buildable

A FileTree with a single base directory, which can be configured and modified.

You can obtain a ConfigurableFileTree instance by calling Project.fileTree(java.util.Map).

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.file.FileCollection

FileCollection.AntType

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurableFileTree	builtBy(Object... tasks) Registers some tasks which build the files of this collection.
ConfigurableFileTree	from(Object dir) Specifies base directory for this file tree using the given path.
Set<Object>	getBuiltBy() Returns the set of tasks which build the files of this collection.
File	getDir() Returns the base directory of this file tree.
ConfigurableFileTree	setBuiltBy(Iterable<?> tasks) Sets the tasks which build the files of this collection.
ConfigurableFileTree	setDir(Object dir) Specifies base directory for this file tree using the given path.

Methods inherited from interface org.gradle.api.file.FileTree

getAsFileTree, matching, matching, plus, visit, visit

Methods inherited from interface org.gradle.api.file.FileCollection

add, addToAntBuilder, addToAntBuilder, asType, contains, filter, filter, getAsPath, getFiles, getSingleFile, isEmpty, minus, plus, stopExecutionIfEmpty

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.gradle.api.Buildable

getBuildDependencies

Methods inherited from interface org.gradle.api.file.DirectoryTree

getPatterns

Methods inherited from interface org.gradle.api.tasks.util.PatternFilterable

exclude, exclude, exclude, exclude, getExcludes, getIncludes, include, include, include, include, setExcludes, setIncludes

Method Detail

from

ConfigurableFileTree from(Object dir)

Specifies base directory for this file tree using the given path. The path is evaluated as for Project.file(Object).

Parameters:

dir - The base directory.

Returns:

this

getDir

File getDir()

Returns the base directory of this file tree.

Specified by:

getDir in interface DirectoryTree

Returns:

The base directory. Never returns null.

setDir

ConfigurableFileTree setDir(Object dir)

Specifies base directory for this file tree using the given path. The path is evaluated as for Project.file(Object).

Parameters:

dir - The base directory.

Returns:

this

getBuiltBy

Set<Object> getBuiltBy()

Returns the set of tasks which build the files of this collection.

Returns:

The set. Returns an empty set when there are no such tasks.

setBuiltBy

ConfigurableFileTree setBuiltBy(Iterable<?> tasks)

Sets the tasks which build the files of this collection.

Parameters:

tasks - The tasks. These are evaluated as for Task.dependsOn(Object...).

Returns:

this

builtBy

ConfigurableFileTree builtBy(Object... tasks)

Registers some tasks which build the files of this collection.

Parameters:

tasks - The tasks. These are evaluated as for Task.dependsOn(Object...).

Returns:

this