org.gradle.api.internal.file

Class DefaultSourceDirectorySet

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.DefaultSourceDirectorySet

All Implemented Interfaces:

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

public class DefaultSourceDirectorySet
extends CompositeFileTree
implements SourceDirectorySet

Nested Class Summary

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

FileCollection.AntType

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Constructor Summary

Constructors

Constructor and Description
DefaultSourceDirectorySet(String name, FileResolver fileResolver)
DefaultSourceDirectorySet(String name, String displayName, FileResolver fileResolver)

Method Summary

Methods

Modifier and Type	Method and Description
PatternFilterable	exclude(Closure excludeSpec) Adds an exclude spec.
PatternFilterable	exclude(Iterable<String> excludes) Adds an ANT style exclude pattern.
PatternFilterable	exclude(Spec<FileTreeElement> excludeSpec) Adds an exclude spec.
PatternFilterable	exclude(String... excludes) Adds an ANT style exclude pattern.
String	getDisplayName() Returns the display name of this file collection.
Set<String>	getExcludes() Returns the set of exclude patterns.
PatternFilterable	getFilter() Returns the filter used to select the source from the source directories.
Set<String>	getIncludes() Returns the set of include patterns.
String	getName() A concise name for the source directory set (typically used to identify it in a collection).
Set<File>	getSrcDirs() Returns the source directories which make up this set.
Set<DirectoryTree>	getSrcDirTrees() Returns the source directory trees which make up this set.
PatternFilterable	include(Closure includeSpec) Adds an include spec.
PatternFilterable	include(Iterable<String> includes) Adds an ANT style include pattern.
PatternFilterable	include(Spec<FileTreeElement> includeSpec) Adds an include spec.
PatternFilterable	include(String... includes) Adds an ANT style include pattern.
void	resolve(FileCollectionResolveContext context) Adds the contents of this container to the given context.
PatternFilterable	setExcludes(Iterable<String> excludes) Set the allowable exclude patterns.
PatternFilterable	setIncludes(Iterable<String> includes) Set the allowable include patterns.
SourceDirectorySet	setSrcDirs(Iterable<?> srcPaths) Sets the source directories for this set.
SourceDirectorySet	source(SourceDirectorySet source) Adds the given source to this set.
SourceDirectorySet	srcDir(Object srcDir) Adds the given source directory to this set.
SourceDirectorySet	srcDirs(Object... srcDirs) Adds the given source directories to this set.

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, getBuildDependencies, 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

Methods inherited from interface org.gradle.api.Buildable

getBuildDependencies

Constructor Detail

DefaultSourceDirectorySet

public DefaultSourceDirectorySet(String name,
                         String displayName,
                         FileResolver fileResolver)

DefaultSourceDirectorySet

public DefaultSourceDirectorySet(String name,
                         FileResolver fileResolver)

Method Detail

getName

public String getName()

Description copied from interface: SourceDirectorySet

A concise name for the source directory set (typically used to identify it in a collection).

Specified by:

getName in interface SourceDirectorySet

Specified by:

getName in interface Named

Returns:

The name. Never null.

getSrcDirs

public Set<File> getSrcDirs()

Description copied from interface: SourceDirectorySet

Returns the source directories which make up this set. Does not filter source directories which do not exist.

Specified by:

getSrcDirs in interface SourceDirectorySet

Returns:

The source directories. Returns an empty set when this set contains no source directories.

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.

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.

setIncludes

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

setExcludes

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

include

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

exclude

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

getFilter

public PatternFilterable getFilter()

Description copied from interface: SourceDirectorySet

Returns the filter used to select the source from the source directories. These filter patterns are applied after the include and exclude patterns of the source directory set itself. Generally, the filter patterns are used to select certain types of files, eg *.java.

Specified by:

getFilter in interface SourceDirectorySet

Returns:

The filter patterns.

getSrcDirTrees

public Set<DirectoryTree> getSrcDirTrees()

Description copied from interface: SourceDirectorySet

Returns the source directory trees which make up this set. Does not filter source directories which do not exist.

Specified by:

getSrcDirTrees in interface SourceDirectorySet

Returns:

The source directory trees. Returns an empty set when this set contains no source directories.

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

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

srcDir

public SourceDirectorySet srcDir(Object srcDir)

Description copied from interface: SourceDirectorySet

Adds the given source directory to this set.

Specified by:

srcDir in interface SourceDirectorySet

Parameters:

srcDir - The source directory. This is evaluated as for Project.file(Object)

Returns:

this

srcDirs

public SourceDirectorySet srcDirs(Object... srcDirs)

Description copied from interface: SourceDirectorySet

Adds the given source directories to this set.

Specified by:

srcDirs in interface SourceDirectorySet

Parameters:

srcDirs - The source directories. These are evaluated as for Project.files(Object...)

Returns:

this

setSrcDirs

public SourceDirectorySet setSrcDirs(Iterable<?> srcPaths)

Description copied from interface: SourceDirectorySet

Sets the source directories for this set.

Specified by:

setSrcDirs in interface SourceDirectorySet

Parameters:

srcPaths - The source directories. These are evaluated as for Project.files(Object...)

Returns:

this

source

public SourceDirectorySet source(SourceDirectorySet source)

Description copied from interface: SourceDirectorySet

Adds the given source to this set.

Specified by:

source in interface SourceDirectorySet

Parameters:

source - The source to add.

Returns:

this