org.gradle.api.internal.file

Class CompositeFileCollection

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

org.gradle.api.internal.file.CompositeFileCollection

All Implemented Interfaces:

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

Direct Known Subclasses:

CompositeFileTree, DefaultConfigurableFileCollection, DefaultSourceSetOutput, UnionFileCollection

public abstract class CompositeFileCollection
extends AbstractFileCollection
implements FileCollectionContainer

A FileCollection which contains the union of the given source collections. Maintains file ordering.

Nested Class Summary

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

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
CompositeFileCollection()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAsResourceCollection(Object builder, String nodeName)
protected void	addDependencies(TaskDependencyResolveContext context) Allows subclasses to add additional dependencies
boolean	contains(File file) Determines whether this collection contains the given file.
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.
TaskDependency	getBuildDependencies() Returns a dependency which contains the tasks which build this artifact.
Set<File>	getFiles() Returns the contents of this collection as a Set.
protected List<? extends FileCollection>	getSourceCollections()
boolean	isEmpty() Returns true if this collection is empty.
abstract void	resolve(FileCollectionResolveContext context) Adds the contents of this container to the given context.

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

add, addAsFileSet, addAsMatchingTask, addToAntBuilder, addToAntBuilder, asType, filter, getAsPath, 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.internal.file.collections.FileCollectionContainer

getDisplayName

Constructor Detail

CompositeFileCollection

public CompositeFileCollection()

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.

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.

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.

addAsResourceCollection

protected void addAsResourceCollection(Object builder,
                           String nodeName)

Overrides:

addAsResourceCollection in class AbstractFileCollection

getAsFileTrees

protected Collection<DirectoryFileTree> getAsFileTrees()

Description copied from class: AbstractFileCollection

Returns this collection as a set of DirectoryFileTree instances.

Overrides:

getAsFileTrees in class AbstractFileCollection

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

Overrides:

getAsFileTree in class AbstractFileCollection

Returns:

this collection as a FileTree. Never returns null.

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

Overrides:

filter in class AbstractFileCollection

Parameters:

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

Returns:

The filtered collection.

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.

addDependencies

protected void addDependencies(TaskDependencyResolveContext context)

Allows subclasses to add additional dependencies

Parameters:

context - The context to add dependencies to.

getSourceCollections

protected List<? extends FileCollection> getSourceCollections()

resolve

public abstract 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