org.gradle.api.internal.file

Class AbstractFileTree

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

org.gradle.api.internal.file.AbstractFileTree

All Implemented Interfaces:

Iterable<File>, Buildable, FileCollection, FileTree, MinimalFileCollection, MinimalFileSet, org.gradle.api.tasks.AntBuilderAware

Direct Known Subclasses:

FileTreeAdapter

public abstract class AbstractFileTree
extends AbstractFileCollection
implements FileTree

Nested Class Summary

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

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
AbstractFileTree()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAsResourceCollection(Object builder, String nodeName)
FileTree	getAsFileTree() Converts this collection to a FileTree.
Map<String,File>	getAsMap()
Set<File>	getFiles() Returns the contents of this collection as a Set.
boolean	isEmpty() Returns true if this collection is empty.
FileTree	matching(Closure filterConfigClosure) Restricts the contents of this tree to those files matching the given filter.
FileTree	matching(PatternFilterable patterns) Restricts the contents of this tree to those files matching the given filter.
FileTree	plus(FileTree fileTree) Returns a FileTree which contains the union of this tree and the given tree.
FileTree	visit(Closure closure) Visits the files and directories in this file tree.
protected boolean	visitAll() Visits all the files of this tree.

Methods inherited from class org.gradle.api.internal.file.AbstractFileCollection

add, addAsFileSet, addAsMatchingTask, addToAntBuilder, addToAntBuilder, asType, contains, filter, filter, getAsFileTrees, getAsPath, getBuildDependencies, getCapDisplayName, getDisplayName, getSingleFile, iterator, minus, plus, stopExecutionIfEmpty, toString

Methods inherited from class java.lang.Object

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

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

visit

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

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

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.gradle.api.Buildable

getBuildDependencies

Constructor Detail

AbstractFileTree

public AbstractFileTree()

Method Detail

getFiles

public Set<File> getFiles()

Description copied from interface: FileCollection

Returns the contents of this collection as a Set.

Specified by:

getFiles in interface FileCollection

Specified by:

getFiles in interface MinimalFileSet

Returns:

The files. Returns an empty set if this collection is empty.

isEmpty

public boolean isEmpty()

Description copied from interface: FileCollection

Returns true if this collection is empty. Generally, calling this method is more efficient than calling getFiles().isEmpty().

Specified by:

isEmpty in interface FileCollection

Overrides:

isEmpty in class AbstractFileCollection

Returns:

true if this collection is empty, false otherwise.

matching

public FileTree matching(Closure filterConfigClosure)

Description copied from interface: FileTree

Restricts 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 PatternFilterable is passed to the closure as it's 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.

Specified by:

matching in interface FileTree

Parameters:

filterConfigClosure - the closure to use to configure the filter.

Returns:

The filtered tree.

matching

public FileTree matching(PatternFilterable patterns)

Description copied from interface: FileTree

Restricts 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.

Specified by:

matching in interface FileTree

Parameters:

patterns - the pattern set to use to configure the filter.

Returns:

The filtered tree.

getAsMap

public Map<String,File> getAsMap()

addAsResourceCollection

protected void addAsResourceCollection(Object builder,
                           String nodeName)

Overrides:

addAsResourceCollection in class AbstractFileCollection

visitAll

protected boolean visitAll()

Visits all the files of this tree.

getAsFileTree

public FileTree getAsFileTree()

Description copied from interface: FileCollection

Converts this collection to a FileTree. Generally, for each file in this collection, the resulting file tree will contain the source file at the root of the tree. For each directory in this collection, the resulting file tree will contain all the files under the source directory.

Specified by:

getAsFileTree in interface FileCollection

Specified by:

getAsFileTree in interface FileTree

Overrides:

getAsFileTree in class AbstractFileCollection

Returns:

this collection as a FileTree. Never returns null.

plus

public FileTree plus(FileTree fileTree)

Description copied from interface: FileTree

Returns a FileTree which 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.

Specified by:

plus in interface FileTree

Parameters:

fileTree - The tree. Should not be null.

Returns:

The union of this tree and the given tree.

visit

public FileTree visit(Closure closure)

Description copied from interface: FileTree

Visits the files and directories in this file tree. Files are visited in breadth-wise order, so that a directory is visited before its children. The file/directory to be visited is passed to the given closure as a FileVisitDetails

Specified by:

visit in interface FileTree

Parameters:

closure - The visitor.

Returns:

this