JavaScript Development Tools
Release 3.2

org.eclipse.wst.jsdt.launching
Interface IJavaLaunchConfigurationConstants


public interface IJavaLaunchConfigurationConstants

Constant definitions for JavaScript launch configurations.

Constant definitions only; not to be implemented.

Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
static String ATTR_ALLOW_TERMINATE
          Launch configuration attribute key.
static String ATTR_APPLET_APPLETVIEWER_CLASS
          Launch configuration attribute key.
static String ATTR_APPLET_HEIGHT
          Launch configuration attribute key.
static String ATTR_APPLET_NAME
          Launch configuration attribute key.
static String ATTR_APPLET_PARAMETERS
          Launch configuration attribute key.
static String ATTR_APPLET_WIDTH
          Launch configuration attribute key.
static String ATTR_BOOTPATH
          Attribute key for a VM specific argument.
static String ATTR_BOOTPATH_APPEND
          Attribute key for a VM specific argument.
static String ATTR_BOOTPATH_PREPEND
          Attribute key for a VM specific argument.
static String ATTR_CLASSPATH
          Launch configuration attribute key.
static String ATTR_CLASSPATH_PROVIDER
          Launch configuration attribute key.
static String ATTR_CONNECT_MAP
          Launch configuration attribute key.
static String ATTR_DEFAULT_CLASSPATH
          Launch configuration attribute key.
static String ATTR_DEFAULT_SOURCE_PATH
          Launch configuration attribute key.
static String ATTR_JAVA_COMMAND
          Attribute key for VM specific attributes found in the ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP.
static String ATTR_JRE_CONTAINER_PATH
          Launch configuration attribute key.
static String ATTR_MAIN_TYPE_NAME
          Launch configuration attribute key.
static String ATTR_PROGRAM_ARGUMENTS
          Launch configuration attribute key.
static String ATTR_PROJECT_NAME
          Launch configuration attribute key.
static String ATTR_SOURCE_PATH
          Launch configuration attribute key.
static String ATTR_SOURCE_PATH_PROVIDER
          Launch configuration attribute key.
static String ATTR_STOP_IN_MAIN
          Launch configuration attribute key.
static String ATTR_VM_ARGUMENTS
          Launch configuration attribute key.
static String ATTR_VM_CONNECTOR
          Launch configuration attribute key.
static String ATTR_VM_INSTALL_NAME
          Deprecated. use ATTR_JRE_CONTAINER_PATH
static String ATTR_VM_INSTALL_TYPE
          Deprecated. use ATTR_JRE_CONTAINER_PATH
static String ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP
          Launch configuration attribute key.
static String ATTR_WORKING_DIRECTORY
          Launch configuration attribute key.
static String DEFAULT_APPLETVIEWER_CLASS
          Default value for the 'ATTR_APPLET_APPLETVIEWER' attribute.
static int ERR_CONNECTION_FAILED
          Status code indicating that the debugger failed to connect to the VM.
static int ERR_CONNECTOR_NOT_AVAILABLE
          Status code indicating that the JDI connector required for a debug launch was not available.
static int ERR_COULD_NOT_BUILD_HTML
          Status code indicating that the .html file used to initiate an applet launch could not be built.
static int ERR_INTERNAL_ERROR
          Status code indicating an unexpected internal error.
static int ERR_INVALID_HOSTNAME
          Status code indicating a launch configuration has specified an invalid host name attribute
static int ERR_INVALID_PORT
          Status code indicating a launch configuration has specified an invalid port number attribute
static int ERR_NO_SOCKET_AVAILABLE
          Status code indicating that a free socket was not available to communicate with the VM.
static int ERR_NOT_A_JAVA_PROJECT
          Status code indicating the project associated with a launch configuration is not a JavaScript project.
static int ERR_NOT_AN_APPLET
          Status code indicating that the applet launcher was asked to launch a resource that did not extend java.applet.Applet.
