Eclipse Platform
Release 3.7

org.eclipse.debug.core
Interface ILaunchConfigurationType

All Superinterfaces:
IAdaptable

public interface ILaunchConfigurationType
extends IAdaptable

Describes and creates instances of a specific type of launch configuration. Launch configuration types are defined by extensions.

A launch configuration type extension is defined in plugin.xml. Following is an example definition of a launch configuration type extension.

 <extension point="org.eclipse.debug.core.launchConfigurationTypes">
   <launchConfigurationType 
      id="com.example.ExampleIdentifier"
      delegate="com.example.ExampleLaunchConfigurationDelegate"
      modes="run, debug"
      name="Example Application">
      sourceLocatorId="com.example.SourceLocator">
      sourcePathComputerId="com.example.SourcePathComputer">
   </launchConfigurationType>
 </extension>
 
The attributes are specified as follows:

The category attribute has been added in release 2.1, such that other tools may re-use the launch configuration framework for purposes other than the standard running and debugging of programs under development. Such that clients may access arbitrary attributes specified in launch configuration type extension definitions, the method getAttribute has also been added. Launch configurations that are to be recognized as standard run/debug launch configurations should not specify the category attribute.

Clients that define a launch configuration delegate extension implement the ILaunchConfigurationDelegate interface.

Since:
2.0
See Also:
ILaunchConfiguration
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

Method Summary
 String getAttribute(String attributeName)
          Returns the attribute with the given name, as specified by this launch configuration type's extension definition, or null if unspecified.
 String getCategory()
          Returns this launch configuration type's category, or null if unspecified.
 String getContributorName()
          Returns the name of the plug-in that contributed this launch configuration type.
 ILaunchConfigurationDelegate getDelegate()
          Deprecated. use getDelegate(String) to specify mode
 ILaunchConfigurationDelegate getDelegate(String mode)
          Deprecated. since 3.3, the method getDelegates(Set) should be used instead, as there can be more than one capable delegate per mode or combination of modes
 ILaunchDelegate[] getDelegates(Set modes)
          Returns the delegates capable of launching in the specified modes, possibly an empty set.
 String getIdentifier()
          Returns the unique identifier for this type of launch configuration
 String getName()
          Returns the name of this type of launch configuration.
 String getPluginIdentifier()
          Returns the identifier of the plug-in that contributes this launch configuration type.
 ILaunchDelegate getPreferredDelegate(Set modes)
          Returns the preferred launch delegate for this type in the specified mode combination or null if there is no preferred delegate.
 String getSourceLocatorId()
          Returns the identifier of the persistable source locator registered with this launch configurations type, or null if unspecified.
 ISourcePathComputer getSourcePathComputer()
          Returns the source path computer registered with this launch configuration type or null if unspecified.
 Set getSupportedModeCombinations()
          Returns a java.util.Set of java.util.Sets containing all of the supported launch mode combinations for this type.
 Set getSupportedModes()
          Deprecated. Since 3.3 all modes are provided as sets and not individual strings. The method getSupportedModeCombinations should be used instead to retrieve the complete listing of supported modes and their allowable combinations.
 boolean isPublic()
          Returns whether this launch configuration type is public.
 ILaunchConfigurationWorkingCopy newInstance(IContainer container, String name)
          Returns a new launch configuration working copy of this type, that resides in the specified container, with the given name.
 void setPreferredDelegate(Set modes, ILaunchDelegate delegate)
          Sets the preferred launch delegate for this type in the specified mode combination.
 boolean supportsMode(String mode)
          Returns whether this type of launch configuration supports the specified mode.
 boolean supportsModeCombination(Set modes)
          Returns whether this launch configuration supports the specified launch mode combination.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getAttribute

String getAttribute(String attributeName)
Returns the attribute with the given name, as specified by this launch configuration type's extension definition, or null if unspecified.

Parameters:
attributeName - attribute name
Returns:
the specified extension attribute, or null
Since:
2.1

getCategory

String getCategory()
Returns this launch configuration type's category, or null if unspecified. This corresponds to the category attribute specified in the extension definition.

Returns:
this launch configuration type's category, or null
Since:
2.1

getDelegate

ILaunchConfigurationDelegate getDelegate()
                                         throws CoreException
Deprecated. use getDelegate(String) to specify mode

Returns the launch configuration delegate for launch configurations of this type, for run mode. The first time this method is called, the delegate is instantiated.

Returns:
launch configuration delegate
Throws:
CoreException - if unable to instantiate the delegate

getDelegate

ILaunchConfigurationDelegate getDelegate(String mode)
                                         throws CoreException
Deprecated. since 3.3, the method getDelegates(Set) should be used instead, as there can be more than one capable delegate per mode or combination of modes

Returns the launch configuration delegate for launch configurations of this type, for the specified mode. The first time this method is called for a mode, the delegate is instantiated. Launch delegates may be contributed to a launch configuration type via the extension point org.eclipse.debug.core.launchDelegates

