org.gradle.api.tasks
[Java] Interface SourceSet

public interface SourceSet

A SourceSet represents a logical group of Java source and resources.

See the example below how SourceSet 'main' is accessed and how the SourceDirectorySet 'java' is configured to exclude some package from compilation.

 apply plugin: 'java'

 sourceSets {
   main {
     java {
       exclude 'some/unwanted/package/**'
     }
   }
 }
 

MAIN_SOURCE_SET_NAME

public java.lang.String MAIN_SOURCE_SET_NAME

The name of the main source set.

TEST_SOURCE_SET_NAME

public java.lang.String TEST_SOURCE_SET_NAME

The name of the test source set.

compiledBy

public SourceSet compiledBy(java.lang.Object... taskPaths)

Registers a set of tasks which are responsible for compiling this source set into the classes directory. The paths are evaluated as for Task.dependsOn.

Parameters:

taskPaths - The tasks which compile this source set.

Returns:

this

getAllJava

public SourceDirectorySet 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.

getAllSource

public SourceDirectorySet getAllSource()

All source files for this source set.

Returns:

the source. Never returns null.

getClasses

@Deprecated
public SourceSetOutput getClasses()

Returns SourceSetOutput that extends FileCollection which means that it provides all output directories (compiled classes, processed resources, etc.)

Provides a way to configure the default output dirs and specify additional output dirs - see SourceSetOutput

deprecated:

Use getOutput() instead.

Returns:

The output dirs, as a SourceSetOutput.

getClassesDir

@Deprecated
public java.io.File getClassesDir()

Returns the directory to assemble the compiled classes into.

deprecated:

Use getOutput().getClassesDir() instead.

Returns:

The classes dir. Never returns null.

getClassesTaskName

public java.lang.String getClassesTaskName()

Returns the name of the classes task for this source set.

Returns:

The task name. Never returns null.

getCompileClasspath

public FileCollection getCompileClasspath()

Returns the classpath used to compile this source.

Returns:

The classpath. Never returns null.

getCompileConfigurationName

public java.lang.String getCompileConfigurationName()

Returns the name of the compile configuration for this source set.

Returns:

The configuration name

getCompileJavaTaskName

public java.lang.String getCompileJavaTaskName()

Returns the name of the compile Java task for this source set.

Returns:

The task name. Never returns null.

getCompileTaskName

public java.lang.String getCompileTaskName(java.lang.String language)

Returns the name of a compile task for this source set.

Parameters:

language - The language to be compiled.

Returns:

The task name. Never returns null.

getJava

public SourceDirectorySet 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.

getName

public java.lang.String getName()

Returns the name of this source set.

Returns:

The name. Never returns null.

getOutput

public SourceSetOutput getOutput()

SourceSetOutput is a FileCollection of all output directories (compiled classes, processed resources, etc.) and it provides means configure the default output dirs and register additional output dirs. See examples in SourceSetOutput

Returns:

The output dirs, as a SourceSetOutput.

getProcessResourcesTaskName

public java.lang.String getProcessResourcesTaskName()

Returns the name of the resource process task for this source set.

Returns:

The task name. Never returns null.

getResources

public SourceDirectorySet getResources()

Returns the non-Java resources which are to be copied into the class output directory.

Returns:

the resources. Never returns null.

getRuntimeClasspath

public FileCollection getRuntimeClasspath()

Returns the classpath used to execute this source.

Returns:

The classpath. Never returns null.

getRuntimeConfigurationName

public java.lang.String getRuntimeConfigurationName()

Returns the name of the runtime configuration for this source set.

Returns:

The runtime configuration name

getTaskName

public java.lang.String getTaskName(java.lang.String verb, java.lang.String target)

Returns 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}

java

public SourceSet java(groovy.lang.Closure configureClosure)

Configures the Java source for this set.

The given closure is used to configure the SourceDirectorySet which contains the Java source.

Parameters:

configureClosure - The closure to use to configure the Java source.

Returns:

this

resources

public SourceSet resources(groovy.lang.Closure configureClosure)

Configures the non-Java resources for this set.

The given closure is used to configure the SourceDirectorySet which contains the resources.

Parameters:

configureClosure - The closure to use to configure the resources.

Returns:

this

setClassesDir

@Deprecated
public void setClassesDir(java.io.File classesDir)

Sets the directory to assemble the compiled classes into.

deprecated:

Use getOutput().setClassesDir() instead.

Parameters:

classesDir - the classes dir. Should not be null.

setCompileClasspath

public void setCompileClasspath(FileCollection classpath)

Sets the classpath used to compile this source.

Parameters:

classpath - The classpath. Should not be null.

setRuntimeClasspath

public void setRuntimeClasspath(FileCollection classpath)

Sets the classpath used to execute this source.

Parameters:

classpath - The classpath. Should not be null.

Groovy Documentation