| API Documentation: | SourceSet |
|---|
ASourceSet represents a logical group of Java source and resources.
See the example below howSourceSet 'main' is accessed and how theSourceDirectorySet 'java'is configured to exclude some package from compilation.
apply plugin:'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, andsource which is indirectly compiled through joint compilation. |
allSource | All source files for this source set. |
compileClasspath | The classpath used to compile this source. |
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 | All Antlr source for this source set. |
| Method | Description |
compiledBy(taskPaths) | Registers a set of tasks which are responsible for compiling this source set into the classes directory. Thepaths 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. |
| Method | Description |
antlr(configureAction) | Configures the Antlr source for this set. The given action is used to configure the |
| Method | Description |
groovy(configureAction) | Configures the Groovy source for this set. |
| Method | Description |
scala(configureAction) | Configures the Scala source for this set. |
| Block | Description |
antlr | Configures the Antlr source for this set. The given closure is used to configure the |
| Block | Description |
groovy | Configures the Groovy source for this set. |
| Block | Description |
scala | Configures the Scala source for this set. |
SourceDirectorySetallJava (read-only)
All Java source files for this source set. This includes, for example, source which is directly compiled, andsource which is indirectly compiled through joint compilation.
- Default with
javaplugin: [java]
SourceDirectorySetallSource (read-only)
All source files for this source set.
- Default with
javaplugin: [java, resources]
FileCollectioncompileClasspath
The classpath used to compile this source.
- Default with
javaplugin: project.configurations.compileClasspath(orproject.configurations.testCompileClasspathfor thetestsource set).
SourceDirectorySetjava (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]
Stringname (read-only)
The name of this source set.
SourceSetOutputoutput (read-only)
SourceSetOutput is aFileCollection 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 inSourceSetOutput
- Default with
javaplugin: - See
SourceSetOutput
SourceDirectorySetresources (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]
FileCollectionruntimeClasspath
The classpath used to execute this source.
- Default with
javaplugin: sourceSet.output + project.configurations.runtime(orsourceSet.output + project.configurations.testRuntimefor thetestsource set).
SourceDirectorySetantlr (read-only)
All Antlr source for this source set.
SourceDirectorySetallGroovy (read-only)
All Groovy source for this source set.
SourceDirectorySetgroovy (read-only)
The source to be compiled by the Groovy compiler for this source set. Any Java source present in this setwill be passed to the Groovy compiler for joint compilation.
SourceDirectorySetallScala (read-only)
All Scala source for this source set.
SourceDirectorySetscala (read-only)
The source to be compiled by the Scala compiler for this source set. This may contain both Java and Scalasource files.
Registers a set of tasks which are responsible for compiling this source set into the classes directory. Thepaths are evaluated as perTask.dependsOn(java.lang.Object[]).
SourceSetjava(Action<? superSourceDirectorySet>
Action<? superSourceDirectorySet>Configures the Java source for this set.
The given action is used to configure theSourceDirectorySet which contains the Java source.
SourceSetresources(Action<? superSourceDirectorySet>
Action<? superSourceDirectorySet>Configures the non-Java resources for this set.
The given action is used to configure theSourceDirectorySet which contains the resources.
AntlrSourceVirtualDirectoryantlr(Action<? superSourceDirectorySet>
Action<? superSourceDirectorySet>Configures the Antlr source for this set. The given action is used to configure theSourceDirectorySet (seeAntlrSourceVirtualDirectory.getAntlr()) which contains the Antlr source.
GroovySourceSetgroovy(Action<? superSourceDirectorySet>
Action<? superSourceDirectorySet>Configures the Groovy source for this set.
The given action is used to configure theSourceDirectorySet which contains the Groovy source.
ScalaSourceSetscala(Action<? superSourceDirectorySet>
Action<? superSourceDirectorySet>Configures the Scala source for this set.
The given action is used to configure theSourceDirectorySet which contains the Scala source.
Configures the Java source for this set.
The given closure is used to configure theSourceDirectorySet which contains the Java source.
- Delegates to:
SourceDirectorySetfromjava
Configures the non-Java resources for this set.
The given closure is used to configure theSourceDirectorySet which contains the resources.
- Delegates to:
SourceDirectorySetfromresources
Configures the Antlr source for this set. The given closure is used to configure theSourceDirectorySet (seeAntlrSourceVirtualDirectory.getAntlr()) which contains the Antlr source.
- Delegates to:
SourceDirectorySetfromantlr
Configures the Groovy source for this set.
The given closure is used to configure theSourceDirectorySet which contains the Groovy source.
- Delegates to:
SourceDirectorySetfromgroovy
Configures the Scala source for this set.
The given closure is used to configure theSourceDirectorySet which contains the Scala source.
- Delegates to:
SourceDirectorySetfromscala