Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.api.tasks.scala
[Java] Class ScalaCompileOptions

    java.lang.Object
      org.gradle.api.tasks.compile.AbstractOptions
          org.gradle.api.tasks.scala.ScalaCompileOptions

    public class ScalaCompileOptions
    extends AbstractOptions

Options for Scala compilation.

Method Summary
`protected boolean` | `excludeFromAntProperties(String fieldName)`
`List` | `getAdditionalParameters()` Additional parameters passed to the compiler.
`protected String` | `getAntPropertyName(String fieldName)`
`protected Object` | `getAntPropertyValue(String fieldName, Object value)`
`String` | `getDaemonServer()` Server (host:port) on which the compile daemon is running.
`String` | `getDebugLevel()` Generate debugging information.
`String` | `getEncoding()` Encoding of source files.
`String` | `getForce()` Whether to force the compilation of all files.
`ScalaForkOptions` | `getForkOptions()` Options for running the Scala compiler in a separate process.
`IncrementalCompileOptions` | `getIncrementalOptions()`
`String` | `getLoggingLevel()` Specifies the amount of logging.
`List` | `getLoggingPhases()` Phases of the compiler to log.
`String` | `getTargetCompatibility()` Returns which backend is to be used.
`boolean` | `isDeprecation()` Generate deprecation information.
`boolean` | `isFailOnError()` Fail the build on compilation errors.
`boolean` | `isFork()` Whether to run the Scala compiler in a separate process.
`boolean` | `isListFiles()` List files to be compiled.
`boolean` | `isOptimize()` Run optimizations.
`boolean` | `isUnchecked()` Generate unchecked information.
`boolean` | `isUseAnt()` Tells whether to use Ant for compilation.
`boolean` | `isUseCompileDaemon()` Whether to use the fsc compile daemon.
`void` | `setAdditionalParameters(List additionalParameters)`
`void` | `setDaemonServer(String daemonServer)`
`void` | `setDebugLevel(String debugLevel)`
`void` | `setDeprecation(boolean deprecation)`
`void` | `setEncoding(String encoding)`
`void` | `setFailOnError(boolean failOnError)`
`void` | `setForce(String force)`
`void` | `setFork(boolean fork)`
`void` | `setForkOptions(ScalaForkOptions forkOptions)`
`void` | `setIncrementalOptions(IncrementalCompileOptions incrementalOptions)`
`void` | `setListFiles(boolean listFiles)`
`void` | `setLoggingLevel(String loggingLevel)`
`void` | `setLoggingPhases(List loggingPhases)`
`void` | `setOptimize(boolean optimize)`
`void` | `setTargetCompatibility(String targetCompatibility)` Sets which backend is to be used.
`void` | `setUnchecked(boolean unchecked)`
`void` | `setUseAnt(boolean useAnt)`
`void` | `setUseCompileDaemon(boolean useCompileDaemon)`

Methods inherited from class AbstractOptions
define, excludeFromAntProperties, getAntPropertyName, getAntPropertyValue, optionMap

Method Detail

### excludeFromAntProperties

    protected boolean excludeFromAntProperties(String fieldName)

### getAdditionalParameters

    public List getAdditionalParameters()

  Additional parameters passed to the compiler. Each parameter must start with '-'.

### getAntPropertyName

    protected String getAntPropertyName(String fieldName)

### getAntPropertyValue

    protected Object getAntPropertyValue(String fieldName, Object value)

### getDaemonServer

    public String getDaemonServer()

  Server (host:port) on which the compile daemon is running. The host must share disk access with the client process. If not specified, launches the daemon on the localhost. This parameter can only be specified if useCompileDaemon is true.

### getDebugLevel

    @Input
    @Optional
    public String getDebugLevel()

  Generate debugging information. Legal values: none, source, line, vars, notailcalls

### getEncoding

    @Input
    @Optional
    public String getEncoding()

  Encoding of source files.

### getForce

    public String getForce()

  Whether to force the compilation of all files. Legal values: - never (only compile modified files) - changed (compile all files when at least one file is modified) - always (always recompile all files)

### getForkOptions

    public ScalaForkOptions getForkOptions()

  Options for running the Scala compiler in a separate process. These options only take effect if `fork` is set to `true`.

### getIncrementalOptions

    @Nested
    public IncrementalCompileOptions getIncrementalOptions()

### getLoggingLevel

    public String getLoggingLevel()

  Specifies the amount of logging. Legal values: none, verbose, debug

### getLoggingPhases

    public List getLoggingPhases()

  Phases of the compiler to log. Legal values: namer, typer, pickler, uncurry, tailcalls, transmatch, explicitouter, erasure, lambdalift, flatten, constructors, mixin, icode, jvm, terminal.

### getTargetCompatibility

    @Input
    @Optional
    @Deprecated
    public String getTargetCompatibility()

  Returns which backend is to be used.
  deprecated:
    use ScalaCompile#getTargetCompatibility#getTargetCompatibility instead

### isDeprecation

    public boolean isDeprecation()

  Generate deprecation information.

### isFailOnError

    public boolean isFailOnError()

  Fail the build on compilation errors.

### isFork

    public boolean isFork()

  Whether to run the Scala compiler in a separate process. Defaults to `false` for the Ant based compiler (`useAnt = true`), and to `true` for the Zinc based compiler (`useAnt = false`).

### isListFiles

    public boolean isListFiles()

  List files to be compiled.

### isOptimize

    @Input
    public boolean isOptimize()

  Run optimizations.

### isUnchecked

    public boolean isUnchecked()

  Generate unchecked information.

### isUseAnt

    public boolean isUseAnt()

  Tells whether to use Ant for compilation. If `true`, the standard Ant scalac (or fsc) task will be used for Scala and Java joint compilation. If `false`, the Zinc incremental compiler will be used instead. The latter can be significantly faster, especially if there are few source code changes between compiler runs. Defaults to `true`.

### isUseCompileDaemon

    public boolean isUseCompileDaemon()

  Whether to use the fsc compile daemon.

### setAdditionalParameters

    public void setAdditionalParameters(List additionalParameters)

### setDaemonServer

    public void setDaemonServer(String daemonServer)

### setDebugLevel

    public void setDebugLevel(String debugLevel)

### setDeprecation

    public void setDeprecation(boolean deprecation)

### setEncoding

    public void setEncoding(String encoding)

### setFailOnError

    public void setFailOnError(boolean failOnError)

### setForce

    public void setForce(String force)

### setFork

    public void setFork(boolean fork)

### setForkOptions

    public void setForkOptions(ScalaForkOptions forkOptions)

### setIncrementalOptions

    public void setIncrementalOptions(IncrementalCompileOptions incrementalOptions)

### setListFiles

    public void setListFiles(boolean listFiles)

### setLoggingLevel

    public void setLoggingLevel(String loggingLevel)

### setLoggingPhases

    public void setLoggingPhases(List loggingPhases)

### setOptimize

    public void setOptimize(boolean optimize)

### setTargetCompatibility

    @Deprecated
    public void setTargetCompatibility(String targetCompatibility)

  Sets which backend is to be used.
  deprecated:
    use ScalaCompile#setTargetCompatibility#setTargetCompatibility instead

### setUnchecked

    public void setUnchecked(boolean unchecked)

### setUseAnt

    public void setUseAnt(boolean useAnt)

### setUseCompileDaemon

    public void setUseCompileDaemon(boolean useCompileDaemon)

Gradle API 1.10