static int ERR_PROJECT_CLOSED
          Status code indicating that the project referenced by a launch configuration is closed.
static int ERR_REMOTE_VM_CONNECTION_FAILED
          Status code indicating an attempt to connect to a remote VM has failed.
static int ERR_SHARED_MEMORY_CONNECTOR_UNAVAILABLE
          Status code indicating that the shared memory attach connector could not be found.
static int ERR_UNSPECIFIED_HOSTNAME
          Status code indicating a launch configuration does not specify a host name value
static int ERR_UNSPECIFIED_LAUNCH_CONFIG
          Status code indicating that no launch configuration was specified.
static int ERR_UNSPECIFIED_MAIN_TYPE
          Status code indicating a launch configuration does not specify a main type to launch.
static int ERR_UNSPECIFIED_PORT
          Status code indicating a launch configuration does not specify a port number value
static int ERR_UNSPECIFIED_PROJECT
          Status code indicating a launch configuration does not specify a project when a project is required.
static int ERR_UNSPECIFIED_VM_INSTALL
          Status code indicating a launch configuration does not specify a VM Install
static int ERR_UNSPECIFIED_VM_INSTALL_TYPE
          Status code indicating a launch configuration does not specify a VM Install Type.
static int ERR_VM_CONNECT_TIMEOUT
          Status code indicating that a timeout has occurred waiting for the VM to connect with the debugger.
static int ERR_VM_INSTALL_DOES_NOT_EXIST
          Status code indicating a launch configuration's VM install could not be found.
static int ERR_VM_INSTALL_TYPE_DOES_NOT_EXIST
          Status code indicating a launch configuration's VM install type could not be found.
static int ERR_VM_LAUNCH_ERROR
          Status code indicating that an error occurred launching a VM.
static int ERR_VM_RUNNER_DOES_NOT_EXIST
          Status code indicating a VM runner could not be located for the VM install specified by a launch configuration.
static int ERR_WORKING_DIRECTORY_DOES_NOT_EXIST
          Status code indicating the specified working directory does not exist.
static int ERR_WORKING_DIRECTORY_NOT_SUPPORTED
          Status code indicating that the Eclipse runtime does not support launching a program with a working directory.
static String ID_JAVA_APPLET
          Identifier for the JavaScript Applet launch configuration type (value "org.eclipse.wst.jsdt.launching.javaApplet").
static String ID_JAVA_APPLICATION
          Identifier for the Local JavaScript Application launch configuration type (value "org.eclipse.wst.jsdt.launching.localJavaApplication").
static String ID_JAVA_PROCESS_TYPE
          Identifier for the javascript process type, which is annotated on processes created by the local javascript application launch delegate.
static String ID_REMOTE_JAVA_APPLICATION
          Identifier for the Remote JavaScript Application launch configuration type (value "org.eclipse.wst.jsdt.launching.remoteJavaApplication").
static String ID_SOCKET_ATTACH_VM_CONNECTOR
          Identifier for the standard Socket Attaching VM connector (value "org.eclipse.wst.jsdt.launching.socketAttachConnector").
static String MAIN_ENTRY_METHOD_NAME
           
 

Field Detail

ID_JAVA_APPLICATION

static final String ID_JAVA_APPLICATION
Identifier for the Local JavaScript Application launch configuration type (value "org.eclipse.wst.jsdt.launching.localJavaApplication").

See Also:
Constant Field Values

ID_REMOTE_JAVA_APPLICATION

static final String ID_REMOTE_JAVA_APPLICATION
Identifier for the Remote JavaScript Application launch configuration type (value "org.eclipse.wst.jsdt.launching.remoteJavaApplication").

See Also:
Constant Field Values

ID_JAVA_APPLET

static final String ID_JAVA_APPLET
Identifier for the JavaScript Applet launch configuration type (value "org.eclipse.wst.jsdt.launching.javaApplet").

See Also:
Constant Field Values

