org.gradle.api.internal.file.collections

Class FileTreeAdapter

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

org.gradle.api.internal.file.AbstractFileTree

org.gradle.api.internal.file.collections.FileTreeAdapter

All Implemented Interfaces:

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

public class FileTreeAdapter
extends AbstractFileTree
implements FileCollectionContainer

Adapts a MinimalFileTree into a full FileTree implementation.

Nested Class Summary

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

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
FileTreeAdapter(MinimalFileTree tree)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(File file) Determines whether this collection contains the given file.
protected Collection<DirectoryFileTree>	getAsFileTrees() Returns this collection as a set of DirectoryFileTree instances.
TaskDependency	getBuildDependencies() Returns a dependency which contains the tasks which build this artifact.
String	getDisplayName() Returns the display name of this file collection.
MinimalFileTree	getTree()
FileTree	matching(PatternFilterable patterns) Restricts the contents of this tree to those files matching the given filter.
void	resolve(FileCollectionResolveContext context) Adds the contents of this container to the given context.
FileTree	visit(FileVisitor visitor) Visits the files and directories in this file tree.

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

addAsResourceCollection, getAsFileTree, getAsMap, getFiles, isEmpty, matching, plus, visit, visitAll

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

add, addAsFileSet, addAsMatchingTask, addToAntBuilder, addToAntBuilder, asType, filter, filter, getAsPath, getCapDisplayName, 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.FileCollection

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

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

FileTreeAdapter

public FileTreeAdapter(MinimalFileTree tree)

Method Detail

getTree

public MinimalFileTree getTree()

getDisplayName

public String getDisplayName()

Description copied from class: AbstractFileCollection

Returns the display name of this file collection. Used in log and error messages.

Specified by:

getDisplayName in interface FileCollectionContainer

Specified by:

getDisplayName in interface MinimalFileCollection

Specified by:

getDisplayName in class AbstractFileCollection

Returns:

the display name

resolve

public void resolve(FileCollectionResolveContext context)

Description copied from interface: FileCollectionContainer

Adds the contents of this container to the given context.

Specified by:

resolve in interface FileCollectionContainer

getAsFileTrees

protected Collection<DirectoryFileTree> getAsFileTrees()

Description copied from class: AbstractFileCollection

Returns this collection as a set of DirectoryFileTree instances.

Overrides:

getAsFileTrees in class AbstractFileCollection

getBuildDependencies

public TaskDependency getBuildDependencies()

Description copied from interface: Buildable

Returns a dependency which contains the tasks which build this artifact. All Buildable implementations must ensure that the returned dependency object is live, so that it tracks changes to the dependencies of this buildable.

Specified by:

getBuildDependencies in interface Buildable

Overrides:

getBuildDependencies in class AbstractFileCollection

Returns:

The dependency. Never returns null. Returns an empty dependency when this artifact is not built by any tasks.

contains

public boolean contains(File file)

Description copied from interface: FileCollection

Determines whether this collection contains the given file. Generally, this method is more efficient than calling getFiles().contains(file).

Specified by:

contains in interface FileCollection

Overrides:

contains in class AbstractFileCollection

Parameters:

file - The file to check for.

Returns:

true if this collection contains the given file, false otherwise.

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

Overrides:

matching in class AbstractFileTree

Parameters:

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

Returns:

The filtered tree.

visit

public FileTree visit(FileVisitor visitor)

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.

Specified by:

visit in interface FileTree

Parameters:

visitor - The visitor.

Returns:

this