dev.nokee.language.base

Interface LanguageSourceSet

All Superinterfaces:

Buildable, Named

All Known Subinterfaces:

CHeaderSet, CppHeaderSet, CppSourceSet, CSourceSet, GroovySourceSet, IosResourceSet, JavaSourceSet, KotlinSourceSet, NativeHeaderSet, ObjectiveCppSourceSet, ObjectiveCSourceSet, SelfAwareLanguageSourceSet<SELF>, SwiftSourceSet

public interface LanguageSourceSet
extends Buildable, Named

A set of sources for a programming language.

Since:

0.5

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Method Summary

Modifier and Type	Method and Description
default LanguageSourceSet	convention(Object... path) Configures a set of source paths to use as a convention of this source set.
default LanguageSourceSet	filter(Action<? super PatternFilterable> action) Configures the filter patterns using the specified configuration action.
default LanguageSourceSet	filter(groovy.lang.Closure<Void> closure) Configures the filter patterns using the specified configuration closure.
default LanguageSourceSet	from(Object... paths) Adds a set of source paths to this source set.
default FileTree	getAsFileTree() Returns this source set as a filtered file tree.
default TaskDependency	getBuildDependencies()
default PatternFilterable	getFilter() Returns the filter used to select the source from the source directories.
default String	getName() Returns the name that identify this source set.
default FileCollection	getSourceDirectories() Returns the source directories that make up this set, represented as a FileCollection.

Method Detail

getName

default String getName()

Returns the name that identify this source set.

Specified by:

getName in interface Named

Returns:

the name of the source set, never null

from

default LanguageSourceSet from(Object... paths)

Adds a set of source paths to this source set. The given paths are evaluated as per Project.files(Object...).

Parameters:

paths - the files to add

Returns:

this source set, never null

getSourceDirectories

default FileCollection getSourceDirectories()

Returns the source directories that make up this set, represented as a FileCollection. Does not filter source directories that do not exist.

The return value of this method also maintains dependency information.

The returned collection is live and reflects changes to this source directory set.

Returns:

a FileCollection instance of all the source directories from this source set, never null

filter

default LanguageSourceSet filter(Action<? super PatternFilterable> action)

Configures the filter patterns using the specified configuration action.

Parameters:

action - the configuration action, must not be null

Returns:

this language source set, never null

filter

default LanguageSourceSet filter(@DelegatesTo(value=org.gradle.api.tasks.util.PatternFilterable.class,strategy=1)
                                 groovy.lang.Closure<Void> closure)

Configures the filter patterns using the specified configuration closure.

Parameters:

closure - the configuration closure, must not be null

Returns:

this language source set, never null

getFilter

default 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 specified paths. Generally, the filter patterns are used to restrict the contents to certain types of files, eg *.cpp.

Returns:

the filter patterns, never null

getAsFileTree

default FileTree getAsFileTree()

Returns this source set as a filtered file tree.

Returns:

a FileTree instance representing all the files included in this source set, never null

getBuildDependencies

default TaskDependency getBuildDependencies()

Specified by:

getBuildDependencies in interface Buildable

convention

default LanguageSourceSet convention(Object... path)

Configures a set of source paths to use as a convention of this source set. The given paths are evaluated as per Project.files(Object...).

Parameters:

path - the files to use as convention

Returns:

this source set, never null