org.gradle.api.internal.file

Class AbstractFileCollection

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFileTree, CompositeFileCollection, DefaultConfiguration, FileCollectionAdapter

public abstract class AbstractFileCollection
extends Object
implements FileCollection, MinimalFileSet

Nested Class Summary

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

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
AbstractFileCollection()

Method Summary

Methods

Modifier and Type	Method and Description
FileCollection	add(FileCollection collection) Adds another collection to this collection.
protected void	addAsFileSet(Object builder, String nodeName)
protected void	addAsMatchingTask(Object builder, String nodeName)
protected void	addAsResourceCollection(Object builder, String nodeName)
Object	addToAntBuilder(Object node, String childNodeName) Adds this collection to an Ant task as a nested node.
void	addToAntBuilder(Object builder, String nodeName, FileCollection.AntType type) Adds this collection to an Ant task as a nested node.
Object	asType(Class<?> type) Converts this collection into an object of the specified type.
boolean	contains(File file) Determines whether this collection contains the given file.
FileCollection	filter(Closure filterClosure) Restricts the contents of this collection to those files which match the given criteria.
FileCollection	filter(Spec<? super File> filterSpec) Restricts the contents of this collection to those files which match the given criteria.
FileTree	getAsFileTree() Converts this collection to a FileTree.
protected Collection<DirectoryFileTree>	getAsFileTrees() Returns this collection as a set of DirectoryFileTree instances.
String	getAsPath() Returns the contents of this collection as a platform-specific path.
TaskDependency	getBuildDependencies() Returns a dependency which contains the tasks which build this artifact.
protected String	getCapDisplayName()
abstract String	getDisplayName() Returns the display name of this file collection.
File	getSingleFile() Returns the content of this collection, asserting it contains exactly one file.
boolean	isEmpty() Returns true if this collection is empty.
Iterator<File>	iterator()
FileCollection	minus(FileCollection collection) Returns a FileCollection which contains the intersection of this collection and the given collection.
FileCollection	plus(FileCollection collection) Returns a FileCollection which contains the union of this collection and the given collection.
FileCollection	stopExecutionIfEmpty() Throws a StopExecutionException if this collection is empty.
String	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

getFiles

Methods inherited from interface org.gradle.api.internal.file.collections.MinimalFileSet

getFiles

Constructor Detail

AbstractFileCollection

public AbstractFileCollection()

Method Detail

getDisplayName

public abstract String getDisplayName()

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

Specified by:

getDisplayName in interface MinimalFileCollection

Returns:

the display name

toString

public String toString()

Overrides:

toString in class Object

getSingleFile

public File getSingleFile()
                   throws IllegalStateException

Description copied from interface: FileCollection

Returns the content of this collection, asserting it contains exactly one file.

Specified by:

getSingleFile in interface FileCollection

Returns:

The file.

Throws:

IllegalStateException - when this collection does not contain exactly one file.

iterator

public Iterator<File> iterator()

Specified by:

iterator in interface Iterable<File>

getAsPath

public String getAsPath()

Description copied from interface: FileCollection

Returns the contents of this collection as a platform-specific path. This can be used, for example, in an Ant element.

Specified by:

getAsPath in interface FileCollection

Returns:

The path. Returns an empty string if this collection is empty.

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

Parameters:

file - The file to check for.

Returns:

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

plus

public FileCollection plus(FileCollection collection)

Description copied from interface: FileCollection

Returns a FileCollection which contains the union of this collection and the given collection. The returned collection is live, and tracks changes to both source collections.

You can call this method in your build script using the + operator.

Specified by:

plus in interface FileCollection

Parameters:

collection - The other collection. Should not be null.

Returns:

A new collection containing the union.

minus

public FileCollection minus(FileCollection collection)

Description copied from interface: FileCollection

Returns a FileCollection which contains the intersection of this collection and the given collection. The returned collection is live, and tracks changes to both source collections.

You can call this method in your build script using the - operator.

Specified by:

minus in interface FileCollection

Parameters:

