org.eclipse.pde.ui.launcher
Interface IPDELauncherConstants

All Known Implementing Classes:

ConfigurationTab, MainTab

public interface IPDELauncherConstants

Constant definitions for PDE launch configurations.

Constant definitions only; not to be implemented.

Since:

3.2

Restriction

This interface is not intended to be implemented by clients.

Field Summary

static String	APP_TO_TEST Launch configuration attribute key used in Plug-in JUnit launch configurations only.
static String	APPLICATION Launch configuration attribute key.
static String	ASKCLEAR Launch configuration attribute key.
static String	AUTOMATIC_ADD Launch configuration attribute key.
static String	AUTOMATIC_VALIDATE Launch configuration attribute key.
static String	BOOTSTRAP_ENTRIES Launch configuration attribute key.
static String	CONFIG_CLEAR_AREA Launch configuration attribute key.
static String	CONFIG_GENERATE_DEFAULT Launch configuration atribute key.
static String	CONFIG_LOCATION Launch configuration attribute key.
static String	CONFIG_TEMPLATE_LOCATION Launch configuration attribute key.
static String	CONFIG_USE_DEFAULT_AREA Launch configuration attribute key.
static String	DEFAULT_AUTO_START Launch configuration attribute key.
static String	DEFAULT_START_LEVEL Launch configuration attribute key.
static String	DEFINED_TARGET Launch configuration attribute key.
static String	DESELECTED_WORKSPACE_PLUGINS Launch configuration attribute key.
static String	DOCLEAR Launch configuration attribute key.
static String	INCLUDE_OPTIONAL Launch configuration attribute key.
static String	LOCATION Launch configuration attribute key.
static String	OSGI_CONFIGURATION_TYPE The launch configuration type id for OSGi launches.
static String	OSGI_FRAMEWORK_ID Launch configuration attribute key.
static String	PRODUCT Launch configuration attribute key.
static String	PRODUCT_FILE Launch configuration attribute key.
static String	SELECTED_TARGET_PLUGINS Launch configuration attribute key.
static String	SELECTED_WORKSPACE_PLUGINS Launch configuration attribute key.
static String	SHOW_SELECTED_ONLY Launch configuration attribute key.
static String	TAB_BUNDLES_ID The unique tab identifier for the bundles tab
static String	TAB_CONFIGURATION_ID The unique tab identifier for the configuration tab
static String	TAB_MAIN_ID The unique tab identifier for the main tab
static String	TAB_OSGI_SETTINGS_ID The unique tab identifier for the osgi settings tab
static String	TAB_PLUGIN_JUNIT_MAIN_ID The unique tab identifier for the plug-in junit tab
static String	TAB_PLUGINS_ID The unique tab identifier for the plug-ins tab
static String	TAB_TRACING_ID The unique tab identifier for the tracing tab
static String	TARGET_BUNDLES Launch configuration attribute key.
static String	TRACING Launch configuration attribute key.
static String	TRACING_CHECKED Launch configuration attribute key.
static String	TRACING_NONE Launch configuration attribute value indicating that, although tracing is enabled, no plug-ins have been selected to be traced.
static String	TRACING_OPTIONS Launch configuration attribute key.
static String	TRACING_SELECTED_PLUGIN Launch configuration attribute key.
static String	USE_DEFAULT Launch configuration attribute key.
static String	USE_PRODUCT Launch configuration attribute key.
static String	USEFEATURES Launch configuration attribute key.
static String	VMINSTALL Deprecated. use IJavaLaunchConfigurationConstants.ATTR_JRE_CONTAINER_PATH
static String	WORKSPACE_BUNDLES Launch configuration attribute key.

Field Detail

LOCATION

public static final String LOCATION

Launch configuration attribute key. The value is a string specifying workspace data location for an Eclipse application.

See Also:

Constant Field Values

DOCLEAR

public static final String DOCLEAR

Launch configuration attribute key. The value is a boolean specifying workspace data location for an Eclipse application should be cleared prior to launching.

See Also:

Constant Field Values

ASKCLEAR

public static final String ASKCLEAR

Launch configuration attribute key. The value is a boolean specifying whether the user should be prompted prior to clearing the workspace.

See Also:

DOCLEAR, Constant Field Values

APPLICATION

public static final String APPLICATION

Launch configuration attribute key. The value is a string specifying the application to run. If the value is null, the default application as specified in the target platform will be used.

See Also:

Constant Field Values

PRODUCT

public static final String PRODUCT

Launch configuration attribute key. The value is a string specifying the product to run.

See Also:

APPLICATION, Constant Field Values

USE_PRODUCT

public static final String USE_PRODUCT

Launch configuration attribute key. The value is a boolean specifying if the launch should appear in product-mode. If the value is false, the launch takes place in application-mode.

See Also:

PRODUCT, APPLICATION, Constant Field Values

APP_TO_TEST

public static final String APP_TO_TEST

