IJavaLaunchConfigurationConstants


1   /*******************************************************************************
2    * Copyright (c) 2000, 2007 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.jdt.launching;
12  
13  import org.eclipse.jdt.internal.launching.LaunchingPlugin;
14  
15   
16  /**
17   * Constant definitions for Java launch configurations.
18   * <p>
19   * Constant definitions only; not to be implemented.
20   * </p>
21   * @since 2.0
22   */
23  public interface IJavaLaunchConfigurationConstants {
24  
25      /**
26       * Identifier for the Local Java Application launch configuration type
27       * (value <code>"org.eclipse.jdt.launching.localJavaApplication"</code>).
28       */
29      public static final String   ID_JAVA_APPLICATION = LaunchingPlugin.getUniqueIdentifier() + ".localJavaApplication"; //$NON-NLS-1$
30      
31      /**
32       * Identifier for the Remote Java Application launch configuration type
33       * (value <code>"org.eclipse.jdt.launching.remoteJavaApplication"</code>).
34       */
35      public static final String   ID_REMOTE_JAVA_APPLICATION = LaunchingPlugin.getUniqueIdentifier() + ".remoteJavaApplication"; //$NON-NLS-1$ 
36  
37      /**
38       * Identifier for the Java Applet launch configuration type
39       * (value <code>"org.eclipse.jdt.launching.javaApplet"</code>).
40       */
41      public static final String   ID_JAVA_APPLET = LaunchingPlugin.getUniqueIdentifier() + ".javaApplet"; //$NON-NLS-1$    
42  
43      /**
44       * Identifier for the standard Socket Attaching VM connector
45       * (value <code>"org.eclipse.jdt.launching.socketAttachConnector"</code>).
46       */
47      public static final String   ID_SOCKET_ATTACH_VM_CONNECTOR = LaunchingPlugin.getUniqueIdentifier() + ".socketAttachConnector"; //$NON-NLS-1$  
48      
49      /**
50       * Identifier for the java process type, which is annotated on processes created
51       * by the local java application launch delegate.
52       * 
53       * (value <code>"java"</code>).
54       */
55      public static final String   ID_JAVA_PROCESS_TYPE = "java"; //$NON-NLS-1$ 
56              
57      /**
58       * Launch configuration attribute key. The value is a name of
59       * a Java project associated with a Java launch configuration.
60       */
61      public static final String   ATTR_PROJECT_NAME = LaunchingPlugin.getUniqueIdentifier() + ".PROJECT_ATTR"; //$NON-NLS-1$
62      
63      /**
64       * Launch configuration attribute key. The value is a fully qualified name
65       * of a main type to launch.
66       */
67      public static final String   ATTR_MAIN_TYPE_NAME = LaunchingPlugin.getUniqueIdentifier() + ".MAIN_TYPE";   //$NON-NLS-1$
68          
69      /**
70       * Launch configuration attribute key. The value is a boolean specifying
71       * whether execution should stop when main is entered. The default value
72       * is <code>false</code>.
73       * 
74       * @since 2.1
75       */
76      public static final String   ATTR_STOP_IN_MAIN = LaunchingPlugin.getUniqueIdentifier() + ".STOP_IN_MAIN";  //$NON-NLS-1$
77      
78      /**
79       * Launch configuration attribute key. The value is a string specifying
80       * program arguments for a Java launch configuration, as they should appear
81       * on the command line.
82       */
83      public static final String   ATTR_PROGRAM_ARGUMENTS = LaunchingPlugin.getUniqueIdentifier() + ".PROGRAM_ARGUMENTS"; //$NON-NLS-1$
84      
85      /**
86       * Launch configuration attribute key. The value is a string specifying
87       * VM arguments for a Java launch configuration, as they should appear
88       * on the command line.
89       */
90      public static final String   ATTR_VM_ARGUMENTS = LaunchingPlugin.getUniqueIdentifier() + ".VM_ARGUMENTS";  //$NON-NLS-1$
91      
92      /**
93       * Launch configuration attribute key. The value is a string specifying a
94       * path to the working directory to use when launching a local VM.
95       * When specified as an absolute path, the path represents a path in the local
96       * file system. When specified as a full path, the path represents a workspace
97       * relative path. When unspecified, the working directory defaults to the project
98       * associated with a launch configuration. When no project is associated with a
99       * launch configuration, the working directory is inherited from the current
100      * process.
101      */
102     public static final String   ATTR_WORKING_DIRECTORY = LaunchingPlugin.getUniqueIdentifier() + ".WORKING_DIRECTORY";    //$NON-NLS-1$
103     
104     /**
105      * Launch configuration attribute key. The value is a path identifying the JRE used
106      * when launching a local VM. The path is a classpath container corresponding
107      * to the <code>JavaRuntime.JRE_CONTAINER</code> classpath container.
108      * <p>
109      * When unspecified the default JRE for a launch configuration is used (which is the
110      * JRE associated with the project being launched, or the workspace default JRE when
111      * no project is associated with a configuration). The default JRE classpath container
112      * refers explicitly to the workspace default JRE.
113      * </p>
114      * @since 3.2
115      */
116     public static final String   ATTR_JRE_CONTAINER_PATH = JavaRuntime.JRE_CONTAINER;
117     
118     /**
119      * Launch configuration attribute key. The value is a name of a VM install
120      * to use when launching a local VM. This attribute must be qualified
121      * by a VM install type, via the <code>ATTR_VM_INSTALL_TYPE</code>
122      * attribute. When unspecified, the default VM is used.
123      * 
124      * @deprecated use <code>ATTR_JRE_CONTAINER_PATH</code>
125      */
126     public static final String   ATTR_VM_INSTALL_NAME = LaunchingPlugin.getUniqueIdentifier() + ".VM_INSTALL_NAME"; //$NON-NLS-1$
127         
128     /**
129      * Launch configuration attribute key. The value is an identifier of
130      * a VM install type. Used in conjunction with a VM install name, to 
131      * specify the VM to use when launching a local Java application.
132      * The associated VM install name is specified via the attribute
133      * <code>ATTR_VM_INSTALL_NAME</code>.
134      * 
135      * @deprecated use <code>ATTR_JRE_CONTAINER_PATH</code>
136      */
137     public static final String   ATTR_VM_INSTALL_TYPE = LaunchingPlugin.getUniqueIdentifier() + ".VM_INSTALL_TYPE_ID"; //$NON-NLS-1$
138     
139     /**
140      * Launch configuration attribute key. The value is a Map of attributes specific
141      * to a particular VM install type, used when launching a local Java
142      * application. The map is passed to a <code>VMRunner</code> via a <code>VMRunnerConfiguration</code>
143      * when launching a VM. The attributes in the map are implementation dependent
144      * and are limited to String keys and values.
145      */
146     public static final String   ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP = LaunchingPlugin.getUniqueIdentifier() + "VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP"; //$NON-NLS-1$
147     
148     /**
149      * Launch configuration attribute key. The value is an identifier of
150      * a VM connector, specifying a connector to use when attaching to
151      * a remote VM.
152      */
153     public static final String   ATTR_VM_CONNECTOR= LaunchingPlugin.getUniqueIdentifier() + ".VM_CONNECTOR_ID"; //$NON-NLS-1$
154         
155     /**
156      * Launch configuration attribute key. The attribute value is an ordered list of strings
157      * which are mementos for runtime class path entries. When unspecified, a default
158      * classpath is generated by the classpath provider associated with a launch
159      * configuration (via the <code>ATTR_CLASSPATH_PROVIDER</code> attribute).
160      */
161     public static final String   ATTR_CLASSPATH = LaunchingPlugin.getUniqueIdentifier() + ".CLASSPATH";    //$NON-NLS-1$
162     
163     /**
164      * Launch configuration attribute key. The value is a boolean specifying
165      * whether a default classpath should be used when launching a local
166      * Java application. When <code>false</code>, a classpath must be specified
167      * via the <code>ATTR_CLASSPATH</code> attribute. When <code>true</code> or
168      * unspecified, a classpath is computed by the classpath provider associated
169      * with a launch configuration.
170      */
171     public static final String   ATTR_DEFAULT_CLASSPATH = LaunchingPlugin.getUniqueIdentifier() + ".DEFAULT_CLASSPATH"; //$NON-NLS-1$
172 
173     /**
174      * Launch configuration attribute key. The value is an identifier of a
175      * classpath provider extension used to compute the classpath
176      * for a launch configuration. When unspecified, the default classpath
177      * provider is used - <code>StandardClasspathProvider</code>.
178      */
179     public static final String   ATTR_CLASSPATH_PROVIDER = LaunchingPlugin.getUniqueIdentifier() + ".CLASSPATH_PROVIDER";  //$NON-NLS-1$
180     
181     /**
182      * Launch configuration attribute key. The value is an ordered list of
183      * strings which are mementos for associated runtime classpath entries
184      * interpreted as locations in which to look for source code. When unspecified,
185      * a default source lookup path is generated by the source path provider
186      * associated with a launch configurations (via the
187      * <code>ATTR_SOURCE_PATH_PROVIDER</code> attribute).
188      */
189     public static final String   ATTR_SOURCE_PATH = LaunchingPlugin.getUniqueIdentifier() + ".SOURCE_PATH";    //$NON-NLS-1$
190         
191     /**
192      * Launch configuration attribute key. The value is a boolean specifying
193      * whether a default source lookup path should be used. When
194      * <code>false</code> a source path must be specified via the
195      * <code>ATTR_SOURCE_PATH</code> attribute. When <code>true</code> or
196      * unspecified, a source lookup path is computed by the source path
197      * provider associated with a launch configuration.
198      */
199     public static final String   ATTR_DEFAULT_SOURCE_PATH = LaunchingPlugin.getUniqueIdentifier() + ".DEFAULT_SOURCE_PATH"; //$NON-NLS-1$
200 
201     /**
202      * Launch configuration attribute key. The value is an identifier of a
203      * source path provider extension used to compute the source lookup path
204      * for a launch configuration. When unspecified, the default source lookup
205      * path provider is used - <code>StandardSourcePathProvider</code>.
206      */
207     public static final String   ATTR_SOURCE_PATH_PROVIDER = LaunchingPlugin.getUniqueIdentifier() + ".SOURCE_PATH_PROVIDER";  //$NON-NLS-1$
208             
209     /**
210      * Launch configuration attribute key. The value is a boolean, indicating
211      * whether a VM will support/allow the terminate action.
212      * This attribute is used for remote debugging.
213      */
214     public static final String   ATTR_ALLOW_TERMINATE = LaunchingPlugin.getUniqueIdentifier() + ".ALLOW_TERMINATE";    //$NON-NLS-1$
215     
216     /**
217      * Attribute key for VM specific attributes found in the
218      * <code>ATTR_VM_INSTALL_TYPE_SPECIFIC_ATTRS_MAP</code>. The value is a String,
219      * indicating the String to use to invoke the JRE.
220      */
221     public static final String   ATTR_JAVA_COMMAND = LaunchingPlugin.getUniqueIdentifier() + ".JAVA_COMMAND";  //$NON-NLS-1$
222 
223     /**
224      * Launch configuration attribute key. The value is 
225      * a map. Keys in the map correspond to arguments names
226      * returned by <code>IVMConnector#getDefaultArguments()</code>.
227      * Values are strings corresponding to the values to use when
228      * establishing a connection to a remote VM.
229      */
230     public static final String   ATTR_CONNECT_MAP = LaunchingPlugin.getUniqueIdentifier() + ".CONNECT_MAP";    //$NON-NLS-1$
231     
232     /**
233      * Launch configuration attribute key. The value is an integer
234      * indicating the width of the applet viewing area.
235      * 
236      * @since 2.1
237      */
238     public static final String   ATTR_APPLET_WIDTH = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_WIDTH";  //$NON-NLS-1$
239 
240     /**
241      * Launch configuration attribute key. The value is an integer
242      * indicating the height of the applet viewing area.
243      * 
244      * @since 2.1
245      */
246     public static final String   ATTR_APPLET_HEIGHT = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_HEIGHT";    //$NON-NLS-1$
247 
248     /**
249      * Launch configuration attribute key. The value is a String indicating the
250      * HTML name of the applet.
251      * 
252      * @since 2.1
253      */
254     public static final String   ATTR_APPLET_NAME = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_NAME";    //$NON-NLS-1$
255 
256     /**
257      * Launch configuration attribute key. The value is a Map. Keys in the map
258      * represent applet parameter names and the values in the map are the
259      * corresponding parameter values
260      * 
261      * @since 2.1
262      */
263     public static final String   ATTR_APPLET_PARAMETERS = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_PARAMETERS";    //$NON-NLS-1$
264 
265     /**
266      * Launch configuration attribute key. The value is a String indicating the
267      * fully qualified name of the applet viewer utility class to use.
268      * 
269      * @since 2.1
270      */
271     public static final String   ATTR_APPLET_APPLETVIEWER_CLASS = LaunchingPlugin.getUniqueIdentifier() + ".APPLET_APPLETVIEWER_CLASS";    //$NON-NLS-1$
272     
273     /**
274      * Attribute key for a VM specific argument. Value is an array
275      * of strings describing paths in the local file system that
276      * should be prepended to the bootpath, or <code>null</code>
277      * if none. The value is computed dynamically at launch time
278      * and placed in the VM specific arguments map by the Java 
279      * application launch delegate.
280      * 
281      * @since 3.0
282      */
283     public static final String   ATTR_BOOTPATH_PREPEND = LaunchingPlugin.getUniqueIdentifier() + ".-Xbootclasspath/p:";    //$NON-NLS-1$
284 
285     /**
286      * Attribute key for a VM specific argument. Value is an array
287      * of strings describing paths in the local file system that
288      * should be placed on the bootpath explicitly, or <code>null</code>
289      * if none. The value is computed dynamically at launch time
290      * and placed in the VM specific arguments map by the Java 
291      * application launch delegate.
292      * 
293      * @since 3.0
294      */
295     public static final String   ATTR_BOOTPATH = LaunchingPlugin.getUniqueIdentifier() + ".-Xbootclasspath:";  //$NON-NLS-1$
296     
297     /**
298      * Attribute key for a VM specific argument. Value is an array
299      * of strings describing paths in the local file system that
300      * should be appended to the bootpath, or <code>null</code>
301      * if none. The value is computed dynamically at launch time
302      * and placed in the VM specific arguments map by the Java 
303      * application launch delegate.
304      * 
305      * @since 3.0
306      */ 
307     public static final String   ATTR_BOOTPATH_APPEND = LaunchingPlugin.getUniqueIdentifier() + ".-Xbootclasspath/a:";     //$NON-NLS-1$
308 
309     /**
310      * Status code indicating a launch configuration does not
311      * specify a project when a project is required.
312      */
313     public static final int ERR_UNSPECIFIED_PROJECT = 100;  
314         
315     /**
316      * Status code indicating a launch configuration does not
317      * specify a main type to launch.
318      */
319     public static final int ERR_UNSPECIFIED_MAIN_TYPE = 101;    
320         
321     /**
322      * Status code indicating a launch configuration does not
323      * specify a VM Install Type.
324      */
325     public static final int ERR_UNSPECIFIED_VM_INSTALL_TYPE = 102;
326     
327     /**
328      * Status code indicating a launch configuration does not
329      * specify a VM Install
330      */
331     public static final int ERR_UNSPECIFIED_VM_INSTALL = 103;
332 
333     /**
334      * Status code indicating a launch configuration's VM install
335      * type could not be found.
336      */
337     public static final int ERR_VM_INSTALL_TYPE_DOES_NOT_EXIST = 104;
338         
339     /**
340      * Status code indicating a launch configuration's VM install
341      * could not be found.
342      */
343     public static final int ERR_VM_INSTALL_DOES_NOT_EXIST = 105;
344     
345     /**
346      * Status code indicating a VM runner could not be located
347      * for the VM install specified by a launch configuration.
348      */
349     public static final int ERR_VM_RUNNER_DOES_NOT_EXIST = 106; 
350     
351     /**
352      * Status code indicating the project associated with
353      * a launch configuration is not a Java project.
354      */
355     public static final int ERR_NOT_A_JAVA_PROJECT = 107;   
356     
357     /**
358      * Status code indicating the specified working directory
359      * does not exist.
360      */
361     public static final int ERR_WORKING_DIRECTORY_DOES_NOT_EXIST = 108; 
362         
363     /**
364      * Status code indicating a launch configuration does not
365      * specify a host name value
366      */
367     public static final int ERR_UNSPECIFIED_HOSTNAME = 109;
368 
369     /**
370      * Status code indicating a launch configuration has
371      * specified an invalid host name attribute
372      */
373     public static final int ERR_INVALID_HOSTNAME = 110;
374 
375     /**
376      * Status code indicating a launch configuration does not
377      * specify a port number value
378      */
379     public static final int ERR_UNSPECIFIED_PORT = 111;
380 
381     /**
382      * Status code indicating a launch configuration has
383      * specified an invalid port number attribute
384      */
385     public static final int ERR_INVALID_PORT = 112;
386 
387     /**
388      * Status code indicating an attempt to connect to a remote VM
389      * has failed.
390      */
391     public static final int ERR_REMOTE_VM_CONNECTION_FAILED = 113;
392 
393     /**
394      * Status code indicating that the shared memory attach connector
395      * could not be found.
396      */
397     public static final int ERR_SHARED_MEMORY_CONNECTOR_UNAVAILABLE = 114;
398     
399     /**
400      * Status code indicating that the Eclipse runtime does not support
401      * launching a program with a working directory. This feature is only
402      * available if Eclipse is run on a 1.3 runtime or higher.
403      * <p>
404      * A status handler may be registered for this error condition,
405      * and should return a Boolean indicating whether the program
406      * should be relaunched with the default working directory.
407      * </p>
408      */
409     public static final int ERR_WORKING_DIRECTORY_NOT_SUPPORTED = 115;  
410     
411     /**
412      * Status code indicating that an error occurred launching a VM.
413      * The status error message is the text that
414      * the VM wrote to standard error before exiting.
415      */
416     public static final int ERR_VM_LAUNCH_ERROR = 116;  
417     
418     /**
419      * Status code indicating that a timeout has occurred waiting for
420      * the VM to connect with the debugger.
421      * <p>
422      * A status handler may be registered for this error condition,
423      * and should return a Boolean indicating whether the program
424      * should continue waiting for a connection for the associated
425      * timeout period.
426      * </p>
427      */
428     public static final int ERR_VM_CONNECT_TIMEOUT = 117;   
429     
430     /**
431      * Status code indicating that a free socket was not available to
432      * communicate with the VM.
433      */
434     public static final int ERR_NO_SOCKET_AVAILABLE = 118;      
435     
436     /**
437      * Status code indicating that the JDI connector required for a
438      * debug launch was not available.
439      */
440     public static final int ERR_CONNECTOR_NOT_AVAILABLE = 119;  
441     
442     /**
443      * Status code indicating that the debugger failed to connect
444      * to the VM.
445      */
446     public static final int ERR_CONNECTION_FAILED = 120;        
447 
448     /**
449      * Status code indicating that the applet launcher was asked to
450      * launch a resource that did not extend <code>java.applet.Applet</code>.
451      * 
452      * @since 2.1
453      */
454     public static final int ERR_NOT_AN_APPLET = 121;        
455 
456     /**
457      * Status code indicating that no launch configuration was specified.
458      * 
459      * @since 2.1
460      */
461     public static final int ERR_UNSPECIFIED_LAUNCH_CONFIG = 122;        
462 
463     /**
464      * Status code indicating that the .html file used to initiate an applet
465      * launch could not be built.
466      * 
467      * @since 2.1
468      */
469     public static final int ERR_COULD_NOT_BUILD_HTML = 123;     
470     
471     /**
472      * Status code indicating that the project referenced by a launch configuration
473      * is closed.
474      * 
475      * @since 3.0
476      */
477     public static final int ERR_PROJECT_CLOSED = 124;           
478 
479     /**
480      * Status code indicating an unexpected internal error.
481      */
482     public static final int ERR_INTERNAL_ERROR = 150;       
483 
484     /**
485      * Default value for the 'ATTR_APPLET_APPLETVIEWER' attribute.
486      * 
487      * @since 2.1
488      */ 
489     public static final String   DEFAULT_APPLETVIEWER_CLASS = "sun.applet.AppletViewer";   //$NON-NLS-1$
490 }
491
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags