| /******************************************************************************* |
| * Copyright (c) 2000, 2005 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.jdt.launching; |
| |
| import org.eclipse.jdt.internal.launching.LaunchingPlugin; |
| |
| |
| /** |
| * Constant definitions for Java launch configurations. |
| * <p> |
| * Constant definitions only; not to be implemented. |
| * </p> |
| * @since 2.0 |
| */ |
| public interface IJavaLaunchConfigurationConstants { |
| |
| /** |
| * Identifier for the Local Java Application launch configuration type |
| * (value <code>"org.eclipse.jdt.launching.localJavaApplication"</code>). |
| */ |
| public static final String ID_JAVA_APPLICATION = LaunchingPlugin.getUniqueIdentifier() + ".localJavaApplication"; //$NON-NLS-1$ |
| |
| /** |
| * Identifier for the Remote Java Application launch configuration type |
| * (value <code>"org.eclipse.jdt.launching.remoteJavaApplication"</code>). |
| */ |
| public static final String ID_REMOTE_JAVA_APPLICATION = LaunchingPlugin.getUniqueIdentifier() + ".remoteJavaApplication"; //$NON-NLS-1$ |
| |
| /** |
| * Identifier for the Java Applet launch configuration type |
| * (value <code>"org.eclipse.jdt.launching.javaApplet"</code>). |
| */ |
| public static final String ID_JAVA_APPLET = LaunchingPlugin.getUniqueIdentifier() + ".javaApplet"; //$NON-NLS-1$ |
| |
| /** |
| * Identifier for the standard Socket Attaching VM connector |
| * (value <code>"org.eclipse.jdt.launching.socketAttachConnector"</code>). |
| */ |
| public static final String ID_SOCKET_ATTACH_VM_CONNECTOR = LaunchingPlugin.getUniqueIdentifier() + ".socketAttachConnector"; //$NON-NLS-1$ |
| |
| /** |
| * Identifier for the java process type, which is annotated on processes created |
| * by the local java application launch delegate. |
| * |
| * (value <code>"java"</code>). |
| */ |
| public static final String ID_JAVA_PROCESS_TYPE = "java"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a name of |
| * a Java project associated with a Java launch configuration. |
| */ |
| public static final String ATTR_PROJECT_NAME = LaunchingPlugin.getUniqueIdentifier() + ".PROJECT_ATTR"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a fully qualified name |
| * of a main type to launch. |
| */ |
| public static final String ATTR_MAIN_TYPE_NAME = LaunchingPlugin.getUniqueIdentifier() + ".MAIN_TYPE"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a boolean specifying |
| * whether execution should stop when main is entered. The default value |
| * is <code>false</code>. |
| * |
| * @since 2.1 |
| */ |
| public static final String ATTR_STOP_IN_MAIN = LaunchingPlugin.getUniqueIdentifier() + ".STOP_IN_MAIN"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a string specifying |
| * program arguments for a Java launch configuration, as they should appear |
| * on the command line. |
| */ |
| public static final String ATTR_PROGRAM_ARGUMENTS = LaunchingPlugin.getUniqueIdentifier() + ".PROGRAM_ARGUMENTS"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a string specifying |
| * VM arguments for a Java launch configuration, as they should appear |
| * on the command line. |
| */ |
| public static final String ATTR_VM_ARGUMENTS = LaunchingPlugin.getUniqueIdentifier() + ".VM_ARGUMENTS"; //$NON-NLS-1$ |
| |
| /** |
| * 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. |
| */ |
| public static final String ATTR_WORKING_DIRECTORY = LaunchingPlugin.getUniqueIdentifier() + ".WORKING_DIRECTORY"; //$NON-NLS-1$ |
| |
| /** |
| * 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 <code>ATTR_VM_INSTALL_TYPE</code> |
| * attribute. When unspecified, the default VM is used. |
| */ |
| public static final String ATTR_VM_INSTALL_NAME = LaunchingPlugin.getUniqueIdentifier() + ".VM_INSTALL_NAME"; //$NON-NLS-1$ |
| |
| /** |
| * 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 Java application. |
| * The associated VM install name is specified via the attribute |
| * <code>ATTR_VM_INSTALL_NAME</code>. |
| */ |
| public static final String ATTR_VM_INSTALL_TYPE = LaunchingPlugin.getUniqueIdentifier() + ".VM_INSTALL_TYPE_ID"; //$NON-NLS-1$ |
| |
| /** |
| * 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 <code>VMRunner</code> via a <code>VMRunnerConfiguration</code> |
| * when launching a VM. The attributes in the map are implementation dependent |
| * and are limited to String keys and values. |
| */ |
| public static final String ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP = LaunchingPlugin.getUniqueIdentifier() + "VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is an identifier of |
| * a VM connector, specifying a connector to use when attaching to |
| * a remote VM. |
| */ |
| public static final String ATTR_VM_CONNECTOR= LaunchingPlugin.getUniqueIdentifier() + ".VM_CONNECTOR_ID"; //$NON-NLS-1$ |
| |
| /** |
| * 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 |
| * classpath is generated by the classpath provider associated with a launch |
| * configuration (via the <code>ATTR_CLASSPATH_PROVIDER</code> attribute). |
| */ |
| public static final String ATTR_CLASSPATH = LaunchingPlugin.getUniqueIdentifier() + ".CLASSPATH"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a boolean specfying |
| * whether a default classpath should be used when launching a local |
| * Java application. When <code>false</code>, a classpath must be specified |
| * via the <code>ATTR_CLASSPATH</code> attribute. When <code>true</code> or |
| * unspecified, a classpath is computed by the classpath provider associated |
| * with a launch configuration. |
| */ |
| public static final String ATTR_DEFAULT_CLASSPATH = LaunchingPlugin.getUniqueIdentifier() + ".DEFAULT_CLASSPATH"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is an identifier of a |
| * classpath provider extension used to compute the classpath |
| * for a launch configuration. When unspecified, the default classpath |
| * provider is used - <code>StandardClasspathProvider</code>. |
| */ |
| public static final String ATTR_CLASSPATH_PROVIDER = LaunchingPlugin.getUniqueIdentifier() + ".CLASSPATH_PROVIDER"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is an ordered list of |
| * strings which are mementos for associated runtime classpath 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 |
| * <code>ATTR_SOURCE_PATH_PROVIDER</code> attribute). |
| */ |
| public static final String ATTR_SOURCE_PATH = LaunchingPlugin.getUniqueIdentifier() + ".SOURCE_PATH"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a boolean specifying |
| * whether a default source lookup path should be used. When |
| * <code>false</code> a source path must be specified via the |
| * <code>ATTR_SOURCE_PATH</code> attribute. When <code>true</code> or |
| * unspecified, a source lookup path is computed by the source path |
| * provider associated with a launch configuration. |
| */ |
| public static final String ATTR_DEFAULT_SOURCE_PATH = LaunchingPlugin.getUniqueIdentifier() + ".DEFAULT_SOURCE_PATH"; //$NON-NLS-1$ |
| |
| /** |
| * 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 - <code>StandardSourcePathProvider</code>. |
| */ |
| public static final String ATTR_SOURCE_PATH_PROVIDER = LaunchingPlugin.getUniqueIdentifier() + ".SOURCE_PATH_PROVIDER"; //$NON-NLS-1$ |
| |
| /** |
| * 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. |
| */ |
| public static final String ATTR_ALLOW_TERMINATE = LaunchingPlugin.getUniqueIdentifier() + ".ALLOW_TERMINATE"; //$NON-NLS-1$ |
| |
| /** |
| * Attribute key for VM specific attributes found in the |
| * <code>ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP</code>. The value is a String, |
| * indicating the String to use to invoke the JRE. |
| */ |
| public static final String ATTR_JAVA_COMMAND = LaunchingPlugin.getUniqueIdentifier() + ".JAVA_COMMAND"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is |
| * a map. Keys in the map correpsond to arguments names |
| * returned by <code>IVMConnector#getDefaultArguments()</code>. |
| * Values are strings corresponding to the values to use when |
| * establishing a connection to a remote VM. |
| */ |
| public static final String ATTR_CONNECT_MAP = LaunchingPlugin.getUniqueIdentifier() + ".CONNECT_MAP"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is an integer |
| * indicating the width of the applet viewing area. |
| * |
| * @since 2.1 |
| */ |
| public static final String ATTR_APPLET_WIDTH = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_WIDTH"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is an integer |
| * indicating the height of the applet viewing area. |
| * |
| * @since 2.1 |
| */ |
| public static final String ATTR_APPLET_HEIGHT = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_HEIGHT"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a String indicating the |
| * HTML name of the applet. |
| * |
| * @since 2.1 |
| */ |
| public static final String ATTR_APPLET_NAME = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_NAME"; //$NON-NLS-1$ |
| |
| /** |
| * 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 |
| * |
| * @since 2.1 |
| */ |
| public static final String ATTR_APPLET_PARAMETERS = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_PARAMETERS"; //$NON-NLS-1$ |
| |
| /** |
| * Launch configuration attribute key. The value is a String indicating the |
| * fully qualified name of the appletviewer utility class to use. |
| * |
| * @since 2.1 |
| */ |
| public static final String ATTR_APPLET_APPLETVIEWER_CLASS = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_APPLETVIEWER_CLASS"; //$NON-NLS-1$ |
| |
| /** |
| * Attribute key for a VM specific argument. Value is an array |
| * of strings desribing paths in the local file system that |
| * should be prepended to the bootpath, or <code>null</code> |
| * if none. The value is computed dynamically at launch time |
| * and placed in the VM specific arguments map by the Java |
| * application launch delegate. |
| * |
| * @since 3.0 |
| */ |
| public static final String ATTR_BOOTPATH_PREPEND = LaunchingPlugin.getUniqueIdentifier() + ".-Xbootclasspath/p:"; //$NON-NLS-1$ |
| |
| /** |
| * Attribute key for a VM specific argument. Value is an array |
| * of strings desribing paths in the local file system that |
| * should be placed on the bootpath explicitly, or <code>null</code> |
| * if none. The value is computed dynamically at launch time |
| * and placed in the VM specific arguments map by the Java |
| * application launch delegate. |
| * |
| * @since 3.0 |
| */ |
| public static final String ATTR_BOOTPATH = LaunchingPlugin.getUniqueIdentifier() + ".-Xbootclasspath:"; //$NON-NLS-1$ |
| |
| /** |
| * Attribute key for a VM specific argument. Value is an array |
| * of strings desribing paths in the local file system that |
| * should be appended to the bootpath, or <code>null</code> |
| * if none. The value is computed dynamically at launch time |
| * and placed in the VM specific arguments map by the Java |
| * application launch delegate. |
| * |
| * @since 3.0 |
| */ |
| public static final String ATTR_BOOTPATH_APPEND = LaunchingPlugin.getUniqueIdentifier() + ".-Xbootclasspath/a:"; //$NON-NLS-1$ |
| |
| /** |
| * Status code indicating a launch configuration does not |
| * specify a project when a project is required. |
| */ |
| public static final int ERR_UNSPECIFIED_PROJECT = 100; |
| |
| /** |
| * Status code indicating a launch configuration does not |
| * specify a main type to launch. |
| */ |
| public static final int ERR_UNSPECIFIED_MAIN_TYPE = 101; |
| |
| /** |
| * Status code indicating a launch configuration does not |
| * specify a VM Install Type. |
| */ |
| public static final int ERR_UNSPECIFIED_VM_INSTALL_TYPE = 102; |
| |
| /** |
| * Status code indicating a launch configuration does not |
| * specify a VM Install |
| */ |
| public static final int ERR_UNSPECIFIED_VM_INSTALL = 103; |
| |
| /** |
| * Status code indicating a launch configuration's VM install |
| * type could not be found. |
| */ |
| public static final int ERR_VM_INSTALL_TYPE_DOES_NOT_EXIST = 104; |
| |
| /** |
| * Status code indicating a launch configuration's VM install |
| * could not be found. |
| */ |
| public static final int ERR_VM_INSTALL_DOES_NOT_EXIST = 105; |
| |
| /** |
| * Status code indicating a VM runner could not be located |
| * for the VM install specified by a launch configuration. |
| */ |
| public static final int ERR_VM_RUNNER_DOES_NOT_EXIST = 106; |
| |
| /** |
| * Status code indicating the project associated with |
| * a launch configuration is not a Java project. |
| */ |
| public static final int ERR_NOT_A_JAVA_PROJECT = 107; |
| |
| /** |
| * Status code indicating the specified working directory |
| * does not exist. |
| */ |
| public static final int ERR_WORKING_DIRECTORY_DOES_NOT_EXIST = 108; |
| |
| /** |
| * Status code indicating a launch configuration does not |
| * specify a host name value |
| */ |
| public static final int ERR_UNSPECIFIED_HOSTNAME = 109; |
| |
| /** |
| * Status code indicating a launch configuration has |
| * specified an invalid host name attribute |
| */ |
| public static final int ERR_INVALID_HOSTNAME = 110; |
| |
| /** |
| * Status code indicating a launch configuration does not |
| * specify a port number value |
| */ |
| public static final int ERR_UNSPECIFIED_PORT = 111; |
| |
| /** |
| * Status code indicating a launch configuration has |
| * specified an invalid port number attribute |
| */ |
| public static final int ERR_INVALID_PORT = 112; |
| |
| /** |
| * Status code indicating an attempt to connect to a remote VM |
| * has failed. |
| */ |
| public static final int ERR_REMOTE_VM_CONNECTION_FAILED = 113; |
| |
| /** |
| * Status code indicating that the shared memory attach connector |
| * could not be found. |
| */ |
| public static final int ERR_SHARED_MEMORY_CONNECTOR_UNAVAILABLE = 114; |
| |
| /** |
| * 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. |
| * <p> |
| * 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. |
| * </p> |
| */ |
| public static final int ERR_WORKING_DIRECTORY_NOT_SUPPORTED = 115; |
| |
| /** |
| * 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. |
| */ |
| public static final int ERR_VM_LAUNCH_ERROR = 116; |
| |
| /** |
| * Status code indicating that a timeout has occurred waiting for |
| * the VM to connect with the debugger. |
| * <p> |
| * 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. |
| * </p> |
| */ |
| public static final int ERR_VM_CONNECT_TIMEOUT = 117; |
| |
| /** |
| * Status code indicating that a free socket was not available to |
| * communicate with the VM. |
| */ |
| public static final int ERR_NO_SOCKET_AVAILABLE = 118; |
| |
| /** |
| * Status code indicating that the JDI connector required for a |
| * debug launch was not available. |
| */ |
| public static final int ERR_CONNECTOR_NOT_AVAILABLE = 119; |
| |
| /** |
| * Status code indicating that the debugger failed to connect |
| * to the VM. |
| */ |
| public static final int ERR_CONNECTION_FAILED = 120; |
| |
| /** |
| * Status code indicating that the applet launcher was asked to |
| * launch a resource that did not extend <code>java.applet.Applet</code>. |
| * |
| * @since 2.1 |
| */ |
| public static final int ERR_NOT_AN_APPLET = 121; |
| |
| /** |
| * Status code indicating that no launch configuration was specified. |
| * |
| * @since 2.1 |
| */ |
| public static final int ERR_UNSPECIFIED_LAUNCH_CONFIG = 122; |
| |
| /** |
| * Status code indicating that the .html file used to initiate an applet |
| * launch could not be built. |
| * |
| * @since 2.1 |
| */ |
| public static final int ERR_COULD_NOT_BUILD_HTML = 123; |
| |
| /** |
| * Status code indicating that the project referenced by a launch configuration |
| * is closed. |
| * |
| * @since 3.0 |
| */ |
| public static final int ERR_PROJECT_CLOSED = 124; |
| |
| /** |
| * Status code indicating an unexpected internal error. |
| */ |
| public static final int ERR_INTERNAL_ERROR = 150; |
| |
| /** |
| * Default value for the 'ATTR_APPLET_APPLETVIEWER' attribute. |
| * |
| * @since 2.1 |
| */ |
| public static final String DEFAULT_APPLETVIEWER_CLASS = "sun.applet.AppletViewer"; //$NON-NLS-1$ |
| } |