Parameters:
mode - launch mode
Returns:
launch configuration delegate
Throws:
CoreException - if unable to instantiate the delegate
Since:
3.0

getDelegates

ILaunchDelegate[] getDelegates(Set modes)
                               throws CoreException
Returns the delegates capable of launching in the specified modes, possibly an empty set.

Parameters:
modes - set of launch modes
Returns:
the ILaunchDelegates capable of launching in the specified modes or an empty collection if none
Throws:
CoreException
Since:
3.3

getPreferredDelegate

ILaunchDelegate getPreferredDelegate(Set modes)
                                     throws CoreException
Returns the preferred launch delegate for this type in the specified mode combination or null if there is no preferred delegate.

Parameters:
modes - the set of modes to support
Returns:
the preferred delegate or null if none
Throws:
CoreException
Since:
3.3

setPreferredDelegate

void setPreferredDelegate(Set modes,
                          ILaunchDelegate delegate)
                          throws CoreException
Sets the preferred launch delegate for this type in the specified mode combination. Specify null as a preferred delegate to remove any preferred delegate setting for this launch configuration type.

Parameters:
modes - launch mode combination
delegate - preferred launch delegate or null
Throws:
CoreException
Since:
3.3

supportsModeCombination

boolean supportsModeCombination(Set modes)
Returns whether this launch configuration supports the specified launch mode combination.

Parameters:
modes - launch mode combination
Returns:
whether the launch mode combination is supported
Since:
3.3

getIdentifier

String getIdentifier()
Returns the unique identifier for this type of launch configuration

Returns:
the unique identifier for this type of launch configuration

getName

String getName()
Returns the name of this type of launch configuration.

Returns:
the name of this type of launch configuration

getPluginIdentifier

String getPluginIdentifier()
Returns the identifier of the plug-in that contributes this launch configuration type.

Returns:
the identifier of the plug-in that contributes this launch configuration type
Since:
3.0

getSourceLocatorId

String getSourceLocatorId()
Returns the identifier of the persistable source locator registered with this launch configurations type, or null if unspecified. A source locator can be specified by a launch configuration type or launch delegate extension's sourceLocatorId attribute.

Only one source locator should be provided per launch configuration type and its launch delegates.

Returns:
the identifier of the persistable source locator registered with this launch configurations type, or null if unspecified
Since:
3.0

getSourcePathComputer

ISourcePathComputer getSourcePathComputer()
Returns the source path computer registered with this launch configuration type or null if unspecified. A source path computer can be specified by a launch configuration type or launch delegate extension's sourcePathComputerId attribute.

Only one source path computer should be provided per launch configuration type and its launch delegates.

Returns:
the source path computer registered with this launch configuration type or null if unspecified
Since:
3.0

getSupportedModes

Set getSupportedModes()
Deprecated. Since 3.3 all modes are provided as sets and not individual strings. The method getSupportedModeCombinations should be used instead to retrieve the complete listing of supported modes and their allowable combinations.

Returns all of the registered supported modes for this launch configuration type. This method does not return null.

The returned set does not convey any mode combination capability nor does it describe how or what the type can launch, all this method does is return a set of strings of all the modes in some way associated with this type

Returns:
the set of all supported modes
Since:
3.2

getSupportedModeCombinations

Set getSupportedModeCombinations()
Returns a java.util.Set of java.util.Sets containing all of the supported launch mode combinations for this type.

Returns:
a set of sets of all the supported mode combinations supported by this type
Since:
3.3

isPublic

boolean isPublic()
Returns whether this launch configuration type is public. Public configuration types are available for use by the user, for example, the user can create new configurations based on public types through the UI. Private types are not accessible in this way, but are still available through the methods on ILaunchManager.

Returns:
whether this launch configuration type is public.

newInstance

ILaunchConfigurationWorkingCopy newInstance(IContainer container,
                                            String name)
                                            throws CoreException
Returns a new launch configuration working copy of this type, that resides in the specified container, with the given name. When container is null, the configuration will reside locally in the metadata area. Note: a launch configuration is not actually created until the working copy is saved.

The configuration name parameter cannot contain file separator characters (sub directories) when the container is null (i.e. when the configuration is to be stored in the local metadata area.

Parameters:
container - the container in which the new configuration will reside, or null if the configuration should reside locally with the metadata.
name - name for the launch configuration
Returns:
a new launch configuration working copy instance of this type
Throws:
CoreException - if an instance of this type of launch configuration could not be created for any reason

supportsMode

boolean supportsMode(String mode)
Returns whether this type of launch configuration supports the specified mode.

Parameters:
mode - a mode in which a configuration can be launched, one of the mode constants defined by ILaunchManager - RUN_MODE or DEBUG_MODE.
Returns:
whether this kind of launch configuration supports the specified mode

getContributorName

String getContributorName()
Returns the name of the plug-in that contributed this launch configuration type.

Returns:
name of contributing plug-in
Since:
3.3

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.