-
- All Superinterfaces:
- AntBuilderAware, Buildable, FileCollection, FileTree, Iterable<File>, Named, PatternFilterable
public interface SourceDirectorySet extends FileTree, PatternFilterable, Named
A
SourceDirectorySetrepresents 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
-
Nested classes/interfaces inherited from interface org.gradle.api.Named
Named.Namer
-
-
Method Summary
Methods Modifier and Type Method and Description PatternFilterablegetFilter()Returns the filter used to select the source from the source directories.
StringgetName()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.
SourceDirectorySetsetSrcDirs(Iterable<?> srcPaths)Sets the source directories for this set.
SourceDirectorySetsource(SourceDirectorySet source)Adds the given source to this set.
SourceDirectorySetsrcDir(Object srcPath)Adds the given source directory to this set.
SourceDirectorySetsrcDirs(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 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
-
getName
String getName()
A concise name for the source directory set (typically used to identify it in a collection).
-
srcDir
SourceDirectorySet srcDir(Object srcPath)
Adds the given source directory to this set.
- Parameters:
srcPath- The source directory. This is evaluated as perProject.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 perProject.files(Object...)- Returns:
- this
-
getSrcDirs
Set<File> getSrcDirs()
Returns the source directories which make up this set. Does not filter source directories which do not exist.
- Returns:
- The source directories. Returns an empty set when this set contains no source directories.
-
setSrcDirs
SourceDirectorySet setSrcDirs(Iterable<?> srcPaths)
Sets the source directories for this set.
- Parameters:
srcPaths- The source directories. These are evaluated as perProject.files(Object...)- Returns:
- this
-
source
SourceDirectorySet source(SourceDirectorySet source)
Adds the given source to this set.
- Parameters:
source- The source to add.- Returns:
- this
-
getSrcDirTrees
Set<DirectoryTree> getSrcDirTrees()
Returns the source directory trees which make up this set. Does not filter source directories which do not exist.
- Returns:
- The source directory trees. Returns an empty set when this set contains no source directories.
-
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.
-
-