org.gradle.api.internal.file.collections

Class DefaultConfigurableFileCollection

java.lang.Object

org.gradle.api.internal.file.AbstractFileCollection

org.gradle.api.internal.file.CompositeFileCollection

org.gradle.api.internal.file.collections.DefaultConfigurableFileCollection

All Implemented Interfaces:

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

public class DefaultConfigurableFileCollection
extends CompositeFileCollection
implements ConfigurableFileCollection

A FileCollection which resolves a set of paths relative to a FileResolver.

Nested Class Summary

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

FileCollection.AntType

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurableFileCollection(FileResolver fileResolver, TaskResolver taskResolver, Object... files)
DefaultConfigurableFileCollection(String displayName, FileResolver fileResolver, TaskResolver taskResolver, Object... files)

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurableFileCollection	builtBy(Object... tasks) Registers some tasks which build the files of this collection.
ConfigurableFileCollection	from(Object... paths) Adds a set of source paths to this collection.
Set<Object>	getBuiltBy() Returns the set of tasks which build the files of this collection.
String	getDisplayName() Returns the display name of this file collection.
Set<Object>	getFrom() Returns the set of source paths for this collection.
void	resolve(FileCollectionResolveContext context) Adds the contents of this container to the given context.
ConfigurableFileCollection	setBuiltBy(Iterable<?> tasks) Sets the tasks which build the files of this collection.
void	setFrom(Iterable<?> path) Sets the source paths for this collection.
void	setFrom(Object... paths) Sets the source paths for this collection.

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

addAsResourceCollection, addDependencies, contains, filter, getAsFileTree, getAsFileTrees, getBuildDependencies, getFiles, getSourceCollections, 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.FileCollection

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

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface org.gradle.api.Buildable

getBuildDependencies

Constructor Detail

DefaultConfigurableFileCollection

public DefaultConfigurableFileCollection(FileResolver fileResolver,
                                 TaskResolver taskResolver,
                                 Object... files)

DefaultConfigurableFileCollection

public DefaultConfigurableFileCollection(String displayName,
                                 FileResolver fileResolver,
                                 TaskResolver taskResolver,
                                 Object... files)

Method Detail

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

getFrom

public Set<Object> getFrom()

Description copied from interface: ConfigurableFileCollection

Returns the set of source paths for this collection. The paths are evaluated as for Project.files(Object...).

Specified by:

getFrom in interface ConfigurableFileCollection

Returns:

The set of source paths. Returns an empty set if none.

setFrom

public void setFrom(Iterable<?> path)

Description copied from interface: ConfigurableFileCollection

Sets the source paths for this collection. The given paths are evaluated as for Project.files(Object...).

Specified by:

setFrom in interface ConfigurableFileCollection

Parameters:

path - The paths.

setFrom

public void setFrom(Object... paths)

Description copied from interface: ConfigurableFileCollection

Sets the source paths for this collection. The given paths are evaluated as for Project.files(Object...).

Specified by:

setFrom in interface ConfigurableFileCollection

Parameters:

paths - The paths.

from

public ConfigurableFileCollection from(Object... paths)

Description copied from interface: ConfigurableFileCollection

Adds a set of source paths to this collection. The given paths are evaluated as for Project.files(Object...).

Specified by:

from in interface ConfigurableFileCollection

Parameters:

paths - The files to add.

Returns:

this

builtBy

public ConfigurableFileCollection builtBy(Object... tasks)

Description copied from interface: ConfigurableFileCollection

Registers some tasks which build the files of this collection.

Specified by:

builtBy in interface ConfigurableFileCollection

Parameters:

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

Returns:

this

getBuiltBy

public Set<Object> getBuiltBy()

Description copied from interface: ConfigurableFileCollection

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

Specified by:

getBuiltBy in interface ConfigurableFileCollection

Returns:

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

setBuiltBy

public ConfigurableFileCollection setBuiltBy(Iterable<?> tasks)

Description copied from interface: ConfigurableFileCollection

Sets the tasks which build the files of this collection.

Specified by:

setBuiltBy in interface ConfigurableFileCollection

Parameters:

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

Returns:

this

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