Table of Contents
| API Documentation: | ScalaCompile |
|---|
Compiles Scala source files, and optionally, Java source files.
| Property | Description |
classpath | The classpath to use to compile the source files. |
destinationDir | Deprecated Replaced The directory to generate the |
destinationDirectory | The directory property that represents the directory to generate the |
excludes | The set of exclude patterns. |
includes | The set of include patterns. |
javaLauncher | Incubating The toolchain |
options | The Java compilation options. |
scalaClasspath | The classpath to use to load the Scala compiler. |
scalaCompileOptions | The Scala compilation options. |
scalaCompilerPlugins | The Scala compiler plugins to use. |
source | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist. |
sourceCompatibility | The Java language level to use to compile the source files. |
targetCompatibility | The target JVM to generate the |
| Method | Description |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included. |
source(sources) | Adds some source to this task. The given source objects will be evaluated as per |
FileCollectionclasspath
The classpath to use to compile the source files.
- Default with
scalaplugin: sourceSet.compileClasspath
FiledestinationDir
Note: This property isdeprecated and will be removed in the next major version of Gradle.
Note: This property has been replaced by destinationDirectory.
The directory to generate the.class files into.
- Default with
scalaplugin: sourceSet.sourceDirectorySet.destinationDirectory
DirectoryPropertydestinationDirectory
The directory property that represents the directory to generate the.class files into.
- Default with
scalaplugin: sourceSet.sourceDirectorySet.destinationDirectory
Property<JavaLauncher>javaLauncher
Property<JavaLauncher>Note: This property isincubating and may change in a future version of Gradle.
The toolchainJavaLauncher to use for executing the Scala compiler.
- Default with
scalaplugin: java.toolchain
CompileOptionsoptions (read-only)
The Java compilation options.
FileCollectionscalaClasspath
The classpath to use to load the Scala compiler.
- Default with
scalaplugin: scala-compilerdependency matching thescala-libraryversion found onclasspath
BaseScalaCompileOptionsscalaCompileOptions (read-only)
The Scala compilation options.
FileCollectionscalaCompilerPlugins
The Scala compiler plugins to use.
- Default with
scalaplugin: - The list of compiler plugins is resolved from the
scalaCompilerPluginsconfiguration
FileTreesource (read-only)
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
ThePathSensitivity for the sources is configured to bePathSensitivity.ABSOLUTE.If your sources are less strict, please change it accordingly by overriding this method in your subclass.
- Default with
scalaplugin: sourceSet.scala
StringsourceCompatibility
The Java language level to use to compile the source files.
- Default with
scalaplugin: project.sourceCompatibility
StringtargetCompatibility
The target JVM to generate the.class files for.
- Default with
scalaplugin: project.targetCompatibility
SourceTaskexclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElement as its parameter. The closure should return true or false. Example:
copySpec { from'source' into'destination'//an example of excluding files from certain configuration: exclude { it.file in configurations.someConf.files }}If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskexclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
SourceTaskinclude(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElement as its parameter.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
SourceTaskinclude(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
SourceTaskinclude(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
SourceTaskinclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
SourceTasksource(Object...
Object...Adds some source to this task. The given source objects will be evaluated as perProject.files(java.lang.Object[]).