Launch configuration attribute key used in Plug-in JUnit launch configurations only. The value is a string specifying the application to be tested. If the value is null, the default UI workbench application is tested.

See Also:

Constant Field Values

VMINSTALL

public static final String VMINSTALL

Deprecated. use IJavaLaunchConfigurationConstants.ATTR_JRE_CONTAINER_PATH

Launch configuration attribute key. The value is a string specifying the name of the VM to launch with. If the value is null, the default workspace VM is used.

See Also:

Constant Field Values

BOOTSTRAP_ENTRIES

public static final String BOOTSTRAP_ENTRIES

Launch configuration attribute key. The value is a string specifying the user-entered bootstrap classpath entries.

See Also:

Constant Field Values

USE_DEFAULT

public static final String USE_DEFAULT

Launch configuration attribute key. The value is a boolean specifying if the default self-hosting mode should be used when launching. The default being to launch with all workspace plug-ins and all the plug-ins that are explicitly checked on the Target Platform preference page.

See Also:

Constant Field Values

USEFEATURES

public static final String USEFEATURES

Launch configuration attribute key. The value is a boolean specifying if the feature-based self-hosting mode should be used. The workspace must be set up properly for the feature-based self-hosting to succeed. Check the PDE Tips and Tricks section for how to set up feature-based self-hosting.

See Also:

Constant Field Values

SELECTED_WORKSPACE_PLUGINS

public static final String SELECTED_WORKSPACE_PLUGINS

Launch configuration attribute key. The value is a string specifying a comma-separated list of IDs of workspace plug-ins to launch with. This value is only used when the Automatic Add option is off.

See Also:

AUTOMATIC_ADD, Constant Field Values

DESELECTED_WORKSPACE_PLUGINS

public static final String DESELECTED_WORKSPACE_PLUGINS

Launch configuration attribute key. The value is a string specifying a comma-separated list of IDs of workspace plug-ins that are to be excluded from the launch. This value is only used when the Automatic Add option is on.

See Also:

AUTOMATIC_ADD, Constant Field Values

AUTOMATIC_ADD

public static final String AUTOMATIC_ADD

Launch configuration attribute key. The value is a boolean specifying whether workspace plug-in created after the creation of a launch configuration should be added to the list of plug-ins to launch with. If the value is true, then DESELECTED_WORKSPACE_PLUGINS should be used. Otherwise, SELECTED_WORKSPACE_PLUGINS should be used.

See Also:

DESELECTED_WORKSPACE_PLUGINS, SELECTED_WORKSPACE_PLUGINS, Constant Field Values

AUTOMATIC_VALIDATE

public static final String AUTOMATIC_VALIDATE

Launch configuration attribute key. The value is a boolean specifying whether the list of plug-ins to run should be validate prior to launching. If problems are found, they will be reported and the user will be able to cancel or continue. If no problems are found, the launch continues as normal.

See Also:

Constant Field Values

SELECTED_TARGET_PLUGINS

public static final String SELECTED_TARGET_PLUGINS

Launch configuration attribute key. The value is a string specifying a comma-separated list of IDs of target platform plug-ins to launch with. This value is only used when the Automatic Add option is off.

See Also:

Constant Field Values

INCLUDE_OPTIONAL

public static final String INCLUDE_OPTIONAL

Launch configuration attribute key. The value is a boolean indicating whether the computation of required plug-ins on the Plug-ins tab should include the traversal of optional dependencies.

See Also:

Constant Field Values

TRACING

public static final String TRACING

Launch configuration attribute key. The value is a boolean indicating whether tracing is enabled or disabled.

See Also:

Constant Field Values

TRACING_OPTIONS

public static final String TRACING_OPTIONS

Launch configuration attribute key. The value is a map containing the list of options to debug with.

See Also:

Constant Field Values

TRACING_SELECTED_PLUGIN

public static final String TRACING_SELECTED_PLUGIN

Launch configuration attribute key. The value is the id of the last plug-in that was selected on the Tracing tab.

See Also:

Constant Field Values

TRACING_CHECKED

public static final String TRACING_CHECKED

Launch configuration attribute key. The value is the IDs of all plug-ins checked on the Tracing tab. The value may also be "[NONE]"

See Also:

TRACING_NONE, Constant Field Values

TRACING_NONE

public static final String TRACING_NONE

Launch configuration attribute value indicating that, although tracing is enabled, no plug-ins have been selected to be traced.

See Also:

Constant Field Values

CONFIG_USE_DEFAULT_AREA

public static final String CONFIG_USE_DEFAULT_AREA

Launch configuration attribute key. The value is a boolean specifying if PDE should generate a default configuration area for the launch. If true, a configuration location in the PDE metadata area is created. Otherwise, the user is expected to specify a location.

See Also:

CONFIG_LOCATION, Constant Field Values

CONFIG_LOCATION

public static final String CONFIG_LOCATION

Launch configuration attribute key. The value is a string specifying the configuration area location for an Eclipse application launch. This key is only used when CONFIG_USE_DEFAULT_AREA is false.

