org.eclipse.debug.core
Interface ILaunchConfigurationType

public interface ILaunchConfigurationType

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">
   </launchConfigurationType>
 </extension>
 

The attributes are specified as follows:

• id specifies a unique identifier for this launch configuration type.
• delegate specifies the fully qualified name of the java class that implements ILaunchConfigurationDelegate. Launch configuration instances of this type will delegate to instances of this class to perform launching.
• modes specifies a comma separated list of the modes this type of launch configuration suports - "run" and/or "debug".
• name specifies a human readable name for this type of launch configuration.

This interface is not intended to be implemented by clients. Clients that define a launch configuration delegate extension implement the ILaunchConfigurationDelegate interface.

Since:

2.0

See Also:

ILaunchConfiguration

Method Summary

ILaunchConfigurationDelegate	getDelegate() Returns the launch configuration delegate for launch configurations of this type.
String	getIdentifier() Returns the unique identifier for this type of launch configuration
String	getName() Returns the name of this type of launch configuration.
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.
boolean	supportsMode(String mode) Returns whether this type of launch configuration supports the specified mode.

Method Detail

supportsMode

public 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

getName

public String getName()

Returns the name of this type of launch configuration.

Returns:

the name of this type of launch configuration

getIdentifier

public String getIdentifier()

Returns the unique identifier for this type of launch configuration

Returns:

the unique identifier for this type of launch configuration

isPublic

public 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 accessbile in this way, but are still available through the methods on ILaunchManager.

Returns:

whether this launch configuration type is public.

newInstance

public 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.

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

getDelegate

public ILaunchConfigurationDelegate getDelegate()
                                         throws CoreException

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

Returns:

launch configuration delegate

Throws:

CoreException - if unable to instantiate the delegate