org.gradle.api.internal.file.collections

Class DefaultConfigurableFileTree

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

org.gradle.api.internal.file.CompositeFileCollection

org.gradle.api.internal.file.CompositeFileTree

org.gradle.api.internal.file.collections.DefaultConfigurableFileTree

All Implemented Interfaces:

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

public class DefaultConfigurableFileTree
extends CompositeFileTree
implements ConfigurableFileTree

Author:

Hans Dockter

Nested Class Summary

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

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurableFileTree(Map<String,?> args, FileResolver resolver, TaskResolver taskResolver)
DefaultConfigurableFileTree(Object dir, FileResolver resolver, TaskResolver taskResolver)

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurableFileTree	builtBy(Object... tasks) Registers some tasks which build the files of this collection.
WorkResult	copy(Closure closure)
DefaultConfigurableFileTree	exclude(Closure excludeSpec) Adds an exclude spec.
DefaultConfigurableFileTree	exclude(Iterable<String> excludes) Adds an ANT style exclude pattern.
DefaultConfigurableFileTree	exclude(Spec<FileTreeElement> excludeSpec) Adds an exclude spec.
DefaultConfigurableFileTree	exclude(String... excludes) Adds an ANT style exclude pattern.
DefaultConfigurableFileTree	from(Object dir) Specifies base directory for this file tree using the given path.
TaskDependency	getBuildDependencies() Returns a dependency which contains the tasks which build this artifact.
Set<Object>	getBuiltBy() Returns the set of tasks which build the files of this collection.
File	getDir() Returns the base directory of this file tree.
String	getDisplayName() Returns the display name of this file collection.
Set<String>	getExcludes() Returns the set of exclude patterns.
Set<String>	getIncludes() Returns the set of include patterns.
org.gradle.api.tasks.util.PatternSet	getPatterns() Returns the patterns which select the files under the base directory.
DefaultConfigurableFileTree	include(Closure includeSpec) Adds an include spec.
DefaultConfigurableFileTree	include(Iterable<String> includes) Adds an ANT style include pattern.
DefaultConfigurableFileTree	include(Spec<FileTreeElement> includeSpec) Adds an include spec.
DefaultConfigurableFileTree	include(String... includes) Adds an ANT style include pattern.
void	resolve(FileCollectionResolveContext context) Adds the contents of this container to the given context.
ConfigurableFileTree	setBuiltBy(Iterable<?> tasks) Sets the tasks which build the files of this collection.
DefaultConfigurableFileTree	setDir(Object dir) Specifies base directory for this file tree using the given path.
DefaultConfigurableFileTree	setExcludes(Iterable<String> excludes) Set the allowable exclude patterns.
DefaultConfigurableFileTree	setIncludes(Iterable<String> includes) Set the allowable include patterns.

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

getAsFileTree, getSourceCollections, matching, matching, plus, visit, visit

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

addAsResourceCollection, addDependencies, contains, filter, getAsFileTrees, getFiles, isEmpty

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

add, addAsFileSet, addAsMatchingTask, addToAntBuilder, addToAntBuilder, asType, 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.FileTree

getAsFileTree, matching, matching, plus, visit, visit

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

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

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

DefaultConfigurableFileTree

public DefaultConfigurableFileTree(Object dir,
                           FileResolver resolver,
                           TaskResolver taskResolver)

DefaultConfigurableFileTree

public DefaultConfigurableFileTree(Map<String,?> args,
                           FileResolver resolver,
                           TaskResolver taskResolver)

Method Detail

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.

setDir

public DefaultConfigurableFileTree setDir(Object dir)

Description copied from interface: ConfigurableFileTree

Specifies base directory for this file tree using the given path. The path is evaluated as for Project.file(Object).

Specified by:

setDir in interface ConfigurableFileTree

Parameters:

dir - The base directory.

Returns:

this

getDir

public File getDir()

Description copied from interface: ConfigurableFileTree

Returns the base directory of this file tree.

Specified by:

getDir in interface ConfigurableFileTree

Specified by:

getDir in interface DirectoryTree

Returns:

The base directory. Never returns null.

from

public DefaultConfigurableFileTree from(Object dir)

Description copied from interface: ConfigurableFileTree

Specifies base directory for this file tree using the given path. The path is evaluated as for Project.file(Object).

Specified by:

from in interface ConfigurableFileTree

Parameters:

dir - The base directory.

Returns:

this

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

copy

