org.eclipse.jdt.internal.launching

Class StandardVMDebugger

java.lang.Object

org.eclipse.jdt.launching.AbstractVMRunner

org.eclipse.jdt.internal.launching.StandardVMRunner

org.eclipse.jdt.internal.launching.StandardVMDebugger

All Implemented Interfaces:

IVMRunner

public class StandardVMDebugger
extends StandardVMRunner

A launcher for debugging Java main classes. Uses JDI to launch a VM in debug mode.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jdt.internal.launching.StandardVMRunner

StandardVMRunner.CommandDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BIN Bin path segment descriptor String equals the word: bin
protected static java.lang.String	JAVA_JVM_VERSION
protected static java.lang.String	JRE JRE path segment descriptor String equals the word: jre

Fields inherited from class org.eclipse.jdt.internal.launching.StandardVMRunner

fVMInstance, XSTART_ON_FIRST_THREAD

Constructor Summary

Constructors

Constructor and Description
StandardVMDebugger(IVMInstall vmInstance) Creates a new launcher

Method Summary

Modifier and Type	Method and Description
protected void	checkErrorMessage(IProcess process) Checks and forwards an error from the specified process
protected IDebugTarget	createDebugTarget(VMRunnerConfiguration config, ILaunch launch, int port, IProcess process, VirtualMachine vm) Creates a new debug target for the given virtual machine and system process that is connected on the specified port for the given launch.
protected ListeningConnector	getConnector() Returns the default 'com.sun.jdi.SocketListen' connector
protected java.lang.String[]	prependJREPath(java.lang.String[] env, IPath jdkpath) This method performs platform specific operations to modify the runtime path for JREs prior to launching.
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 void	specifyArguments(java.util.Map<java.lang.String,Connector.Argument> map, int portNumber) Allows arguments to be specified

Methods inherited from class org.eclipse.jdt.internal.launching.StandardVMRunner

addArguments, addBootClassPathArguments, constructProgramString, convertClassPath, ensureEncoding, fileExists, getJavaVersion, getPluginIdentifier, getWorkingDir, prependJREPath, renderCommandLine, renderDebugTarget, renderProcessLabel, validateCommandLine

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

JAVA_JVM_VERSION

protected static final java.lang.String JAVA_JVM_VERSION

Since:

3.3 OSX environment variable specifying JRE to use

See Also:

Constant Field Values

JRE

protected static final java.lang.String JRE

JRE path segment descriptor String equals the word: jre

Since:

3.3.1

See Also:

Constant Field Values

BIN

protected static final java.lang.String BIN

Bin path segment descriptor String equals the word: bin

Since:

3.3.1

See Also:

Constant Field Values

Constructor Detail

StandardVMDebugger

public StandardVMDebugger(IVMInstall vmInstance)

Creates a new launcher

Parameters:

vmInstance - the backing IVMInstall to launch

Method Detail

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.

Specified by:

showCommandLine in interface IVMRunner

Overrides:

showCommandLine in class StandardVMRunner

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.

Specified by:

run in interface IVMRunner

Overrides:

run in class StandardVMRunner

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,
                                            IPath jdkpath)

This method performs platform specific operations to modify the runtime path for JREs prior to launching. Nothing is written back to the original system path.

For Windows: Prepends the location of the JRE bin directory for the given JDK path to the PATH variable in Windows. This method assumes that the JRE is located within the JDK install directory in: /jre/bin/ where the JRE itself would be located in: /bin/ where the JDK itself is located

For Mac OS: Searches for and sets the correct state of the JAVA_VM_VERSION environment variable to ensure it matches the currently chosen VM of the launch config

Parameters:

env - the current array of environment variables to run with

jdkpath - the path to the executable (javaw).

Returns:

the altered JRE path

Since:

3.3

createDebugTarget

protected IDebugTarget createDebugTarget(VMRunnerConfiguration config,
                                         ILaunch launch,
                                         int port,
                                         IProcess process,
                                         VirtualMachine vm)

Creates a new debug target for the given virtual machine and system process that is connected on the specified port for the given launch.

Parameters:

config - run configuration used to launch the VM

launch - launch to add the target to

port - port the VM is connected to

process - associated system process

vm - JDI virtual machine

Returns:

the IDebugTarget

checkErrorMessage

protected void checkErrorMessage(IProcess process)
                          throws CoreException

Checks and forwards an error from the specified process

Parameters:

process - the process to get the error message from

Throws:

CoreException - if a problem occurs

specifyArguments

protected void specifyArguments(java.util.Map<java.lang.String,Connector.Argument> map,
                                int portNumber)

Allows arguments to be specified

Parameters:

map - argument map

portNumber - the port number

getConnector

protected ListeningConnector getConnector()

Returns the default 'com.sun.jdi.SocketListen' connector

Returns:

the ListeningConnector