org.apache.reef.runtime.common.launch

Class JavaLaunchCommandBuilder

java.lang.Object

org.apache.reef.runtime.common.launch.JavaLaunchCommandBuilder

All Implemented Interfaces:

LaunchCommandBuilder

public final class JavaLaunchCommandBuilder
extends Object
implements LaunchCommandBuilder

Build the launch command for Java REEF processes.

Constructor Summary

Constructors

Constructor and Description
JavaLaunchCommandBuilder() Constructor that populates default options, using the default Launcher class REEFLauncher.
JavaLaunchCommandBuilder(Class launcherClass, List<String> commandPrefixList) Constructor that populates prefix and uses a custom Launcher class.
JavaLaunchCommandBuilder(List<String> commandPrefixList) Constructor that uses the default Launcher class, REEFLauncher.

Method Summary

Methods

Modifier and Type	Method and Description
JavaLaunchCommandBuilder	addOption(String option) Add a JVM option.
List<String>	build()
JavaLaunchCommandBuilder	enableAssertions(boolean assertionsEnabled) Enable or disable assertions on the child process.
JavaLaunchCommandBuilder	setClassPath(Collection<String> classPathElements)
JavaLaunchCommandBuilder	setClassPath(String classPath)
JavaLaunchCommandBuilder	setConfigurationFilePaths(List<String> configurationPaths) Set the name of the configuration file for the Launcher.
JavaLaunchCommandBuilder	setJavaPath(String path) Set the path to the java executable.
JavaLaunchCommandBuilder	setMemory(int megaBytes) Set the size of the launched process in megabytes.
JavaLaunchCommandBuilder	setStandardErr(String standardErr) Names a file to which stderr will be redirected.
JavaLaunchCommandBuilder	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

Constructor Detail

JavaLaunchCommandBuilder

public JavaLaunchCommandBuilder()

Constructor that populates default options, using the default Launcher class REEFLauncher.

JavaLaunchCommandBuilder

public JavaLaunchCommandBuilder(List<String> commandPrefixList)

Constructor that uses the default Launcher class, REEFLauncher.

Parameters:

commandPrefixList -

JavaLaunchCommandBuilder

public JavaLaunchCommandBuilder(Class launcherClass,
                        List<String> commandPrefixList)

Constructor that populates prefix and uses a custom Launcher class.

Method Detail

build

public List<String> build()

Specified by:

build in interface LaunchCommandBuilder

Returns:

the launch command line

setMemory

public JavaLaunchCommandBuilder setMemory(int megaBytes)

Description copied from interface: LaunchCommandBuilder

Set the size of the launched process in megabytes.

Specified by:

setMemory in interface LaunchCommandBuilder

Returns:

this

setConfigurationFilePaths

public JavaLaunchCommandBuilder setConfigurationFilePaths(List<String> configurationPaths)

Description copied from interface: LaunchCommandBuilder

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:

setConfigurationFilePaths in interface LaunchCommandBuilder

Returns:

this

setStandardOut

public JavaLaunchCommandBuilder setStandardOut(String standardOut)

Description copied from interface: LaunchCommandBuilder

Names a file to which stdout will be redirected.

Specified by:

setStandardOut in interface LaunchCommandBuilder

Returns:

this

setStandardErr

public JavaLaunchCommandBuilder setStandardErr(String standardErr)

Description copied from interface: LaunchCommandBuilder

Names a file to which stderr will be redirected.

Specified by:

setStandardErr in interface LaunchCommandBuilder

Returns:

this

setJavaPath

public JavaLaunchCommandBuilder setJavaPath(String path)

Set the path to the java executable. Will default to a heuristic search if not set.

Parameters:

path - Path to the java executable.

Returns:

this

setClassPath

public JavaLaunchCommandBuilder setClassPath(String classPath)

setClassPath

public JavaLaunchCommandBuilder setClassPath(Collection<String> classPathElements)

addOption

public JavaLaunchCommandBuilder addOption(String option)

Add a JVM option.

Parameters:

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

Returns:

this

enableAssertions

public JavaLaunchCommandBuilder enableAssertions(boolean assertionsEnabled)

Enable or disable assertions on the child process. If not set, the setting is taken from the JVM that executes the code.

Parameters:

assertionsEnabled - If true, enable assertions.

Returns:

this