See Also:

CONFIG_USE_DEFAULT_AREA, Constant Field Values

CONFIG_CLEAR_AREA

public static final String CONFIG_CLEAR_AREA

Launch configuration attribute key. The value is a boolean specifying if the configuration area location should be cleared prior to launching

See Also:

Constant Field Values

CONFIG_GENERATE_DEFAULT

public static final String CONFIG_GENERATE_DEFAULT

Launch configuration atribute key. The value is a boolean specifying if PDE should generate a default config.ini file for the launch. If true, a configuration file is created. Otherwise, the user is expected to specify a config.ini to be used as a template.

See Also:

CONFIG_TEMPLATE_LOCATION, Constant Field Values

CONFIG_TEMPLATE_LOCATION

public static final String CONFIG_TEMPLATE_LOCATION

Launch configuration attribute key. The value is a string specifying the location of the config.ini file to be used as a template for an Eclipse application launch. This key is only used when CONFIG_GENERATE_DEFAULT is false.

See Also:

CONFIG_GENERATE_DEFAULT, Constant Field Values

PRODUCT_FILE

public static final String PRODUCT_FILE

Launch configuration attribute key. The value is a string specifying the location of the .product file with which this launch configuration is associated.

See Also:

Constant Field Values

OSGI_FRAMEWORK_ID

public static final String OSGI_FRAMEWORK_ID

Launch configuration attribute key. The value is the ID of an OSGi framework declared in an org.eclipse.pde.ui.osgiLaunchers extension point.

Since:

3.3

See Also:

Constant Field Values

DEFAULT_AUTO_START

public static final String DEFAULT_AUTO_START

Launch configuration attribute key. The value is a boolean specifying if the default Auto-Start for an OSGi Framework launch configuration is true or false

See Also:

DEFAULT_START_LEVEL, Constant Field Values

DEFAULT_START_LEVEL

public static final String DEFAULT_START_LEVEL

Launch configuration attribute key. The value is an integer specifying the default start level for bundles in an OSGi Framework launch configuration.

See Also:

DEFAULT_AUTO_START, Constant Field Values

WORKSPACE_BUNDLES

public static final String WORKSPACE_BUNDLES

Launch configuration attribute key. The value is a comma-separated list of workspace bundles to launch with the OSGi framework. Each token in the list is of the format: @:

See Also:

DEFAULT_AUTO_START, DEFAULT_START_LEVEL, Constant Field Values

TARGET_BUNDLES

public static final String TARGET_BUNDLES

Launch configuration attribute key. The value is a comma-separated list of non-workspace bundles to launch with the OSGi framework. Each token in the list is of the format: @:

See Also:

DEFAULT_AUTO_START, DEFAULT_START_LEVEL, Constant Field Values

DEFINED_TARGET

public static final String DEFINED_TARGET

Launch configuration attribute key. The value can be either the full path to the workspace location of a Target Definition (ie. .target file), or the ID of a target defined in an org.eclipse.pde.core.targets extension.

See Also:

Constant Field Values

SHOW_SELECTED_ONLY

public static final String SHOW_SELECTED_ONLY

Launch configuration attribute key. The value is a boolean indicating whether or not to display only selected plug-ins.

Since:

3.4

See Also:

Constant Field Values

TAB_BUNDLES_ID

public static final String TAB_BUNDLES_ID

The unique tab identifier for the bundles tab

Since:

3.5

See Also:

BundlesTab, Constant Field Values

TAB_CONFIGURATION_ID

public static final String TAB_CONFIGURATION_ID

The unique tab identifier for the configuration tab

Since:

3.5

See Also:

ConfigurationTab, Constant Field Values

TAB_MAIN_ID

public static final String TAB_MAIN_ID

The unique tab identifier for the main tab

Since:

3.5

See Also:

MainTab, Constant Field Values

TAB_OSGI_SETTINGS_ID

public static final String TAB_OSGI_SETTINGS_ID

The unique tab identifier for the osgi settings tab

Since:

3.5

See Also:

OSGiSettingsTab, Constant Field Values

TAB_PLUGIN_JUNIT_MAIN_ID

public static final String TAB_PLUGIN_JUNIT_MAIN_ID

The unique tab identifier for the plug-in junit tab

Since:

3.5

See Also:

PluginJUnitMainTab, Constant Field Values

TAB_PLUGINS_ID

public static final String TAB_PLUGINS_ID

The unique tab identifier for the plug-ins tab

Since:

3.5

See Also:

PluginsTab, Constant Field Values

TAB_TRACING_ID

public static final String TAB_TRACING_ID

The unique tab identifier for the tracing tab

Since:

3.5

See Also:

TracingTab, Constant Field Values

OSGI_CONFIGURATION_TYPE

public static final String OSGI_CONFIGURATION_TYPE

The launch configuration type id for OSGi launches.

Since:

3.5

See Also:

OSGiLaunchShortcut, Constant Field Values