gradle
8.3

# SourceDirectorySet

interface SourceDirectorySet : FileTree, PatternFilterable, Named, Describable

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

`SourceDirectorySet` extends FileTree. The contents of the file tree represent the source files of this set, arranged in a hierarchy. The file tree is live and reflects changes to the source directories and their contents.

You can create an instance of `SourceDirectorySet` using the sourceDirectorySet method.

#### Inheritors

AntlrSourceDirectorySet
ScalaSourceDirectorySet
GroovySourceDirectorySet

## Functions

addToAntBuilder
Link copied to clipboard
abstract fun addToAntBuilder(builder: Any, nodeName: String): Any
abstract fun addToAntBuilder(builder: Any, nodeName: String, type: FileCollection.AntType)
compiledBy
Link copied to clipboard
abstract fun <T : Task?> compiledBy(taskProvider: TaskProvider<T>, mapping: (T) -> DirectoryProperty)
Define the task responsible for processing the source.
contains
Link copied to clipboard
abstract fun contains(file: File): Boolean
exclude
Link copied to clipboard
abstract fun exclude(excludes: Array<String>): PatternFilterable
filter
Link copied to clipboard
abstract fun filter(filterClosure: Closure): FileCollection
forEach
Link copied to clipboard
open fun forEach(action: Consumer<out Any>)
getAsFileTree
Link copied to clipboard
abstract fun getAsFileTree(): FileTree
getAsPath
Link copied to clipboard
abstract fun getAsPath(): String
getBuildDependencies
Link copied to clipboard
abstract fun getBuildDependencies(): TaskDependency
getClassesDirectory
Link copied to clipboard
abstract fun getClassesDirectory(): Provider<Directory>
Returns the directory property that is bound to the task that produces the output via compiledBy.
getDestinationDirectory
Link copied to clipboard
abstract fun getDestinationDirectory(): DirectoryProperty
Configure the directory to assemble the compiled classes into.
getDisplayName
Link copied to clipboard
abstract fun getDisplayName(): String
getElements
Link copied to clipboard
abstract fun getElements(): Provider<Set<FileSystemLocation>>
getExcludes
Link copied to clipboard
abstract fun getExcludes(): Set<String>
getFiles
Link copied to clipboard
abstract fun getFiles(): Set<File>
getFilter
Link copied to clipboard
abstract fun getFilter(): PatternFilterable
Returns the filter used to select the source from the source directories.
getIncludes
Link copied to clipboard
abstract fun getIncludes(): Set<String>
getName
Link copied to clipboard
abstract fun getName(): String
A concise name for the source directory set (typically used to identify it in a collection).
getSingleFile
Link copied to clipboard
abstract fun getSingleFile(): File
getSourceDirectories
Link copied to clipboard
abstract fun getSourceDirectories(): FileCollection
Returns the source directories that make up this set, represented as a FileCollection.
getSrcDirs
Link copied to clipboard
abstract fun getSrcDirs(): Set<File>
Returns the source directories that make up this set.
getSrcDirTrees
Link copied to clipboard
abstract fun getSrcDirTrees(): Set<DirectoryTree>
Returns the source directory trees that make up this set.
include
Link copied to clipboard
abstract fun include(includes: Array<String>): PatternFilterable
isEmpty
Link copied to clipboard
abstract fun isEmpty(): Boolean
iterator
Link copied to clipboard
abstract fun iterator(): Iterator<T>
matching
Link copied to clipboard
abstract fun matching(filterConfigClosure: Closure): FileTree
minus
Link copied to clipboard
abstract fun minus(collection: FileCollection): FileCollection
plus
Link copied to clipboard
abstract fun plus(collection: FileCollection): FileCollection
abstract fun plus(fileTree: FileTree): FileTree
setExcludes
Link copied to clipboard
abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable
setIncludes
Link copied to clipboard
abstract fun setIncludes(includes: Iterable<String>): PatternFilterable
setSrcDirs
Link copied to clipboard
abstract fun setSrcDirs(srcPaths: Iterable<out Any>): SourceDirectorySet
Sets the source directories for this set.
source
Link copied to clipboard
abstract fun source(source: SourceDirectorySet): SourceDirectorySet
Adds the given source to this set.
spliterator
Link copied to clipboard
open fun spliterator(): Spliterator<T>
srcDir
Link copied to clipboard
abstract fun srcDir(srcPath: Any): SourceDirectorySet
Adds the given source directory to this set.
srcDirs
Link copied to clipboard
abstract fun srcDirs(srcPaths: Array<Any>): SourceDirectorySet
Adds the given source directories to this set.
visit
Link copied to clipboard
abstract fun visit(visitor: FileVisitor): FileTree