org.gradle.api.internal.file.collections

Class DirectoryFileTree

java.lang.Object

org.gradle.api.internal.file.collections.DirectoryFileTree

All Implemented Interfaces:

DirectoryTree, LocalFileTree, MinimalFileCollection, MinimalFileTree, PatternFilterableFileTree, RandomAccessFileCollection

public class DirectoryFileTree
extends java.lang.Object
implements MinimalFileTree, PatternFilterableFileTree, RandomAccessFileCollection, LocalFileTree, DirectoryTree

Directory walker supporting Specs for includes and excludes. The file system is traversed breadth first - all files in a directory will be visited before any child directory is visited. A file or directory will only be visited if it matches all includes and no excludes.

Author:

Steve Appling

Constructor Summary

Constructors

Constructor and Description
DirectoryFileTree(java.io.File dir)
DirectoryFileTree(java.io.File dir, org.gradle.api.tasks.util.PatternSet patternSet)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(java.io.File file)
DirectoryFileTree	depthFirst()
DirectoryFileTree	filter(PatternFilterable patterns)
java.io.File	getDir() Returns the base directory of this tree.
java.lang.String	getDisplayName()
java.util.Collection<DirectoryFileTree>	getLocalContents()
org.gradle.api.tasks.util.PatternSet	getPatterns() Returns the patterns which select the files under the base directory.
java.lang.String	toString()
void	visit(FileVisitor visitor) Process the specified file or directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryFileTree

public DirectoryFileTree(java.io.File dir)

DirectoryFileTree

public DirectoryFileTree(java.io.File dir,
                 org.gradle.api.tasks.util.PatternSet patternSet)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface MinimalFileCollection

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPatterns

public org.gradle.api.tasks.util.PatternSet getPatterns()

Description copied from interface: DirectoryTree

Returns the patterns which select the files under the base directory.

Specified by:

getPatterns in interface DirectoryTree

Returns:

The patterns, never returns null.

getDir

public java.io.File getDir()

Description copied from interface: DirectoryTree

Returns the base directory of this tree.

Specified by:

getDir in interface DirectoryTree

Returns:

The base dir, never returns null.

getLocalContents

public java.util.Collection<DirectoryFileTree> getLocalContents()

Specified by:

getLocalContents in interface LocalFileTree

filter

public DirectoryFileTree filter(PatternFilterable patterns)

Specified by:

filter in interface PatternFilterableFileTree

contains

public boolean contains(java.io.File file)

Specified by:

contains in interface RandomAccessFileCollection

visit

public void visit(FileVisitor visitor)

Process the specified file or directory. Note that the startFile parameter may be either a directory or a file. If it is a directory, then it's contents (but not the directory itself) will be checked with isAllowed and notified to the listener. If it is a file, the file will be checked and notified.

Specified by:

visit in interface MinimalFileTree

depthFirst

public DirectoryFileTree depthFirst()