Package org.gradle.api.tasks
Interface SourceSet
- All Superinterfaces:
- ExtensionAware
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/**'
     }
   }
 }
 - 
Field SummaryFields
- 
Method SummaryModifier and TypeMethodDescriptioncompiledBy(Object... taskPaths) Registers a set of tasks which are responsible for compiling this source set into the classes directory.All Java source files for this source set.All source files for this source set.Returns the name of the configuration containing annotation processors and their dependencies needed to compile this source set.Returns the classpath used to load annotation processors when compiling this source set.Returns the name of the API configuration for this source set.Returns the name of the configuration that should be used when compiling against the API of this component.Returns the name of the classes task for this source set.Returns the classpath used to compile this source.Returns the name of the compile classpath configuration for this source set.Returns the name of the compile Java task for this source set.Returns the name of the 'compile only api' configuration for this source set.Returns the name of the compile only configuration for this source set.getCompileTaskName(String language) Returns the name of a compile task for this source set.Returns the name of the implementation configuration for this source set.Returns the name of the Jar task for this source set.getJava()Returns the Java source which is to be compiled by the Java compiler into the class output directory.Returns the name of the configuration that represents the variant that carries the Javadoc for this source set in packaged form.Returns the name of the Javadoc Jar task for this source set.Returns the name of the Javadoc task for this source set.getName()Returns the name of this source set.SourceSetOutputis aFileCollectionof all output directories (compiled classes, processed resources, etc.) and it provides means to configure the default output dirs and register additional output dirs.Returns the name of the resource process task for this source set.Returns the non-Java resources which are to be copied into the resources output directory.Returns the classpath used to execute this source.Returns the name of the runtime classpath configuration of this component: the runtime classpath contains elements of the implementation, as well as runtime only elements.Returns the name of the configuration containing elements that are strictly required at runtime.Returns the name of the configuration that contains dependencies that are only required at runtime of the component.Returns the name of the configuration that represents the variant that carries the original source code in packaged form.Returns the name of the Source Jar task for this source set.getTaskName(String verb, String target) Returns the name of a task for this source set.static booleanDetermines if this source set is the main source setConfigures the Java source for this set.java(Action<? super SourceDirectorySet> configureAction) Configures the Java source for this set.Configures the non-Java resources for this set.resources(Action<? super SourceDirectorySet> configureAction) Configures the non-Java resources for this set.voidsetAnnotationProcessorPath(FileCollection annotationProcessorPath) Set the classpath to use to load annotation processors when compiling this source set.voidsetCompileClasspath(FileCollection classpath) Sets the classpath used to compile this source.voidsetRuntimeClasspath(FileCollection classpath) Sets the classpath used to execute this source.Methods inherited from interface org.gradle.api.plugins.ExtensionAwaregetExtensions
- 
Field Details- 
MAIN_SOURCE_SET_NAMEThe name of the main source set.- See Also:
 
- 
TEST_SOURCE_SET_NAMEThe name of the test source set.- See Also:
 
 
- 
- 
Method Details- 
getNameString getName()Returns the name of this source set.- Returns:
- The name. Never returns null.
 
- 
getCompileClasspathFileCollection getCompileClasspath()Returns the classpath used to compile this source.- Returns:
- The classpath. Never returns null.
 
- 
setCompileClasspathSets the classpath used to compile this source.- Parameters:
- classpath- The classpath. Should not be null.
 
- 
getAnnotationProcessorPathFileCollection getAnnotationProcessorPath()Returns the classpath used to load annotation processors when compiling this source set. This path is also used for annotation processor discovery. The classpath can be empty, which means use the compile classpath; if you want to disable annotation processing, then use-proc:noneas a compiler argument.- Returns:
- The annotation processor path. Never returns null.
- Since:
- 4.6
 
- 
setAnnotationProcessorPathSet the classpath to use to load annotation processors when compiling this source set. This path is also used for annotation processor discovery. The classpath can be empty, which means use the compile classpath; if you want to disable annotation processing, then use-proc:noneas a compiler argument.- Parameters:
- annotationProcessorPath- The annotation processor path. Should not be null.
- Since:
- 4.6
 
- 
getRuntimeClasspathFileCollection getRuntimeClasspath()Returns the classpath used to execute this source.- Returns:
- The classpath. Never returns null.
 
- 
setRuntimeClasspathSets the classpath used to execute this source.- Parameters:
- classpath- The classpath. Should not be null.
 
- 
getOutputSourceSetOutput getOutput()SourceSetOutputis aFileCollectionof 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- Returns:
- The output dirs, as a SourceSetOutput.
 
- 
compiledByRegisters a set of tasks which are responsible for compiling this source set into the classes directory. The paths are evaluated as perTask.dependsOn(Object...).- Parameters:
- taskPaths- The tasks which compile this source set.
- Returns:
- this
 
- 
getResourcesSourceDirectorySet getResources()Returns the non-Java resources which are to be copied into the resources output directory.- Returns:
- the resources. Never returns null.
 
- 
resourcesConfigures the non-Java resources for this set.The given closure is used to configure the SourceDirectorySetwhich contains the resources.- Parameters:
- configureClosure- The closure to use to configure the resources.
- Returns:
- this
 
- 
resourcesConfigures the non-Java resources for this set.The given action is used to configure the SourceDirectorySetwhich contains the resources.- Parameters:
- configureAction- The action to use to configure the resources.
- Returns:
- this
 
- 
getJavaSourceDirectorySet getJava()Returns the Java source which is to be compiled by the Java compiler into the class output directory.- Returns:
- the Java source. Never returns null.
 
- 
javaConfigures the Java source for this set.The given closure is used to configure the SourceDirectorySetwhich contains the Java source.- Parameters:
- configureClosure- The closure to use to configure the Java source.
- Returns:
- this
 
- 
javaConfigures the Java source for this set.The given action is used to configure the SourceDirectorySetwhich contains the Java source.- Parameters:
- configureAction- The action to use to configure the Java source.
- Returns:
- this
 
- 
getAllJavaSourceDirectorySet getAllJava()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.- Returns:
- the Java source. Never returns null.
 
- 
getAllSourceSourceDirectorySet getAllSource()All source files for this source set.- Returns:
- the source. Never returns null.
 
- 
getClassesTaskNameString getClassesTaskName()Returns the name of the classes task for this source set.- Returns:
- The task name. Never returns null.
 
- 
getProcessResourcesTaskNameString getProcessResourcesTaskName()Returns the name of the resource process task for this source set.- Returns:
- The task name. Never returns null.
 
- 
getCompileJavaTaskNameString getCompileJavaTaskName()Returns the name of the compile Java task for this source set.- Returns:
- The task name. Never returns null.
 
- 
getCompileTaskNameReturns the name of a compile task for this source set.- Parameters:
- language- The language to be compiled.
- Returns:
- The task name. Never returns null.
 
- 
getJavadocTaskNameString getJavadocTaskName()Returns the name of the Javadoc task for this source set.- Returns:
- The task name. Never returns null.
- Since:
- 6.0
 
- 
getJarTaskNameString getJarTaskName()Returns the name of the Jar task for this source set.- Returns:
- The task name. Never returns null.
 
- 
getJavadocJarTaskNameString getJavadocJarTaskName()Returns the name of the Javadoc Jar task for this source set.- Returns:
- The task name. Never returns null.
- Since:
- 6.0
 
- 
getSourcesJarTaskNameString getSourcesJarTaskName()Returns the name of the Source Jar task for this source set.- Returns:
- The task name. Never returns null.
- Since:
- 6.0
 
- 
getTaskNameReturns the name of a task for this source set.- Parameters:
- verb- The action, may be null.
- target- The target, may be null
- Returns:
- The task name, generally of the form ${verb}${name}${noun}
 
- 
getCompileOnlyConfigurationNameString getCompileOnlyConfigurationName()Returns the name of the compile only configuration for this source set.- Returns:
- The compile only configuration name
- Since:
- 2.12
 
- 
getCompileOnlyApiConfigurationNameString getCompileOnlyApiConfigurationName()Returns the name of the 'compile only api' configuration for this source set.- Returns:
- The 'compile only api' configuration name
- Since:
- 6.7
 
- 
getCompileClasspathConfigurationNameString getCompileClasspathConfigurationName()Returns the name of the compile classpath configuration for this source set.- Returns:
- The compile classpath configuration
- Since:
- 2.12
 
- 
getAnnotationProcessorConfigurationNameString getAnnotationProcessorConfigurationName()Returns the name of the configuration containing annotation processors and their dependencies needed to compile this source set.- Returns:
- the name of the annotation processor configuration.
- Since:
- 4.6
 
- 
getApiConfigurationNameString getApiConfigurationName()Returns the name of the API configuration for this source set. The API configuration contains dependencies which are exported by this source set, and is not transitive by default. This configuration is not meant to be resolved and should only contain dependencies that are required when compiling against this component.- Returns:
- The API configuration name
- Since:
- 3.3
 
- 
getImplementationConfigurationNameString getImplementationConfigurationName()Returns the name of the implementation configuration for this source set. The implementation configuration should contain dependencies which are specific to the implementation of the component (internal APIs).- Returns:
- The configuration name
- Since:
- 3.4
 
- 
getApiElementsConfigurationNameString getApiElementsConfigurationName()Returns the name of the configuration that should be used when compiling against the API of this component. This configuration is meant to be consumed by other components when they need to compile against it.- Returns:
- The API compile configuration name
- Since:
- 3.3
 
- 
getRuntimeOnlyConfigurationNameString getRuntimeOnlyConfigurationName()Returns the name of the configuration that contains dependencies that are only required at runtime of the component. Dependencies found in this configuration are visible to the runtime classpath of the component, but not to consumers.- Returns:
- the runtime only configuration name
- Since:
- 3.4
 
- 
getRuntimeClasspathConfigurationNameString getRuntimeClasspathConfigurationName()Returns the name of the runtime classpath configuration of this component: the runtime classpath contains elements of the implementation, as well as runtime only elements.- Returns:
- the name of the runtime classpath configuration
- Since:
- 3.4
 
- 
getRuntimeElementsConfigurationNameString getRuntimeElementsConfigurationName()Returns the name of the configuration containing elements that are strictly required at runtime. Consumers of this configuration will get all the mandatory elements for this component to execute at runtime.- Returns:
- the name of the runtime elements configuration.
- Since:
- 3.4
 
- 
getJavadocElementsConfigurationNameString getJavadocElementsConfigurationName()Returns the name of the configuration that represents the variant that carries the Javadoc for this source set in packaged form. Used to publish a variant with a '-javadoc' zip.- Returns:
- the name of the javadoc elements configuration.
- Since:
- 6.0
 
- 
getSourcesElementsConfigurationNameString getSourcesElementsConfigurationName()Returns the name of the configuration that represents the variant that carries the original source code in packaged form. Used to publish a variant with a '-sources' zip.- Returns:
- the name of the sources elements configuration.
- Since:
- 6.0
 
- 
isMainDetermines if this source set is the main source set- Since:
- 6.7
 
 
-