ID_SOCKET_ATTACH_VM_CONNECTOR

static final String ID_SOCKET_ATTACH_VM_CONNECTOR
Identifier for the standard Socket Attaching VM connector (value "org.eclipse.wst.jsdt.launching.socketAttachConnector").

See Also:
Constant Field Values

ID_JAVA_PROCESS_TYPE

static final String ID_JAVA_PROCESS_TYPE
Identifier for the javascript process type, which is annotated on processes created by the local javascript application launch delegate. (value "java").

See Also:
Constant Field Values

ATTR_PROJECT_NAME

static final String ATTR_PROJECT_NAME
Launch configuration attribute key. The value is a name of a JavaScript project associated with a JavaScript launch configuration.

See Also:
Constant Field Values

ATTR_MAIN_TYPE_NAME

static final String ATTR_MAIN_TYPE_NAME
Launch configuration attribute key. The value is a fully qualified name of a main type to launch.

See Also:
Constant Field Values

ATTR_STOP_IN_MAIN

static final String ATTR_STOP_IN_MAIN
Launch configuration attribute key. The value is a boolean specifying whether execution should stop when main is entered. The default value is false.

See Also:
Constant Field Values

ATTR_PROGRAM_ARGUMENTS

static final String ATTR_PROGRAM_ARGUMENTS
Launch configuration attribute key. The value is a string specifying program arguments for a JavaScript launch configuration, as they should appear on the command line.

See Also:
Constant Field Values

ATTR_VM_ARGUMENTS

static final String ATTR_VM_ARGUMENTS
Launch configuration attribute key. The value is a string specifying VM arguments for a JavaScript launch configuration, as they should appear on the command line.

See Also:
Constant Field Values

ATTR_WORKING_DIRECTORY

static final String ATTR_WORKING_DIRECTORY
Launch configuration attribute key. The value is a string specifying a path to the working directory to use when launching a local VM. When specified as an absolute path, the path represents a path in the local file system. When specified as a full path, the path represents a workspace relative path. When unspecified, the working directory defaults to the project associated with a launch configuration. When no project is associated with a launch configuration, the working directory is inherited from the current process.

See Also:
Constant Field Values

ATTR_JRE_CONTAINER_PATH

static final String ATTR_JRE_CONTAINER_PATH
Launch configuration attribute key. The value is a path identifying the JRE used when launching a local VM. The path is a includepath container corresponding to the JavaRuntime.JRE_CONTAINER includepath container.

When unspecified the default JRE for a launch configuration is used (which is the JRE associated with the project being launched, or the workspace default JRE when no project is associated with a configuration). The default JRE includepath container refers explicitly to the workspace default JRE.

See Also:
Constant Field Values

ATTR_VM_INSTALL_NAME

static final String ATTR_VM_INSTALL_NAME
Deprecated. use ATTR_JRE_CONTAINER_PATH
Launch configuration attribute key. The value is a name of a VM install to use when launching a local VM. This attribute must be qualified by a VM install type, via the ATTR_VM_INSTALL_TYPE attribute. When unspecified, the default VM is used.

See Also:
Constant Field Values

ATTR_VM_INSTALL_TYPE

static final String ATTR_VM_INSTALL_TYPE
Deprecated. use ATTR_JRE_CONTAINER_PATH
Launch configuration attribute key. The value is an identifier of a VM install type. Used in conjunction with a VM install name, to specify the VM to use when launching a local JavaScript application. The associated VM install name is specified via the attribute ATTR_VM_INSTALL_NAME.

See Also:
Constant Field Values

ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP

static final String ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP
Launch configuration attribute key. The value is a Map of attributes specific to a particular VM install type, used when launching a local Java application. The map is passed to a VMRunner via a VMRunnerConfiguration when launching a VM. The attributes in the map are implementation dependent and are limited to String keys and values.

See Also:
Constant Field Values

ATTR_VM_CONNECTOR

