org.eclipse.jdt.internal.launching

Class StandardVMRunner

java.lang.Object

org.eclipse.jdt.launching.AbstractVMRunner

org.eclipse.jdt.internal.launching.StandardVMRunner

All Implemented Interfaces:

IVMRunner

Direct Known Subclasses:

Standard11xVMRunner, StandardVMDebugger

public class StandardVMRunner
extends AbstractVMRunner

A launcher for running Java main classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	StandardVMRunner.CommandDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected IVMInstall	fVMInstance The VM install instance
static java.lang.String	XSTART_ON_FIRST_THREAD Constant representing the -XstartOnFirstThread VM argument

Constructor Summary

Constructors

Constructor and Description
StandardVMRunner(IVMInstall vmInstance) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addArguments(java.lang.String[] args, java.util.List<java.lang.String> v) Adds the array of Strings to the given List
protected void	addBootClassPathArguments(java.util.List<java.lang.String> arguments, VMRunnerConfiguration config) Adds arguments to the bootpath
protected java.lang.String	constructProgramString(VMRunnerConfiguration config) Construct and return a String containing the full path of a java executable command such as 'java' or 'javaw.exe'.
protected java.lang.String	convertClassPath(java.lang.String[] cp)
protected java.lang.String[]	ensureEncoding(ILaunch launch, java.lang.String[] vmargs) This method is used to ensure that the JVM file encoding matches that of the console preference for file encoding.
protected boolean	fileExists(java.io.File file) Convenience method to determine if the specified file exists or not
protected double	getJavaVersion(IVMInstall fVMInstance) Returns the version of the current VM in use
protected java.lang.String	getPluginIdentifier() Returns the identifier of the plug-in this VM runner originated from.
protected java.io.File	getWorkingDir(VMRunnerConfiguration config) Returns the working directory to use for the launched VM, or null if the working directory is to be inherited from the current process.
protected java.lang.String[]	prependJREPath(java.lang.String[] env) Prepends the correct java version variable state to the environment path for Mac VMs
protected java.lang.String	renderCommandLine(java.lang.String[] commandLine) Prepares the command line from the specified array of strings
protected java.lang.String	renderDebugTarget(java.lang.String classToRun, int host) Returns the 'rendered' name for the current target
static java.lang.String	renderProcessLabel(java.lang.Process p, java.lang.String[] commandLine, java.lang.String timestamp) Returns the 'rendered' name for the specified command line
void	run(VMRunnerConfiguration config, ILaunch launch, IProgressMonitor monitor) Launches a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.
java.lang.String	showCommandLine(VMRunnerConfiguration configuration, ILaunch launch, IProgressMonitor monitor) Gets the command line required to launch a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.
protected java.lang.String[]	validateCommandLine(ILaunchConfiguration configuration, java.lang.String[] cmdLine) This method allows consumers to have a last look at the command line that will be used to start the runner just prior to launching.

Methods inherited from class org.eclipse.jdt.launching.AbstractVMRunner

abort, combineVmArgs, exec, exec, exec, getCmdLineAsString, getDefaultProcessMap, isModular, newProcess, quoteWindowsArgs

Methods inherited from class java.lang.Object

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

Field Detail

XSTART_ON_FIRST_THREAD

public static final java.lang.String XSTART_ON_FIRST_THREAD

Constant representing the -XstartOnFirstThread VM argument

Since:

3.2.200

See Also:

Constant Field Values

fVMInstance

protected IVMInstall fVMInstance

The VM install instance

Constructor Detail

StandardVMRunner

public StandardVMRunner(IVMInstall vmInstance)

Constructor

Parameters:

vmInstance - the VM

Method Detail

renderDebugTarget

protected java.lang.String renderDebugTarget(java.lang.String classToRun,
                                             int host)

Returns the 'rendered' name for the current target

Parameters:

classToRun - the class

host - the host name

Returns:

the name for the current target

renderProcessLabel

public static java.lang.String renderProcessLabel(java.lang.Process p,
                                                  java.lang.String[] commandLine,
                                                  java.lang.String timestamp)

Returns the 'rendered' name for the specified command line

Parameters:

p -

commandLine - the command line

timestamp - the run-at time for the process

Returns:

the name for the process

renderCommandLine

protected java.lang.String renderCommandLine(java.lang.String[] commandLine)

