Package org.gradle.api.file
Interface ConfigurableFileTree
-
- All Superinterfaces:
AntBuilderAware,Buildable,DirectoryTree,FileCollection,FileTree,java.lang.Iterable<java.io.File>,PatternFilterable
public interface ConfigurableFileTree extends FileTree, DirectoryTree, PatternFilterable, Buildable
A
FileTreewith a single base directory, which can be configured and modified.You can obtain a
ConfigurableFileTreeinstance by callingProject.fileTree(java.util.Map).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.file.FileCollection
FileCollection.AntType
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConfigurableFileTreebuiltBy(java.lang.Object... tasks)Registers some tasks which build the files of this collection.ConfigurableFileTreefrom(java.lang.Object dir)Specifies base directory for this file tree using the given path.java.util.Set<java.lang.Object>getBuiltBy()Returns the set of tasks which build the files of this collection.java.io.FilegetDir()Returns the base directory of this file tree.ConfigurableFileTreesetBuiltBy(java.lang.Iterable<?> tasks)Sets the tasks which build the files of this collection.ConfigurableFileTreesetDir(java.lang.Object dir)Specifies base directory for this file tree using the given path.-
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.file.FileCollection
addToAntBuilder, addToAntBuilder, contains, filter, filter, getAsPath, getElements, getSingleFile, isEmpty, minus, plus
-
Methods inherited from interface org.gradle.api.file.FileTree
getAsFileTree, getFiles, matching, matching, matching, plus, visit, visit, visit
-
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(java.lang.Object dir)
Specifies base directory for this file tree using the given path. The path is evaluated as perProject.file(Object).- Parameters:
dir- The base directory.- Returns:
- this
-
getDir
java.io.File getDir()
Returns the base directory of this file tree.- Specified by:
getDirin interfaceDirectoryTree- Returns:
- The base directory. Never returns null.
-
setDir
ConfigurableFileTree setDir(java.lang.Object dir)
Specifies base directory for this file tree using the given path. The path is evaluated as perProject.file(Object).- Parameters:
dir- The base directory.- Returns:
- this
-
getBuiltBy
java.util.Set<java.lang.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(java.lang.Iterable<?> tasks)
Sets the tasks which build the files of this collection.- Parameters:
tasks- The tasks. These are evaluated as perTask.dependsOn(Object...).- Returns:
- this
-
builtBy
ConfigurableFileTree builtBy(java.lang.Object... tasks)
Registers some tasks which build the files of this collection.- Parameters:
tasks- The tasks. These are evaluated as perTask.dependsOn(Object...).- Returns:
- this
-
-