ForkOptions

Configures forking.

javaHome: The Java installation to use. If not defined, the Java home for the current process is used.
outputStrategy: Configures the forked standard output and error streams. If not defined, StdoutOutput is used, which maps the forked output to the output of this process and the forked error to the error stream of the forking process.
bootJars: The list of jars to put on the forked boot classpath. By default, this is empty.
workingDirectory: The directory to use as the working directory for the forked process. By default, this is the working directory of the forking process.
runJVMOptions: The options to prepend to all user-specified arguments. By default, this is empty.
connectInput: If true, the standard input of the forked process is connected to the standard input of this process. Otherwise, it is connected to an empty input stream. Connecting input streams can be problematic, especially on versions before Java 7.
envVars: The environment variables to provide to the forked process. By default, none are provided.

Linear Supertypes

Serializable, Serializable, Product, Equals, ForkScalaRun, ForkScala, ForkJava, AnyRef, Any

Instance Constructors

new ForkOptions(javaHome: Option[File] = None, outputStrategy: Option[OutputStrategy] = None, bootJars: Seq[File] = Nil, workingDirectory: Option[File] = None, runJVMOptions: Seq[String] = Nil, connectInput: Boolean = false, envVars: Map[String, String] = Map.empty)

javaHome
The Java installation to use. If not defined, the Java home for the current process is used.
outputStrategy
Configures the forked standard output and error streams. If not defined, StdoutOutput is used, which maps the forked output to the output of this process and the forked error to the error stream of the forking process.
bootJars
The list of jars to put on the forked boot classpath. By default, this is empty.
workingDirectory
The directory to use as the working directory for the forked process. By default, this is the working directory of the forking process.
runJVMOptions
The options to prepend to all user-specified arguments. By default, this is empty.
connectInput
If true, the standard input of the forked process is connected to the standard input of this process. Otherwise, it is connected to an empty input stream. Connecting input streams can be problematic, especially on versions before Java 7.
envVars
The environment variables to provide to the forked process. By default, none are provided.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bootJars: Seq[File]

The list of jars to put on the forked boot classpath.
The list of jars to put on the forked boot classpath. By default, this is empty.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val connectInput: Boolean

If true, the standard input of the forked process is connected to the standard input of this process.
If true, the standard input of the forked process is connected to the standard input of this process. Otherwise, it is connected to an empty input stream. Connecting input streams can be problematic, especially on versions before Java 7.

Definition Classes
ForkOptions → ForkJava
val envVars: Map[String, String]

The environment variables to provide to the forked process.
The environment variables to provide to the forked process. By default, none are provided.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val javaHome: Option[File]

The Java installation to use.
The Java installation to use. If not defined, the Java home for the current process is used.

Definition Classes
ForkOptions → ForkJava
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outputStrategy: Option[OutputStrategy]

Configures the forked standard output and error streams.
Configures the forked standard output and error streams. If not defined, StdoutOutput is used, which maps the forked output to the output of this process and the forked error to the error stream of the forking process.

Definition Classes
ForkOptions → ForkJava
val runJVMOptions: Seq[String]

The options to prepend to all user-specified arguments.
The options to prepend to all user-specified arguments. By default, this is empty.

Definition Classes
ForkOptions → ForkScalaRun
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val workingDirectory: Option[File]

The directory to use as the working directory for the forked process.
The directory to use as the working directory for the forked process. By default, this is the working directory of the forking process.

Definition Classes
ForkOptions → ForkScalaRun

Deprecated Value Members

def scalaJars: Iterable[File]

Definition Classes
ForkOptions → ForkScala
Annotations
@deprecated
Deprecated
(Since version 0.13.0) Use bootJars.

Related Doc: package sbt

Instance Constructors

new ForkOptions(javaHome: Option[File] = None, outputStrategy: Option[OutputStrategy] = None, bootJars: Seq[File] = Nil, workingDirectory: Option[File] = None, runJVMOptions: Seq[String] = Nil, connectInput: Boolean = false, envVars: Map[String, String] = Map.empty)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val bootJars: Seq[File]

def clone(): AnyRef

val connectInput: Boolean

val envVars: Map[String, String]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val javaHome: Option[File]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputStrategy: Option[OutputStrategy]

val runJVMOptions: Seq[String]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val workingDirectory: Option[File]

Deprecated Value Members

def scalaJars: Iterable[File]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ForkScalaRun

Inherited from ForkScala

Inherited from ForkJava

Inherited from AnyRef

Inherited from Any

Ungrouped