org.apache.reef.driver.evaluator

Class JVMProcess

java.lang.Object

org.apache.reef.driver.evaluator.JVMProcess

All Implemented Interfaces:

EvaluatorProcess

public final class JVMProcess
extends Object
implements EvaluatorProcess

Defines the setup of a JVM process. Users can set JVM options via setMemory(int) and addOption(String). Runtimes can also set JVM options, but should not do so if users have set options by checking isOptionSet().

Method Summary

Methods

Modifier and Type	Method and Description
JVMProcess	addOption(String option) Add a JVM option.
List<String>	getCommandLine()
EvaluatorType	getType()
boolean	isOptionSet() Check whether custom options have been set for the process.
JVMProcess	setConfigurationFileName(String configurationFileName) Set the name of the configuration file for the Launcher.
JVMProcess	setMemory(int megaBytes) Set memory size of process in megabytes.
JVMProcess	setStandardErr(String standardErr) Names a file to which stderr will be redirected.
JVMProcess	setStandardOut(String standardOut) Names a file to which stdout will be redirected.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCommandLine

public List<String> getCommandLine()

Specified by:

getCommandLine in interface EvaluatorProcess

Returns:

the launch command line

getType

public EvaluatorType getType()

Specified by:

getType in interface EvaluatorProcess

Returns:

the type of the evaluator

setMemory

public JVMProcess setMemory(int megaBytes)

Description copied from interface: EvaluatorProcess

Set memory size of process in megabytes.

Specified by:

setMemory in interface EvaluatorProcess

Returns:

this

isOptionSet

public boolean isOptionSet()

Description copied from interface: EvaluatorProcess

Check whether custom options have been set for the process. Options are memory given via EvaluatorProcess.setMemory(int) and any other custom options supported by the specific type of evaluator process.

Specified by:

isOptionSet in interface EvaluatorProcess

Returns:

whether custom options have been set for the process

setConfigurationFileName

public JVMProcess setConfigurationFileName(String configurationFileName)

Description copied from interface: EvaluatorProcess

Set the name of the configuration file for the Launcher. This file is assumed to exist in the working directory of the process launched with this command line.

Specified by:

setConfigurationFileName in interface EvaluatorProcess

Returns:

this

setStandardOut

public JVMProcess setStandardOut(String standardOut)

Description copied from interface: EvaluatorProcess

Names a file to which stdout will be redirected.

Specified by:

setStandardOut in interface EvaluatorProcess

Returns:

this

setStandardErr

public JVMProcess setStandardErr(String standardErr)

Description copied from interface: EvaluatorProcess

Names a file to which stderr will be redirected.

Specified by:

setStandardErr in interface EvaluatorProcess

Returns:

this

addOption

public JVMProcess addOption(String option)

Add a JVM option.

Parameters:

option - The full option, e.g. "-XX:+PrintGCDetails", "-Xms500m"

Returns:

this