collection - The other collection. Should not be null.

Returns:

A new collection containing the intersection.

add

public FileCollection add(FileCollection collection)
                   throws UnsupportedOperationException

Description copied from interface: FileCollection

Adds another collection to this collection. This is an optional operation.

Specified by:

add in interface FileCollection

Parameters:

collection - The collection to add.

Returns:

This

Throws:

UnsupportedOperationException - When this collection does not allow modification.

addToAntBuilder

public void addToAntBuilder(Object builder,
                   String nodeName,
                   FileCollection.AntType type)

Description copied from interface: FileCollection

Adds this collection to an Ant task as a nested node. The given type determines how this collection is added:

• FileCollection.AntType.MatchingTask: adds this collection to an Ant MatchingTask. The collection is converted to a set of source directories and include and exclude patterns. The source directories as added as an Ant Path with the given node name. The patterns are added using 'include' and 'exclude' nodes.
• FileCollection.AntType.FileSet: adds this collection as zero or more Ant FileSets with the given node name.
• FileCollection.AntType.ResourceCollection: adds this collection as zero or more Ant ResourceCollections with the given node name.

You should prefer using FileCollection.AntType.ResourceCollection, if the target Ant task supports it, as this is generally the most efficient. Using the other types may involve copying the contents of this collection to a temporary directory.

Specified by:

addToAntBuilder in interface FileCollection

Parameters:

builder - The builder to add this collection to.

nodeName - The target node name.

type - The target Ant type

addAsMatchingTask

protected void addAsMatchingTask(Object builder,
                     String nodeName)

addAsFileSet

protected void addAsFileSet(Object builder,
                String nodeName)

addAsResourceCollection

protected void addAsResourceCollection(Object builder,
                           String nodeName)

getAsFileTrees

protected Collection<DirectoryFileTree> getAsFileTrees()

Returns this collection as a set of DirectoryFileTree instances.

addToAntBuilder

public Object addToAntBuilder(Object node,
                     String childNodeName)

Description copied from interface: FileCollection

Adds this collection to an Ant task as a nested node. Equivalent to calling addToAntBuilder(builder, nodeName,AntType.ResourceCollection).

Specified by:

addToAntBuilder in interface FileCollection

Specified by:

addToAntBuilder in interface org.gradle.api.tasks.AntBuilderAware

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

Returns:

true if this collection is empty, false otherwise.

stopExecutionIfEmpty

public FileCollection stopExecutionIfEmpty()

Description copied from interface: FileCollection

Throws a StopExecutionException if this collection is empty.

Specified by:

stopExecutionIfEmpty in interface FileCollection

Returns:

this

asType

public Object asType(Class<?> type)
              throws UnsupportedOperationException

Description copied from interface: FileCollection

Converts this collection into an object of the specified type. Supported types are: Collection, List, Set, Object[], File[], File, and FileTree.

You can call this method in your build script using the as operator.

Specified by:

asType in interface FileCollection

Parameters:

type - The type to convert to.

Returns:

The converted value.

Throws:

UnsupportedOperationException - When an unsupported type is specified.

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

Returns:

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

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

Returns:

this collection as a FileTree. Never returns null.

filter

public FileCollection filter(Closure filterClosure)

Description copied from interface: FileCollection

Restricts the contents of this collection to those files which match the given criteria. The filtered collection is live, so that it reflects any changes to this collection.

The given closure is passed the File as a parameter, and should return a boolean value.

Specified by:

filter in interface FileCollection

Parameters:

filterClosure - The closure to use to select the contents of the filtered collection.

Returns:

The filtered collection.

filter

public FileCollection filter(Spec<? super File> filterSpec)

Description copied from interface: FileCollection

Restricts the contents of this collection to those files which match the given criteria. The filtered collection is live, so that it reflects any changes to this collection.

Specified by:

filter in interface FileCollection

Parameters:

filterSpec - The criteria to use to select the contents of the filtered collection.

Returns:

The filtered collection.

getCapDisplayName

protected String getCapDisplayName()