Prepares the command line from the specified array of strings

Parameters:

commandLine - the command line

Returns:

the command line label

addArguments

protected void addArguments(java.lang.String[] args,
                            java.util.List<java.lang.String> v)

Adds the array of Strings to the given List

Parameters:

args - the strings

v - the list

validateCommandLine

protected java.lang.String[] validateCommandLine(ILaunchConfiguration configuration,
                                                 java.lang.String[] cmdLine)

This method allows consumers to have a last look at the command line that will be used to start the runner just prior to launching. This method returns the new array of commands to use to start the runner with or null if the existing command line should be used.

By default this method returns null indicating that the existing command line should be used to launch

Parameters:

configuration - the backing ILaunchConfiguration

cmdLine - the existing command line

Returns:

the new command line to launch with or null if the existing one should be used

Since:

3.7.0

getWorkingDir

protected java.io.File getWorkingDir(VMRunnerConfiguration config)
                              throws CoreException

Returns the working directory to use for the launched VM, or null if the working directory is to be inherited from the current process.

Parameters:

config - the VM configuration

Returns:

the working directory to use

Throws:

CoreException - if the working directory specified by the configuration does not exist or is not a directory

getPluginIdentifier

protected java.lang.String getPluginIdentifier()

Description copied from class: AbstractVMRunner

Returns the identifier of the plug-in this VM runner originated from.

Specified by:

getPluginIdentifier in class AbstractVMRunner

Returns:

plug-in identifier

constructProgramString

protected java.lang.String constructProgramString(VMRunnerConfiguration config)
                                           throws CoreException

Construct and return a String containing the full path of a java executable command such as 'java' or 'javaw.exe'. If the configuration specifies an explicit executable, that is used.

Parameters:

config - the runner configuration

Returns:

full path to java executable

Throws:

CoreException - if unable to locate an executable

fileExists

protected boolean fileExists(java.io.File file)

Convenience method to determine if the specified file exists or not

Parameters:

file - the file to check

Returns:

true if the file indeed exists, false otherwise

convertClassPath

protected java.lang.String convertClassPath(java.lang.String[] cp)

ensureEncoding

protected java.lang.String[] ensureEncoding(ILaunch launch,
                                            java.lang.String[] vmargs)

This method is used to ensure that the JVM file encoding matches that of the console preference for file encoding. If the user explicitly declares a file encoding in the launch configuration, then that file encoding is used.

Parameters:

launch - the Launch

vmargs - the original listing of JVM arguments

Returns:

the listing of JVM arguments including file encoding if one was not specified

Since:

3.4

showCommandLine

public java.lang.String showCommandLine(VMRunnerConfiguration configuration,
                                        ILaunch launch,
                                        IProgressMonitor monitor)
                                 throws CoreException

Description copied from interface: IVMRunner

Gets the command line required to launch a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.

Parameters:

configuration - the configuration settings for this run

launch - the launch to contribute to

monitor - progress monitor or null A cancelable progress monitor is provided by the Job framework. It should be noted that the setCanceled(boolean) method should never be called on the provided monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.

Returns:

the command line string

Throws:

CoreException - if an exception occurs while getting the command line

run

public void run(VMRunnerConfiguration config,
                ILaunch launch,
                IProgressMonitor monitor)
         throws CoreException

Description copied from interface: IVMRunner

Launches a Java VM as specified in the given configuration, contributing results (debug targets and processes), to the given launch.

Parameters:

config - the configuration settings for this run

launch - the launch to contribute to

monitor - progress monitor or null A cancelable progress monitor is provided by the Job framework. It should be noted that the setCanceled(boolean) method should never be called on the provided monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.

Throws:

CoreException - if an exception occurs while launching

prependJREPath

protected java.lang.String[] prependJREPath(java.lang.String[] env)

Prepends the correct java version variable state to the environment path for Mac VMs

Parameters:

env - the current array of environment variables to run with

Returns:

the new path segments

Since:

3.3

addBootClassPathArguments

protected void addBootClassPathArguments(java.util.List<java.lang.String> arguments,
                                         VMRunnerConfiguration config)

Adds arguments to the bootpath

Parameters:

arguments - the arguments

config - the VM config

getJavaVersion

protected double getJavaVersion(IVMInstall fVMInstance)

Returns the version of the current VM in use

Returns:

the VM version