| API Documentation: | SourceSet |
|---|
A SourceSet represents a logical group of Java source and resource files. They
are covered in more detail in the
user manual.
The following example shows how you can configure the 'main' source set, which in this
case involves excluding classes whose package begins 'some.unwanted.package' from
compilation of the source files in the 'java' SourceDirectorySet:
plugins {
id 'java'
}
sourceSets {
main {
java {
exclude 'some/unwanted/package/**'
}
}
}
| Property | Description |
allJava | All Java source files for this source set. This includes, for example, source which is directly compiled, and source which is indirectly compiled through joint compilation. |
allSource | All source files for this source set. |
compileClasspath | The classpath used to compile this source. |
extensions | The container of extensions. |
java | The Java source which is to be compiled by the Java compiler into the class output directory. |
name | The name of this source set. |
output |
|
resources | The non-Java resources which are to be copied into the resources output directory. |
runtimeClasspath | The classpath used to execute this source. |
| Property | Description |
antlr | The |
| Property | Description |
groovy | The |
| Property | Description |
scala | The |
| Method | Description |
compiledBy(taskPaths) | Registers a set of tasks which are responsible for compiling this source set into the classes directory. The
paths are evaluated as per |
getCompileTaskName(language) | Returns the name of a compile task for this source set. |
getTaskName(verb, target) | Returns the name of a task for this source set. |
java(configureAction) | Configures the Java source for this set. |
resources(configureAction) | Configures the non-Java resources for this set. |
| Block | Description |
antlr | Configures the |
| Block | Description |
groovy | Configures the |
| Block | Description |
scala | Configures the |
SourceDirectorySet allJava (read-only)
All Java source files for this source set. This includes, for example, source which is directly compiled, and source which is indirectly compiled through joint compilation.
- Default with
javaplugin: [java]
SourceDirectorySet allSource (read-only)
All source files for this source set.
- Default with
javaplugin: [java, resources]
FileCollection compileClasspath
The classpath used to compile this source.
- Default with
javaplugin: project.configurations.compileClasspath(orproject.configurations.testCompileClasspathfor thetestsource set).
ExtensionContainer extensions (read-only)
The container of extensions.
SourceDirectorySet java (read-only)
The Java source which is to be compiled by the Java compiler into the class output directory.
- Default with
javaplugin: [${project.projectDir}/src/${sourceSet.name}/java]
String name (read-only)
The name of this source set.
SourceSetOutput output (read-only)
SourceSetOutput is a FileCollection of all output directories (compiled classes, processed resources, etc.)
and it provides means to configure the default output dirs and register additional output dirs. See examples in SourceSetOutput
- Default with
javaplugin: - See
SourceSetOutput
SourceDirectorySet resources (read-only)
The non-Java resources which are to be copied into the resources output directory.
- Default with
javaplugin: [${project.projectDir}/src/${sourceSet.name}/resources]
FileCollection runtimeClasspath
The classpath used to execute this source.
- Default with
javaplugin: sourceSet.output + project.configurations.runtimeClasspath(orsourceSet.output + project.configurations.testRuntimeClasspathfor thetestsource set).
AntlrSourceDirectorySet antlr (read-only)
The AntlrSourceDirectorySet added by the antlr plugin.
GroovySourceDirectorySet groovy (read-only)
The GroovySourceDirectorySet added by the groovy plugin.
ScalaSourceDirectorySet scala (read-only)
The ScalaSourceDirectorySet added by the scala plugin.
Registers a set of tasks which are responsible for compiling this source set into the classes directory. The
paths are evaluated as per Task.dependsOn(java.lang.Object[]).
SourceSet java(Action<? super SourceDirectorySet> configureAction)
Action<? super SourceDirectorySet>Configures the Java source for this set.
The given action is used to configure the SourceDirectorySet which contains the Java source.
SourceSet resources(Action<? super SourceDirectorySet> configureAction)
Action<? super SourceDirectorySet>Configures the non-Java resources for this set.
The given action is used to configure the SourceDirectorySet which contains the resources.
Configures the Java source for this set.
The given closure is used to configure the SourceDirectorySet which contains the Java source.
- Delegates to:
SourceDirectorySetfromjava
Configures the non-Java resources for this set.
The given closure is used to configure the SourceDirectorySet which contains the resources.
- Delegates to:
SourceDirectorySetfromresources
Configures the AntlrSourceDirectorySet added by the antlr plugin.
- Delegates to:
AntlrSourceDirectorySetfromantlr
Configures the GroovySourceDirectorySet added by the groovy plugin.
- Delegates to:
GroovySourceDirectorySetfromgroovy
Configures the ScalaSourceDirectorySet added by the scala plugin.
- Delegates to:
ScalaSourceDirectorySetfromscala