static final String ATTR_VM_CONNECTOR
Launch configuration attribute key. The value is an identifier of a VM connector, specifying a connector to use when attaching to a remote VM.

See Also:
Constant Field Values

ATTR_CLASSPATH

static final String ATTR_CLASSPATH
Launch configuration attribute key. The attribute value is an ordered list of strings which are mementos for runtime class path entries. When unspecified, a default includepath is generated by the includepath provider associated with a launch configuration (via the ATTR_CLASSPATH_PROVIDER attribute).

See Also:
Constant Field Values

ATTR_DEFAULT_CLASSPATH

static final String ATTR_DEFAULT_CLASSPATH
Launch configuration attribute key. The value is a boolean specifying whether a default includepath should be used when launching a local JavaScript application. When false, a includepath must be specified via the ATTR_CLASSPATH attribute. When true or unspecified, a includepath is computed by the includepath provider associated with a launch configuration.

See Also:
Constant Field Values

ATTR_CLASSPATH_PROVIDER

static final String ATTR_CLASSPATH_PROVIDER
Launch configuration attribute key. The value is an identifier of a includepath provider extension used to compute the includepath for a launch configuration. When unspecified, the default includepath provider is used - StandardClasspathProvider.

See Also:
Constant Field Values

ATTR_SOURCE_PATH

static final String ATTR_SOURCE_PATH
Launch configuration attribute key. The value is an ordered list of strings which are mementos for associated runtime includepath entries interpreted as locations in which to look for source code. When unspecified, a default source lookup path is generated by the source path provider associated with a launch configurations (via the ATTR_SOURCE_PATH_PROVIDER attribute).

See Also:
Constant Field Values

ATTR_DEFAULT_SOURCE_PATH

static final String ATTR_DEFAULT_SOURCE_PATH
Launch configuration attribute key. The value is a boolean specifying whether a default source lookup path should be used. When false a source path must be specified via the ATTR_SOURCE_PATH attribute. When true or unspecified, a source lookup path is computed by the source path provider associated with a launch configuration.

See Also:
Constant Field Values

ATTR_SOURCE_PATH_PROVIDER

static final String ATTR_SOURCE_PATH_PROVIDER
Launch configuration attribute key. The value is an identifier of a source path provider extension used to compute the source lookup path for a launch configuration. When unspecified, the default source lookup path provider is used - StandardSourcePathProvider.

See Also:
Constant Field Values

ATTR_ALLOW_TERMINATE

static final String ATTR_ALLOW_TERMINATE
Launch configuration attribute key. The value is a boolean, indicating whether a VM will support/allow the terminate action. This attribute is used for remote debugging.

See Also:
Constant Field Values

ATTR_JAVA_COMMAND

static final String ATTR_JAVA_COMMAND
Attribute key for VM specific attributes found in the ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP. The value is a String, indicating the String to use to invoke the JRE.

See Also:
Constant Field Values

ATTR_CONNECT_MAP

static final String ATTR_CONNECT_MAP
Launch configuration attribute key. The value is a map. Keys in the map correspond to arguments names returned by IVMConnector#getDefaultArguments(). Values are strings corresponding to the values to use when establishing a connection to a remote VM.

See Also:
Constant Field Values

ATTR_APPLET_WIDTH

static final String ATTR_APPLET_WIDTH
Launch configuration attribute key. The value is an integer indicating the width of the applet viewing area.

See Also:
Constant Field Values

ATTR_APPLET_HEIGHT

static final String ATTR_APPLET_HEIGHT
Launch configuration attribute key. The value is an integer indicating the height of the applet viewing area.

See Also:
Constant Field Values

ATTR_APPLET_NAME

static final String ATTR_APPLET_NAME
Launch configuration attribute key. The value is a String indicating the HTML name of the applet.

See Also:
Constant Field Values

ATTR_APPLET_PARAMETERS

