Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

org.gradle.api.file
[Java] Interface SourceDirectorySet

org.gradle.api.Named
  org.gradle.api.Buildable
      org.gradle.api.file.FileTree
          org.gradle.api.tasks.AntBuilderAware
              org.gradle.api.file.FileCollection
                  org.gradle.api.tasks.util.PatternFilterable
                      org.gradle.api.file.SourceDirectorySet
All Superinterfaces:
Named, Buildable, FileTree, AntBuilderAware, FileCollection, PatternFilterable
public interface SourceDirectorySet
extends FileTree, Named, 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 '

Method Summary
PatternFilterable getFilter()

Returns the filter used to select the source from the source directories.

java.lang.String getName()

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

Returns the source directory trees which make up this set.

java.util.Set getSrcDirs()

Returns the source directories which make up this set.

SourceDirectorySet setSrcDirs(java.lang.Iterable srcPaths)

Sets the source directories for this set.
SourceDirectorySet source(SourceDirectorySet source)

Adds the given source to this set.
SourceDirectorySet srcDir(java.lang.Object srcPath)

Adds the given source directory to this set.
SourceDirectorySet srcDirs(java.lang.Object... srcPaths)

Adds the given source directories to this set.
 
Methods inherited from interface Named
getName
 
Methods inherited from interface FileTree
getAsFileTree, matching, matching, plus, visit, visit
 
Methods inherited from interface PatternFilterable
exclude, exclude, exclude, exclude, getExcludes, getIncludes, include, include, include, include, setExcludes, setIncludes
 

Method Detail

getFilter

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

getName

public java.lang.String getName()
A concise name for the source directory set (typically used to identify it in a collection).

getSrcDirTrees

public java.util.Set 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.

getSrcDirs

public java.util.Set 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

public SourceDirectorySet setSrcDirs(java.lang.Iterable srcPaths)
Sets the source directories for this set.
Parameters:
srcPaths - The source directories. These are evaluated as for Project.files
Returns:
this

source

public SourceDirectorySet source(SourceDirectorySet source)
Adds the given source to this set.
Parameters:
source - The source to add.
Returns:
this

srcDir

public SourceDirectorySet srcDir(java.lang.Object srcPath)
Adds the given source directory to this set.
Parameters:
srcPath - The source directory. This is evaluated as for Project.file
Returns:
this

srcDirs

public SourceDirectorySet srcDirs(java.lang.Object... srcPaths)
Adds the given source directories to this set.
Parameters:
srcPaths - The source directories. These are evaluated as for Project.files
Returns:
this

 

Groovy Documentation