gradle/org.gradle.api.file/SourceDirectorySet

SourceDirectorySet

interface SourceDirectorySet : FileTree, PatternFilterable, Named, Describable(source)

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.

You can filter the files that are obtainable in this set using patterns via include and include (or any overload of these methods). The set of included source directories themselves are not filtered.

Inheritors

AntlrSourceDirectorySet

GroovySourceDirectorySet

ScalaSourceDirectorySet

Functions

addToAntBuilder

abstract fun addToAntBuilder(builder: Any, nodeName: String): Any

abstract fun addToAntBuilder(builder: Any, nodeName: String, type: FileCollection.AntType)

abstract fun <T : Task?> compiledBy(taskProvider: TaskProvider<T>, mapping: (T) -> DirectoryProperty)

Define the task responsible for processing the source.

abstract fun contains(file: File): Boolean

abstract fun exclude(excludes: Array<String>): PatternFilterable

abstract fun filter(filterClosure: Closure): FileCollection

open fun forEach(action: Consumer<in T>)

abstract fun getAsFileTree(): FileTree

abstract fun getAsPath(): String

getBuildDependencies

abstract fun getBuildDependencies(): TaskDependency

getClassesDirectory

abstract fun getClassesDirectory(): Provider<Directory>

Returns the directory property that is bound to the task that produces the output via compiledBy.

getDestinationDirectory

abstract fun getDestinationDirectory(): DirectoryProperty

Configure the directory to assemble the compiled classes into.

abstract fun getDisplayName(): String

abstract fun getElements(): Provider<Set<FileSystemLocation>>

abstract fun getExcludes(): Set<String>

abstract fun getFiles(): Set<File>

abstract fun getFilter(): PatternFilterable

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

abstract fun getIncludes(): Set<String>

abstract fun getName(): String

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

abstract fun getSingleFile(): File

getSourceDirectories

abstract fun getSourceDirectories(): FileCollection

Returns the source directories that make up this set, represented as a FileCollection.

abstract fun getSrcDirs(): Set<File>

Returns the source directories that make up this set.

abstract fun getSrcDirTrees(): Set<DirectoryTree>

Returns the source directory trees that make up this set.

abstract fun include(includes: Array<String>): PatternFilterable

abstract fun isEmpty(): Boolean

abstract fun iterator(): Iterator<T>

abstract fun matching(filterConfigClosure: Closure): FileTree

abstract fun minus(collection: FileCollection): FileCollection

abstract fun plus(collection: FileCollection): FileCollection

abstract fun plus(fileTree: FileTree): FileTree

abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable

abstract fun setIncludes(includes: Iterable<String>): PatternFilterable

abstract fun setSrcDirs(srcPaths: Iterable<out Any>): SourceDirectorySet

Sets the source directories for this set.

abstract fun source(source: SourceDirectorySet): SourceDirectorySet

Adds the given source to this set.

open fun spliterator(): Spliterator<T>

abstract fun srcDir(srcPath: Any): SourceDirectorySet

Adds the given source directory to this set.

abstract fun srcDirs(srcPaths: Array<Any>): SourceDirectorySet

Adds the given source directories to this set.

abstract fun visit(visitor: FileVisitor): FileTree