public WorkResult copy(Closure closure)

getIncludes

public Set<String> getIncludes()

Description copied from interface: PatternFilterable

Returns the set of include patterns.

Specified by:

getIncludes in interface PatternFilterable

Returns:

The include patterns. Returns an empty set when there are no include patterns.

setIncludes

public DefaultConfigurableFileTree setIncludes(Iterable<String> includes)

Description copied from interface: PatternFilterable

Set the allowable include patterns. Note that unlike PatternFilterable.include(Iterable) this replaces any previously defined includes.

Specified by:

setIncludes in interface PatternFilterable

Parameters:

includes - an Iterable providing new include patterns

Returns:

this

See Also:

Pattern Format

getExcludes

public Set<String> getExcludes()

Description copied from interface: PatternFilterable

Returns the set of exclude patterns.

Specified by:

getExcludes in interface PatternFilterable

Returns:

The exclude patterns. Returns an empty set when there are no exclude patterns.

setExcludes

public DefaultConfigurableFileTree setExcludes(Iterable<String> excludes)

Description copied from interface: PatternFilterable

Set the allowable exclude patterns. Note that unlike PatternFilterable.exclude(Iterable) this replaces any previously defined excludes.

Specified by:

setExcludes in interface PatternFilterable

Parameters:

excludes - an Iterable providing new exclude patterns

Returns:

this

See Also:

Pattern Format

include

public DefaultConfigurableFileTree include(String... includes)

Description copied from interface: PatternFilterable

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.

Specified by:

include in interface PatternFilterable

Parameters:

includes - a vararg list of include patterns

Returns:

this

See Also:

Pattern Format

include

public DefaultConfigurableFileTree include(Iterable<String> includes)

Description copied from interface: PatternFilterable

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.

Specified by:

include in interface PatternFilterable

Parameters:

includes - a Iterable providing more include patterns

Returns:

this

See Also:

Pattern Format

include

public DefaultConfigurableFileTree include(Closure includeSpec)

Description copied from interface: PatternFilterable

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a FileTreeElement as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

Specified by:

include in interface PatternFilterable

Parameters:

includeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

include

public DefaultConfigurableFileTree include(Spec<FileTreeElement> includeSpec)

Description copied from interface: PatternFilterable

Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

Specified by:

include in interface PatternFilterable

Parameters:

includeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

exclude

public DefaultConfigurableFileTree exclude(String... excludes)

Description copied from interface: PatternFilterable

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Specified by:

exclude in interface PatternFilterable

Parameters:

excludes - a vararg list of exclude patterns

Returns:

this

See Also:

Pattern Format

exclude

public DefaultConfigurableFileTree exclude(Iterable<String> excludes)

Description copied from interface: PatternFilterable

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Specified by:

exclude in interface PatternFilterable

Parameters:

excludes - a Iterable providing new exclude patterns

Returns:

this

See Also:

Pattern Format

exclude

public DefaultConfigurableFileTree exclude(Spec<FileTreeElement> excludeSpec)

Description copied from interface: PatternFilterable

Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Specified by:

exclude in interface PatternFilterable

Parameters:

excludeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

exclude

public DefaultConfigurableFileTree exclude(Closure excludeSpec)

Description copied from interface: PatternFilterable

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a FileTreeElement as its parameter. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Specified by:

exclude in interface PatternFilterable

Parameters:

excludeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

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

Specified by:

resolve in class CompositeFileCollection

builtBy

public ConfigurableFileTree builtBy(Object... tasks)

Description copied from interface: ConfigurableFileTree

Registers some tasks which build the files of this collection.

Specified by:

builtBy in interface ConfigurableFileTree

Parameters:

tasks - The tasks. These are evaluated as for Task.dependsOn(Object...).

Returns:

this

getBuiltBy

public Set<Object> getBuiltBy()

Description copied from interface: ConfigurableFileTree

Returns the set of tasks which build the files of this collection.

Specified by:

getBuiltBy in interface ConfigurableFileTree

Returns:

The set. Returns an empty set when there are no such tasks.

setBuiltBy

public ConfigurableFileTree setBuiltBy(Iterable<?> tasks)

Description copied from interface: ConfigurableFileTree

Sets the tasks which build the files of this collection.

Specified by:

setBuiltBy in interface ConfigurableFileTree

Parameters:

tasks - The tasks. These are evaluated as for Task.dependsOn(Object...).

Returns:

this

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 CompositeFileCollection

Returns:

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