Interface FileTree
- All Superinterfaces:
- AntBuilderAware,- Buildable,- FileCollection,- Iterable<File>
- All Known Subinterfaces:
- AntlrSourceDirectorySet,- ConfigurableFileTree,- GroovySourceDirectorySet,- ScalaSourceDirectorySet,- SourceDirectorySet
A FileTree represents a hierarchy of files. It extends FileCollection to add hierarchy query and
 manipulation methods. You typically use a FileTree to represent files to copy or the contents of an
 archive.
You can obtain a FileTree instance using Project.fileTree(java.util.Map),
 Project.zipTree(Object) or Project.tarTree(Object).
 
The order of the files in a FileTree is not stable, even on a single computer.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.file.FileCollectionFileCollection.AntType
- 
Method SummaryModifier and TypeMethodDescriptionReturns this.getFiles()Returns the contents of this tree as a flattened Set.Restricts the contents of this tree to those files matching the given filter.matching(Action<? super PatternFilterable> filterConfigAction) Restricts the contents of this tree to those files matching the given filter.matching(PatternFilterable patterns) Restricts the contents of this tree to those files matching the given filter.Returns aFileTreewhich contains the union of this tree and the given tree.Visits the files and directories in this file tree.visit(Action<? super FileVisitDetails> visitor) Visits the files and directories in this file tree.visit(FileVisitor visitor) Visits the files and directories in this file tree.Methods inherited from interface org.gradle.api.BuildablegetBuildDependenciesMethods inherited from interface org.gradle.api.file.FileCollectionaddToAntBuilder, addToAntBuilder, contains, filter, filter, getAsPath, getElements, getSingleFile, isEmpty, minus, plusMethods inherited from interface java.lang.IterableforEach, iterator, spliterator
- 
Method Details- 
matchingRestricts the contents of this tree to those files matching the given filter. The filtered tree is live, so that any changes to this tree are reflected in the filtered tree. The given closure is used to configure the filter. A PatternFilterableis passed to the closure as its delegate. Only files which match the specified include patterns will be included in the filtered tree. Any files which match the specified exclude patterns will be excluded from the filtered tree.- Parameters:
- filterConfigClosure- the closure to use to configure the filter.
- Returns:
- The filtered tree.
 
- 
matchingRestricts the contents of this tree to those files matching the given filter. The filtered tree is live, so that any changes to this tree are reflected in the filtered tree. The given action is used to configure the filter. A PatternFilterableis passed to the action. Only files which match the specified include patterns will be included in the filtered tree. Any files which match the specified exclude patterns will be excluded from the filtered tree.- Parameters:
- filterConfigAction- Action to use to configure the filter.
- Returns:
- The filtered tree.
- Since:
- 3.3
 
- 
matchingRestricts the contents of this tree to those files matching the given filter. The filtered tree is live, so that any changes to this tree are reflected in the filtered tree. The given pattern set is used to configure the filter. Only files which match the specified include patterns will be included in the filtered tree. Any files which match the specified exclude patterns will be excluded from the filtered tree. - Parameters:
- patterns- the pattern set to use to configure the filter.
- Returns:
- The filtered tree.
 
- 
visitVisits the files and directories in this file tree. Files are visited in depth-first prefix order, so that a directory is visited before its children.- Parameters:
- visitor- The visitor.
- Returns:
- this
 
- 
visitVisits the files and directories in this file tree. Files are visited in depth-first prefix order, so that a directory is visited before its children. The file/directory to be visited is passed to the given closure as aFileVisitDetails- Parameters:
- visitor- The visitor.
- Returns:
- this
 
- 
visitVisits the files and directories in this file tree. Files are visited in depth-first prefix order, so that a directory is visited before its children. The file/directory to be visited is passed to the given action as aFileVisitDetails- Parameters:
- visitor- The visitor.
- Returns:
- this
 
- 
plusReturns aFileTreewhich contains the union of this tree and the given tree. The returned tree is live, so that changes to either this tree or the other source tree are reflected in the returned tree.- Parameters:
- fileTree- The tree. Should not be null.
- Returns:
- The union of this tree and the given tree.
 
- 
getAsFileTreeFileTree getAsFileTree()Returns this.- Specified by:
- getAsFileTreein interface- FileCollection
- Returns:
- this
 
- 
getFilesReturns the contents of this tree as a flattened Set.The order of the files in a FileTreeis not stable, even on a single computer.- Specified by:
- getFilesin interface- FileCollection
- Returns:
- The files. Returns an empty set if this tree is empty.
 
 
-