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 | 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 multiple patterns 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 match any 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 multiple patterns 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 match any 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 match any 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 multiple patterns 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 a file 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 multiple patterns 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 a file 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 a file 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 |
FileCollection classpath
The classpath to use to compile the source files.
- Default with
scalaplugin: sourceSet.compileClasspath
File destinationDir
Note: This property is deprecated 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
DirectoryProperty destinationDirectory
The directory property that represents the directory to generate the .class files into.
- Default with
scalaplugin: sourceSet.sourceDirectorySet.destinationDirectory
Property<JavaLauncher>javaLauncher
Property<JavaLauncher>The toolchain JavaLauncher to use for executing the Scala compiler.
- Default with
scalaplugin: java.toolchain
CompileOptions options (read-only)
The Java compilation options.
FileCollection scalaClasspath
The classpath to use to load the Scala compiler.
- Default with
scalaplugin: scala-compilerdependency matching thescala-libraryversion found onclasspath
BaseScalaCompileOptions scalaCompileOptions (read-only)
The Scala compilation options.
FileCollection scalaCompilerPlugins
The Scala compiler plugins to use.
- Default with
scalaplugin: - The list of compiler plugins is resolved from the
scalaCompilerPluginsconfiguration
FileTree source (read-only)
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE.
If your sources are less strict, please change it accordingly by overriding this method in your subclass.
- Default with
scalaplugin: sourceSet.scala
String sourceCompatibility
The Java language level to use to compile the source files.
- Default with
scalaplugin: project.sourceCompatibility
String targetCompatibility
The target JVM to generate the .class files for.
- Default with
scalaplugin: project.targetCompatibility
SourceTask exclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
FileTreeElement 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 match any exclude pattern to be processed.
SourceTask exclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.
SourceTask exclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.
SourceTask exclude(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 match any exclude pattern to be processed.
SourceTask include(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
FileTreeElement as its parameter.
If includes are not provided, then all files in this container will be included. If includes are provided, then a
file must match at least one of the include patterns or specs to be included.
SourceTask include(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.
SourceTask include(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.
SourceTask include(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 a file must match at least one of the include patterns or specs to be included.
SourceTask source(Object...
Object...Adds some source to this task. The given source objects will be evaluated as per Project.files(java.lang.Object[]).