001: /*******************************************************************************
002: * Copyright (c) 2005, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.pde.ui.launcher;
011:
012: /**
013: * Constant definitions for PDE launch configurations.
014: * <p>
015: * Constant definitions only; not to be implemented.
016: * </p>
017: * @since 3.2
018: */
019: public interface IPDELauncherConstants {
020:
021: /**
022: * Launch configuration attribute key. The value is a string specifying
023: * workspace data location for an Eclipse application.
024: */
025: String LOCATION = "location"; //$NON-NLS-1$
026:
027: /**
028: * Launch configuration attribute key. The value is a boolean specifying
029: * workspace data location for an Eclipse application should be cleared
030: * prior to launching.
031: */
032: String DOCLEAR = "clearws"; //$NON-NLS-1$
033:
034: /**
035: * Launch configuration attribute key. The value is a boolean specifying
036: * whether the user should be prompted prior to clearing the workspace.
037: *
038: * @see IPDELauncherConstants#DOCLEAR
039: */
040: String ASKCLEAR = "askclear"; //$NON-NLS-1$
041:
042: /**
043: * Launch configuration attribute key. The value is a string specifying
044: * the application to run. If the value is <code>null</code>, the default
045: * application as specified in the target platform will be used.
046: */
047: String APPLICATION = "application"; //$NON-NLS-1$
048:
049: /**
050: * Launch configuration attribute key. The value is a string specifying
051: * the product to run.
052: *
053: * @see IPDELauncherConstants#APPLICATION
054: */
055: String PRODUCT = "product"; //$NON-NLS-1$
056:
057: /**
058: * Launch configuration attribute key. The value is a boolean specifying
059: * if the launch should appear in product-mode. If the value is <code>false</code>,
060: * the launch takes place in application-mode.
061: *
062: * @see IPDELauncherConstants#PRODUCT
063: * @see IPDELauncherConstants#APPLICATION
064: */
065: String USE_PRODUCT = "useProduct"; //$NON-NLS-1$
066:
067: /**
068: * Launch configuration attribute key used in Plug-in JUnit launch configurations only.
069: * The value is a string specifying the application to be tested.
070: * If the value is <code>null</code>, the default UI workbench application is tested.
071: */
072: String APP_TO_TEST = "testApplication"; //$NON-NLS-1$
073:
074: /**
075: * Launch configuration attribute key. The value is a boolean specifying
076: * if the launch should use a specific installed VM install or an Execution Environment
077: * to launch with. If the value is <code>false</code>, the launch uses an Execution Environment.
078: */
079: String USE_VMINSTALL = "useNamedJRE"; //$NON-NLS-1$
080:
081: /**
082: * Launch configuration attribute key. The value is a string specifying
083: * the name of the VM to launch with. If the value is <code>null</code>,
084: * the default workspace VM is used.
085: */
086: String VMINSTALL = "vminstall"; //$NON-NLS-1$
087:
088: /**
089: * Launch configuration attribute key. The value is a string specifying
090: * the name of the EE to launch with.
091: */
092: String EXECUTION_ENVIRONMENT = "execEnvironment"; //$NON-NLS-1$
093:
094: /**
095: * Launch configuration attribute key. The value is a string specifying
096: * the user-entered bootstrap classpath entries.
097: */
098: String BOOTSTRAP_ENTRIES = "bootstrap"; //$NON-NLS-1$
099:
100: /**
101: * Launch configuration attribute key. The value is a boolean specifying
102: * if the default self-hosting mode should be used when launching.
103: * The default being to launch with all workspace plug-ins and all the
104: * plug-ins that are explicitly checked on the Target Platform preference page.
105: */
106: String USE_DEFAULT = "default"; //$NON-NLS-1$
107:
108: /**
109: * Launch configuration attribute key. The value is a boolean specifying
110: * if the feature-based self-hosting mode should be used.
111: * The workspace must be set up properly for the feature-based self-hosting
112: * to succeed.
113: * Check the PDE Tips and Tricks section for how to set up feature-based self-hosting.
114: */
115: String USEFEATURES = "usefeatures"; //$NON-NLS-1$
116:
117: /**
118: * Launch configuration attribute key. The value is a string specifying
119: * a comma-separated list of IDs of workspace plug-ins to launch with.
120: * This value is only used when the Automatic Add option is off.
121: *
122: * @see IPDELauncherConstants#AUTOMATIC_ADD
123: */
124: String SELECTED_WORKSPACE_PLUGINS = "selected_workspace_plugins"; //$NON-NLS-1$
125:
126: /**
127: * Launch configuration attribute key. The value is a string specifying
128: * a comma-separated list of IDs of workspace plug-ins that are to be excluded from
129: * the launch.
130: * This value is only used when the Automatic Add option is on.
131: *
132: * @see IPDELauncherConstants#AUTOMATIC_ADD
133: */
134: String DESELECTED_WORKSPACE_PLUGINS = "deselected_workspace_plugins"; //$NON-NLS-1$
135:
136: /**
137: * Launch configuration attribute key. The value is a boolean specifying
138: * whether workspace plug-in created after the creation of a launch configuration
139: * should be added to the list of plug-ins to launch with.
140: *
141: * If the value is <code>true</code>, then DESELECTED_WORKSPACE_PLUGINS should be used.
142: * Otherwise, SELECTED_WORKSPACE_PLUGINS should be used.
143: *
144: * @see IPDELauncherConstants#DESELECTED_WORKSPACE_PLUGINS
145: * @see IPDELauncherConstants#SELECTED_WORKSPACE_PLUGINS
146: */
147: String AUTOMATIC_ADD = "automaticAdd"; //$NON-NLS-1$
148:
149: /**
150: * Launch configuration attribute key. The value is a boolean specifying
151: * whether the list of plug-ins to run should be validate prior to launching.
152: * If problems are found, they will be reported and the user will be able to cancel or
153: * continue.
154: * If no problems are found, the launch continues as normal.
155: */
156: String AUTOMATIC_VALIDATE = "automaticValidate"; //$NON-NLS-1$
157:
158: /**
159: * Launch configuration attribute key. The value is a string specifying
160: * a comma-separated list of IDs of target platform plug-ins to launch with.
161: * This value is only used when the Automatic Add option is off.
162: */
163: String SELECTED_TARGET_PLUGINS = "selected_target_plugins"; //$NON-NLS-1$
164:
165: /**
166: * Launch configuration attribute key. The value is a boolean indicating
167: * whether the computation of required plug-ins on the Plug-ins tab should include
168: * the traversal of optional dependencies.
169: */
170: String INCLUDE_OPTIONAL = "includeOptional"; //$NON-NLS-1$
171:
172: /**
173: * Launch configuration attribute key. The value is a boolean indicating
174: * whether tracing is enabled or disabled.
175: */
176: String TRACING = "tracing"; //$NON-NLS-1$
177:
178: /**
179: * Launch configuration attribute key. The value is a map containing the list
180: * of options to debug with.
181: */
182: String TRACING_OPTIONS = "tracingOptions"; //$NON-NLS-1$
183:
184: /**
185: * Launch configuration attribute key. The value is the id of the last plug-in
186: * that was selected on the Tracing tab.
187: */
188: String TRACING_SELECTED_PLUGIN = "selectedPlugin"; //$NON-NLS-1$
189:
190: /**
191: * Launch configuration attribute key. The value is the IDs of all plug-ins
192: * checked on the Tracing tab. The value may also be "[NONE]"
193: *
194: * @see IPDELauncherConstants#TRACING_NONE
195: */
196: String TRACING_CHECKED = "checked"; //$NON-NLS-1$
197:
198: /**
199: * Launch configuration attribute value indicating that, although tracing is enabled,
200: * no plug-ins have been selected to be traced.
201: */
202: String TRACING_NONE = "[NONE]"; //$NON-NLS-1$
203:
204: /**
205: * Launch configuration attribute key. The value is a boolean specifying
206: * if PDE should generate a default configuration area for the launch.
207: *
208: * If <code>true</code>, a configuration location in the PDE metadata area
209: * is created. Otherwise, the user is expected to specify a location.
210: *
211: * @see IPDELauncherConstants#CONFIG_LOCATION
212: */
213: String CONFIG_USE_DEFAULT_AREA = "useDefaultConfigArea"; //$NON-NLS-1$
214:
215: /**
216: * Launch configuration attribute key. The value is a string specifying
217: * the configuration area location for an Eclipse application launch.
218: *
219: * This key is only used when CONFIG_USE_DEFAULT_AREA is <code>false</code>.
220: *
221: * @see IPDELauncherConstants#CONFIG_USE_DEFAULT_AREA
222: */
223: String CONFIG_LOCATION = "configLocation"; //$NON-NLS-1$
224:
225: /**
226: * Launch configuration attribute key. The value is a boolean specifying
227: * if the configuration area location should be cleared prior to launching
228: */
229: String CONFIG_CLEAR_AREA = "clearConfig"; //$NON-NLS-1$
230:
231: /**
232: * Launch configuration atribute key. The value is a boolean specifying
233: * if PDE should generate a default config.ini file for the launch.
234: *
235: * If <code>true</code>, a configuration file is created.
236: * Otherwise, the user is expected to specify a config.ini to be used as a template.
237: *
238: * @see IPDELauncherConstants#CONFIG_TEMPLATE_LOCATION
239: */
240: String CONFIG_GENERATE_DEFAULT = "useDefaultConfig"; //$NON-NLS-1$
241:
242: /**
243: * Launch configuration attribute key. The value is a string specifying
244: * the location of the config.ini file to be used as a template for an
245: * Eclipse application launch.
246: *
247: * This key is only used when CONFIG_GENERATE_DEFAULT is <code>false</code>.
248: *
249: * @see IPDELauncherConstants#CONFIG_GENERATE_DEFAULT
250: */
251: String CONFIG_TEMPLATE_LOCATION = "templateConfig"; //$NON-NLS-1$
252:
253: /**
254: * Launch configuration attribute key. The value is a string specifying
255: * the location of the .product file with which this launch configuration
256: * is associated.
257: */
258: String PRODUCT_FILE = "productFile"; //$NON-NLS-1$
259:
260: /**
261: * Launch configuration attribute key. The value is the ID of an OSGi framework
262: * declared in an <code>org.eclipse.pde.ui.osgiLaunchers</code> extension point.
263: *
264: * @since 3.3
265: */
266: String OSGI_FRAMEWORK_ID = "osgi_framework_id"; //$NON-NLS-1$
267:
268: /**
269: * Launch configuration attribute key. The value is a boolean specifying
270: * if the default Auto-Start for an OSGi Framework launch configuration
271: * is <code>true</code> or <code>false</code>
272: *
273: * @see IPDELauncherConstants#DEFAULT_START_LEVEL
274: */
275: String DEFAULT_AUTO_START = "default_auto_start"; //$NON-NLS-1$
276:
277: /**
278: * Launch configuration attribute key. The value is an integer specifying
279: * the default start level for bundles in an OSGi Framework launch configuration.
280: *
281: * @see IPDELauncherConstants#DEFAULT_AUTO_START
282: */
283: String DEFAULT_START_LEVEL = "default_start_level"; //$NON-NLS-1$
284:
285: /**
286: * Launch configuration attribute key. The value is a comma-separated list
287: * of 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 WORKSPACE_BUNDLES = "workspace_bundles"; //$NON-NLS-1$
296:
297: /**
298: * Launch configuration attribute key. The value is a comma-separated list
299: * of non-workspace bundles to launch with the OSGi framework.
300: *
301: * Each token in the list is of the format:
302: * <plugin-id>@<start-level>:<auto-start>
303: *
304: * @see IPDELauncherConstants#DEFAULT_AUTO_START
305: * @see IPDELauncherConstants#DEFAULT_START_LEVEL
306: */
307: String TARGET_BUNDLES = "target_bundles"; //$NON-NLS-1$
308:
309: /**
310: * Launch configuration attribute key. The value can be either the full path
311: * to the workspace location of a Target Definition (ie. .target file), or
312: * the ID of a target defined in an org.eclipse.pde.core.targets extension.
313: */
314: String DEFINED_TARGET = "defined_target"; //$NON-NLS-1$
315: }
|