static final String ATTR_APPLET_PARAMETERS
Launch configuration attribute key. The value is a Map. Keys in the map represent applet parameter names and the values in the map are the corresponding parameter values

See Also:
Constant Field Values

ATTR_APPLET_APPLETVIEWER_CLASS

static final String ATTR_APPLET_APPLETVIEWER_CLASS
Launch configuration attribute key. The value is a String indicating the fully qualified name of the applet viewer utility class to use.

See Also:
Constant Field Values

ATTR_BOOTPATH_PREPEND

static final String ATTR_BOOTPATH_PREPEND
Attribute key for a VM specific argument. Value is an array of strings describing paths in the local file system that should be prepended to the bootpath, or null if none. The value is computed dynamically at launch time and placed in the VM specific arguments map by the JavaScript application launch delegate.

See Also:
Constant Field Values

ATTR_BOOTPATH

static final String ATTR_BOOTPATH
Attribute key for a VM specific argument. Value is an array of strings describing paths in the local file system that should be placed on the bootpath explicitly, or null if none. The value is computed dynamically at launch time and placed in the VM specific arguments map by the JavaScript application launch delegate.

See Also:
Constant Field Values

ATTR_BOOTPATH_APPEND

static final String ATTR_BOOTPATH_APPEND
Attribute key for a VM specific argument. Value is an array of strings describing paths in the local file system that should be appended to the bootpath, or null if none. The value is computed dynamically at launch time and placed in the VM specific arguments map by the JavaScript application launch delegate.

See Also:
Constant Field Values

ERR_UNSPECIFIED_PROJECT

static final int ERR_UNSPECIFIED_PROJECT
Status code indicating a launch configuration does not specify a project when a project is required.

See Also:
Constant Field Values

ERR_UNSPECIFIED_MAIN_TYPE

static final int ERR_UNSPECIFIED_MAIN_TYPE
Status code indicating a launch configuration does not specify a main type to launch.

See Also:
Constant Field Values

ERR_UNSPECIFIED_VM_INSTALL_TYPE

static final int ERR_UNSPECIFIED_VM_INSTALL_TYPE
Status code indicating a launch configuration does not specify a VM Install Type.

See Also:
Constant Field Values

ERR_UNSPECIFIED_VM_INSTALL

static final int ERR_UNSPECIFIED_VM_INSTALL
Status code indicating a launch configuration does not specify a VM Install

See Also:
Constant Field Values

ERR_VM_INSTALL_TYPE_DOES_NOT_EXIST

static final int ERR_VM_INSTALL_TYPE_DOES_NOT_EXIST
Status code indicating a launch configuration's VM install type could not be found.

See Also:
Constant Field Values

ERR_VM_INSTALL_DOES_NOT_EXIST

static final int ERR_VM_INSTALL_DOES_NOT_EXIST
Status code indicating a launch configuration's VM install could not be found.

See Also:
Constant Field Values

ERR_VM_RUNNER_DOES_NOT_EXIST

static final int ERR_VM_RUNNER_DOES_NOT_EXIST
Status code indicating a VM runner could not be located for the VM install specified by a launch configuration.

See Also:
Constant Field Values

ERR_NOT_A_JAVA_PROJECT

static final int ERR_NOT_A_JAVA_PROJECT
Status code indicating the project associated with a launch configuration is not a JavaScript project.

See Also:
Constant Field Values

ERR_WORKING_DIRECTORY_DOES_NOT_EXIST

static final int ERR_WORKING_DIRECTORY_DOES_NOT_EXIST
Status code indicating the specified working directory does not exist.

See Also:
Constant Field Values

ERR_UNSPECIFIED_HOSTNAME

static final int ERR_UNSPECIFIED_HOSTNAME
Status code indicating a launch configuration does not specify a host name value

See Also:
Constant Field Values

ERR_INVALID_HOSTNAME

static final int ERR_INVALID_HOSTNAME
Status code indicating a launch configuration has specified an invalid host name attribute

See Also:
Constant Field Values

ERR_UNSPECIFIED_PORT

static final int ERR_UNSPECIFIED_PORT
Status code indicating a launch configuration does not specify a port number value

See Also:
Constant Field Values

ERR_INVALID_PORT

static final int ERR_INVALID_PORT
Status code indicating a launch configuration has specified an invalid port number attribute

See Also:
Constant Field Values

ERR_REMOTE_VM_CONNECTION_FAILED

static final int ERR_REMOTE_VM_CONNECTION_FAILED
Status code indicating an attempt to connect to a remote VM has failed.

See Also:
Constant Field Values

ERR_SHARED_MEMORY_CONNECTOR_UNAVAILABLE

static final int ERR_SHARED_MEMORY_CONNECTOR_UNAVAILABLE
Status code indicating that the shared memory attach connector could not be found.

See Also:
Constant Field Values

ERR_WORKING_DIRECTORY_NOT_SUPPORTED

static final int ERR_WORKING_DIRECTORY_NOT_SUPPORTED
Status code indicating that the Eclipse runtime does not support launching a program with a working directory. This feature is only available if Eclipse is run on a 1.3 runtime or higher.

A status handler may be registered for this error condition, and should return a Boolean indicating whether the program should be relaunched with the default working directory.

See Also:
Constant Field Values

ERR_VM_LAUNCH_ERROR

static final int ERR_VM_LAUNCH_ERROR
Status code indicating that an error occurred launching a VM. The status error message is the text that the VM wrote to standard error before exiting.

See Also:
Constant Field Values

ERR_VM_CONNECT_TIMEOUT

static final int ERR_VM_CONNECT_TIMEOUT
Status code indicating that a timeout has occurred waiting for the VM to connect with the debugger.

A status handler may be registered for this error condition, and should return a Boolean indicating whether the program should continue waiting for a connection for the associated timeout period.

See Also:
Constant Field Values

ERR_NO_SOCKET_AVAILABLE

static final int ERR_NO_SOCKET_AVAILABLE
Status code indicating that a free socket was not available to communicate with the VM.

See Also:
Constant Field Values

ERR_CONNECTOR_NOT_AVAILABLE

static final int ERR_CONNECTOR_NOT_AVAILABLE
Status code indicating that the JDI connector required for a debug launch was not available.

See Also:
Constant Field Values

ERR_CONNECTION_FAILED

static final int ERR_CONNECTION_FAILED
Status code indicating that the debugger failed to connect to the VM.

See Also:
Constant Field Values

ERR_NOT_AN_APPLET

static final int ERR_NOT_AN_APPLET
Status code indicating that the applet launcher was asked to launch a resource that did not extend java.applet.Applet.

See Also:
Constant Field Values

ERR_UNSPECIFIED_LAUNCH_CONFIG

static final int ERR_UNSPECIFIED_LAUNCH_CONFIG
Status code indicating that no launch configuration was specified.

See Also:
Constant Field Values

ERR_COULD_NOT_BUILD_HTML

static final int ERR_COULD_NOT_BUILD_HTML
Status code indicating that the .html file used to initiate an applet launch could not be built.

See Also:
Constant Field Values

ERR_PROJECT_CLOSED

static final int ERR_PROJECT_CLOSED
Status code indicating that the project referenced by a launch configuration is closed.

See Also:
Constant Field Values

ERR_INTERNAL_ERROR

static final int ERR_INTERNAL_ERROR
Status code indicating an unexpected internal error.

See Also:
Constant Field Values

DEFAULT_APPLETVIEWER_CLASS

static final String DEFAULT_APPLETVIEWER_CLASS
Default value for the 'ATTR_APPLET_APPLETVIEWER' attribute.

See Also:
Constant Field Values

MAIN_ENTRY_METHOD_NAME

static final String MAIN_ENTRY_METHOD_NAME
See Also:
Constant Field Values

JavaScript Development Tools
Release 3.2

Copyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.