IPDELauncherConstants


1   /*******************************************************************************
2    * Copyright (c) 2005, 2006 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.pde.ui.launcher;
12  
13  /**
14   * Constant definitions for PDE launch configurations.
15   * <p>
16   * Constant definitions only; not to be implemented.
17   * </p>
18   * @since 3.2
19   */
20  public interface IPDELauncherConstants {
21      
22      /**
23       * Launch configuration attribute key. The value is a string specifying
24       * workspace data location for an Eclipse application.
25       */
26      String   LOCATION = "location"; //$NON-NLS-1$
27      
28      /**
29       * Launch configuration attribute key. The value is a boolean specifying
30       * workspace data location for an Eclipse application should be cleared
31       * prior to launching.
32       */
33      String   DOCLEAR = "clearws"; //$NON-NLS-1$
34      
35      /**
36       * Launch configuration attribute key. The value is a boolean specifying
37       * whether the user should be prompted prior to clearing the workspace.
38       * 
39       * @see IPDELauncherConstants#DOCLEAR
40       */ 
41      String   ASKCLEAR = "askclear"; //$NON-NLS-1$
42          
43      /**
44       * Launch configuration attribute key. The value is a string specifying
45       * the application to run.  If the value is <code>null</code>, the default 
46       * application as specified in the target platform will be used.
47       */ 
48      String   APPLICATION = "application"; //$NON-NLS-1$
49      
50      /**
51       * Launch configuration attribute key. The value is a string specifying
52       * the product to run.
53       * 
54       * @see IPDELauncherConstants#APPLICATION
55       */     
56      String   PRODUCT = "product"; //$NON-NLS-1$
57      
58      /**
59       * Launch configuration attribute key. The value is a boolean specifying
60       * if the launch should appear in product-mode.  If the value is <code>false</code>,
61       * the launch takes place in application-mode.
62       * 
63       * @see IPDELauncherConstants#PRODUCT
64       * @see IPDELauncherConstants#APPLICATION
65       */ 
66      String   USE_PRODUCT = "useProduct"; //$NON-NLS-1$
67      
68      /**
69       * Launch configuration attribute key used in Plug-in JUnit launch configurations only. 
70       * The value is a string specifying the application to be tested.  
71       * If the value is <code>null</code>, the default UI workbench application is tested.
72       */     
73      String   APP_TO_TEST = "testApplication"; //$NON-NLS-1$
74      
75      /**
76       * Launch configuration attribute key. The value is a string specifying
77       * the name of the VM to launch with.  If the value is <code>null</code>,
78       * the default workspace VM is used.
79       */ 
80      String   VMINSTALL = "vminstall"; //$NON-NLS-1$
81      
82      /**
83       * Launch configuration attribute key. The value is a string specifying
84       * the user-entered bootstrap classpath entries. 
85       */ 
86      String   BOOTSTRAP_ENTRIES = "bootstrap"; //$NON-NLS-1$
87      
88      /**
89       * Launch configuration attribute key. The value is a boolean specifying
90       * if the default self-hosting mode should be used when launching.
91       * The default being to launch with all workspace plug-ins and all the 
92       * plug-ins that are explicitly checked on the Target Platform preference page.
93       */ 
94      String   USE_DEFAULT = "default"; //$NON-NLS-1$
95      
96      /**
97       * Launch configuration attribute key. The value is a boolean specifying
98       * if the feature-based self-hosting mode should be used.
99       * The workspace must be set up properly for the feature-based self-hosting
100      * to succeed.
101      * Check the PDE Tips and Tricks section for how to set up feature-based self-hosting.
102      */     
103     String   USEFEATURES = "usefeatures"; //$NON-NLS-1$
104     
105     /**
106      * Launch configuration attribute key. The value is a string specifying
107      * a comma-separated list of IDs of workspace plug-ins to launch with.
108      * This value is only used when the Automatic Add option is off.
109      * 
110      * @see IPDELauncherConstants#AUTOMATIC_ADD
111      */             
112     String   SELECTED_WORKSPACE_PLUGINS = "selected_workspace_plugins"; //$NON-NLS-1$
113     
114     /**
115      * Launch configuration attribute key. The value is a string specifying
116      * a comma-separated list of IDs of workspace plug-ins that are to be excluded from
117      * the launch.
118      * This value is only used when the Automatic Add option is on.
119      * 
120      * @see IPDELauncherConstants#AUTOMATIC_ADD
121      */                 
122     String   DESELECTED_WORKSPACE_PLUGINS = "deselected_workspace_plugins"; //$NON-NLS-1$
123 
124     /**
125      * Launch configuration attribute key. The value is a boolean specifying
126      * whether workspace plug-in created after the creation of a launch configuration
127      * should be added to the list of plug-ins to launch with.
128      * 
129      * If the value is <code>true</code>, then DESELECTED_WORKSPACE_PLUGINS should be used.
130      * Otherwise, SELECTED_WORKSPACE_PLUGINS should be used.
131      * 
132      * @see IPDELauncherConstants#DESELECTED_WORKSPACE_PLUGINS
133      * @see IPDELauncherConstants#SELECTED_WORKSPACE_PLUGINS
134      */                 
135     String   AUTOMATIC_ADD = "automaticAdd"; //$NON-NLS-1$
136 
137     /**
138      * Launch configuration attribute key. The value is a boolean specifying
139      * whether the list of plug-ins to run should be validate prior to launching.
140      * If problems are found, they will be reported and the user will be able to cancel or
141      * continue.
142      * If no problems are found, the launch continues as normal.
143      */                 
144     String   AUTOMATIC_VALIDATE = "automaticValidate"; //$NON-NLS-1$
145     
146     /**
147      * Launch configuration attribute key. The value is a string specifying
148      * a comma-separated list of IDs of target platform plug-ins to launch with.
149      * This value is only used when the Automatic Add option is off.
150      */                 
151     String   SELECTED_TARGET_PLUGINS = "selected_target_plugins"; //$NON-NLS-1$
152     
153     /**
154      * Launch configuration attribute key. The value is a boolean indicating
155      * whether the computation of required plug-ins on the Plug-ins tab should include
156      * the traversal of optional dependencies.
157      */     
158     String   INCLUDE_OPTIONAL = "includeOptional"; //$NON-NLS-1$
159     
160     /**
161      * Launch configuration attribute key. The value is a boolean indicating
162      * whether tracing is enabled or disabled.
163      */     
164     String   TRACING = "tracing"; //$NON-NLS-1$
165     
166     /**
167      * Launch configuration attribute key. The value is a map containing the list
168      * of options to debug with.
169      */         
170     String   TRACING_OPTIONS = "tracingOptions"; //$NON-NLS-1$
171     
172     /**
173      * Launch configuration attribute key. The value is the id of the last plug-in 
174      * that was selected on the Tracing tab.
175      */             
176     String   TRACING_SELECTED_PLUGIN = "selectedPlugin"; //$NON-NLS-1$
177     
178     /**
179      * Launch configuration attribute key. The value is the IDs of all plug-ins
180      * checked on the Tracing tab.  The value may also be "[NONE]"
181      * 
182      * @see IPDELauncherConstants#TRACING_NONE
183      */
184     String   TRACING_CHECKED = "checked"; //$NON-NLS-1$
185     
186     /**
187      * Launch configuration attribute value indicating that, although tracing is enabled,
188      * no plug-ins have been selected to be traced.
189      */
190     String   TRACING_NONE = "[NONE]"; //$NON-NLS-1$
191     
192     /**
193      * Launch configuration attribute key. The value is a boolean specifying 
194      * if PDE should generate a default configuration area for the launch.
195      * 
196      * If <code>true</code>, a configuration location in the PDE metadata area 
197      * is created.  Otherwise, the user is expected to specify a location.
198      * 
199      * @see IPDELauncherConstants#CONFIG_LOCATION
200      */             
201     String   CONFIG_USE_DEFAULT_AREA = "useDefaultConfigArea"; //$NON-NLS-1$
202 
203     /**
204      * Launch configuration attribute key. The value is a string specifying 
205      * the configuration area location for an Eclipse application launch.
206      * 
207      * This key is only used when CONFIG_USE_DEFAULT_AREA is <code>false</code>.
208      * 
209      * @see IPDELauncherConstants#CONFIG_USE_DEFAULT_AREA
210      */             
211     String   CONFIG_LOCATION = "configLocation"; //$NON-NLS-1$
212     
213     /**
214      * Launch configuration attribute key. The value is a boolean specifying 
215      * if the configuration area location should be cleared prior to launching
216     */
217     String   CONFIG_CLEAR_AREA = "clearConfig"; //$NON-NLS-1$
218     
219     /**
220      * Launch configuration atribute key.  The value is a boolean specifying
221      * if PDE should generate a default config.ini file for the launch.
222      * 
223      * If <code>true</code>, a configuration file is created.  
224      * Otherwise, the user is expected to specify a config.ini to be used as a template.
225      * 
226      * @see IPDELauncherConstants#CONFIG_TEMPLATE_LOCATION
227      */
228     String   CONFIG_GENERATE_DEFAULT = "useDefaultConfig"; //$NON-NLS-1$
229     
230     /**
231      * Launch configuration attribute key. The value is a string specifying 
232      * the location of the config.ini file to be used as a template for an 
233      * Eclipse application launch.
234      * 
235      * This key is only used when CONFIG_GENERATE_DEFAULT is <code>false</code>.
236      * 
237      * @see IPDELauncherConstants#CONFIG_GENERATE_DEFAULT
238      */                 
239     String   CONFIG_TEMPLATE_LOCATION = "templateConfig";  //$NON-NLS-1$
240     
241     /**
242      * Launch configuration attribute key. The value is a string specifying 
243      * the location of the .product file with which this launch configuration 
244      * is associated.
245      */                 
246     String   PRODUCT_FILE = "productFile"; //$NON-NLS-1$
247     
248     /**
249      * Launch configuration attribute key.  The value is the ID of an OSGi framework
250      * declared in an <code>org.eclipse.pde.ui.osgiLaunchers</code> extension point.
251      * 
252      * @since 3.3
253      */
254     String   OSGI_FRAMEWORK_ID = "osgi_framework_id"; //$NON-NLS-1$
255 
256     /**
257      * Launch configuration attribute key.  The value is a boolean specifying
258      * if the default Auto-Start for an OSGi Framework launch configuration 
259      * is <code>true</code> or <code>false</code>
260      * 
261      * @see IPDELauncherConstants#DEFAULT_START_LEVEL
262      */
263     String   DEFAULT_AUTO_START = "default_auto_start"; //$NON-NLS-1$
264     
265     /**
266      * Launch configuration attribute key.  The value is an integer specifying
267      * the default start level for bundles in an OSGi Framework launch configuration.
268      * 
269      * @see IPDELauncherConstants#DEFAULT_AUTO_START
270      */
271     String   DEFAULT_START_LEVEL = "default_start_level"; //$NON-NLS-1$
272 
273     /**
274      * Launch configuration attribute key.  The value is a comma-separated list
275      * of workspace bundles to launch with the OSGi framework.
276      * 
277      * Each token in the list is of the format:
278      * <plugin-id>@<start-level>:<auto-start>
279      * 
280      * @see IPDELauncherConstants#DEFAULT_AUTO_START
281      * @see IPDELauncherConstants#DEFAULT_START_LEVEL
282      */
283     String   WORKSPACE_BUNDLES = "workspace_bundles"; //$NON-NLS-1$
284 
285     /**
286      * Launch configuration attribute key.  The value is a comma-separated list
287      * of non-workspace bundles to launch with the OSGi framework.
288      * 
289      * Each token in the list is of the format:
290      * <plugin-id>@<start-level>:<auto-start>
291      * 
292      * @see IPDELauncherConstants#DEFAULT_AUTO_START
293      * @see IPDELauncherConstants#DEFAULT_START_LEVEL
294      */
295     String   TARGET_BUNDLES = "target_bundles"; //$NON-NLS-1$
296             
297     /**
298      * Launch configuration attribute key.  The value can be either the full path
299      * to the workspace location of a Target Definition (ie. .target file), or
300      * the ID of a target defined in an org.eclipse.pde.core.targets extension.
301      */
302     String   DEFINED_TARGET = "defined_target"; //$NON-NLS-1$
303 }
304
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags