SourceDirectorySet (Gradle API 0.9-rc-1)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.file
Interface SourceDirectorySet

All Superinterfaces:: org.gradle.api.tasks.AntBuilderAware, Buildable, FileCollection, FileTree, Iterable<File>, PatternFilterable

public interface SourceDirectorySet
extends FileTree, PatternFilterable
extends FileTree, PatternFilterable

A SourceDirectorySet represents a set of source files composed from a set of source directories, along with associated include and exclude patterns.

TODO - configure includes/excludes for individual source dirs, and sync up with CopySpec TODO - allow add FileTree

Nested Class Summary

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

Method Summary
`PatternFilterable`	`getFilter()` Returns the filter used to select the source from the source directories.
`Set<File>`	`getSrcDirs()` Returns the source directories which make up this set.
`SourceDirectorySet`	`setSrcDirs(Iterable<Object> srcPaths)` Sets the source directories for this set.
`SourceDirectorySet`	`srcDir(Object srcPath)` Adds the given source directory to this set.
`SourceDirectorySet`	`srcDirs(Object... srcPaths)` Adds the given source directories to this set.

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`

Methods inherited from interface org.gradle.api.tasks.util.PatternFilterable
`exclude, exclude, exclude, exclude, getExcludes, getIncludes, include, include, include, include, setExcludes, setIncludes`

Method Detail

srcDir

SourceDirectorySet srcDir(Object srcPath)

Adds the given source directory to this set.

Parameters:: srcPath - The source directory. This is evaluated as for Project.file(Object)
Returns:: this

srcDirs

SourceDirectorySet srcDirs(Object... srcPaths)

Adds the given source directories to this set.

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

getSrcDirs

Set<File> getSrcDirs()

Returns the source directories which make up this set.

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

setSrcDirs

SourceDirectorySet setSrcDirs(Iterable<Object> srcPaths)

Sets the source directories for this set.

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

getFilter

PatternFilterable getFilter()

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.

Returns:: The filter patterns.