org.eclipse.debug.core
Interface ILaunchManager

public interface ILaunchManager

The launch manager manages the set of registered launches, maintaining a collection of active processes and debug targets. Clients interested in launch notification may register with the launch manager.

Clients are not intended to implement this interface.

See Also:

ILaunch, ILaunchListener

Field Summary

static String	DEBUG_MODE A launch in a special debug mode (value "debug").
static String	RUN_MODE A launch in a normal, non-debug mode(value "run").

Method Summary

void	addLaunch(ILaunch launch) Adds the specified launch and notifies listeners.
void	addLaunchConfigurationListener(ILaunchConfigurationListener listener) Adds the given launch configuration listener to the list of listeners notified when a launch configuration is added, removed, or changed.
void	addLaunchListener(ILaunchListener listener) Adds the given listener to the collection of registered launch listeners.
String	generateUniqueLaunchConfigurationNameFrom(String namePrefix) Return a String that can be used as the name of a launch configuration.
IDebugTarget[]	getDebugTargets() Returns the collection of debug targets currently registered with this launch manager.
ILaunchConfiguration	getLaunchConfiguration(IFile file) Returns a handle to the launch configuration contained in the specified file.
ILaunchConfiguration	getLaunchConfiguration(String memento) Returns a handle to the launch configuration specified by the given memento.
ILaunchConfiguration[]	getLaunchConfigurations() Returns all launch configurations defined in the workspace.
ILaunchConfiguration[]	getLaunchConfigurations(ILaunchConfigurationType type) Returns all launch configurations of the specified type defined in the workspace
ILaunchConfigurationType	getLaunchConfigurationType(String id) Returns the launch configuration type extension with the specified id, or null if it does not exist.
ILaunchConfigurationType[]	getLaunchConfigurationTypes() Returns all defined launch configuration type extensions
ILaunch[]	getLaunches() Returns the collection of launches currently registered with this launch manager.
IProcess[]	getProcesses() Returns the collection of processes currently registered with this launch manager.
boolean	isExistingLaunchConfigurationName(String name) Return true if there is a launch configuration with the specified name, false otherwise.
IPersistableSourceLocator	newSourceLocator(String identifier) Creates and returns a new source locator of the specified type.
void	removeLaunch(ILaunch launch) Removes the specified launch and notifies listeners.
void	removeLaunchConfigurationListener(ILaunchConfigurationListener listener) Removes the given launch configuration listener from the list of listeners notified when a launch configuration is added, removed, or changed.
void	removeLaunchListener(ILaunchListener listener) Removes the given listener from the collection of registered launch listeners.

Field Detail

RUN_MODE

public static final String RUN_MODE

A launch in a normal, non-debug mode(value "run").

See Also:

Constant Field Values

DEBUG_MODE

public static final String DEBUG_MODE

A launch in a special debug mode (value "debug").

See Also:

Constant Field Values

Method Detail

addLaunchListener

public void addLaunchListener(ILaunchListener listener)

Adds the given listener to the collection of registered launch listeners. Has no effect if an identical listener is already registerd.

Parameters:

listener - the listener to register

removeLaunch

public void removeLaunch(ILaunch launch)

Removes the specified launch and notifies listeners. Has no effect if an identical launch is not already registered.

Parameters:

launch - the launch to remove

Since:

2.0

getDebugTargets

public IDebugTarget[] getDebugTargets()

Returns the collection of debug targets currently registered with this launch manager.

Returns:

an array of debug targets

getLaunches

public ILaunch[] getLaunches()

Returns the collection of launches currently registered with this launch manager.

Returns:

an array of launches

getProcesses

public IProcess[] getProcesses()

Returns the collection of processes currently registered with this launch manager.

Returns:

an array of processes

addLaunch

public void addLaunch(ILaunch launch)

Adds the specified launch and notifies listeners. Has no effect if an identical launch is already registered.

Parameters:

launch - the launch to add

Since:

2.0

removeLaunchListener

public void removeLaunchListener(ILaunchListener listener)

Removes the given listener from the collection of registered launch listeners. Has no effect if an identical listener is not already registerd.

Parameters:

listener - the listener to deregister

getLaunchConfigurations

public ILaunchConfiguration[] getLaunchConfigurations()
                                               throws CoreException

Returns all launch configurations defined in the workspace.

Returns:

all launch configurations defined in the workspace

Throws:

CoreException - if an exception occurs retrieving configurations

Since:

2.0

getLaunchConfigurations

public ILaunchConfiguration[] getLaunchConfigurations(ILaunchConfigurationType type)
                                               throws CoreException

Returns all launch configurations of the specified type defined in the workspace

Parameters:

type - a launch configuration type

Returns:

all launch configurations of the specified type defined in the workspace

Throws:

CoreException - if an error occurs while retreiving a launch configuration

Since:

2.0

getLaunchConfiguration

public ILaunchConfiguration getLaunchConfiguration(IFile file)

Returns a handle to the launch configuration contained in the specified file. The file is not verified to exist or contain a launch configuration.

Parameters:

file - launch configuration file

Returns:

a handle to the launch configuration contained in the specified file

Since:

2.0

getLaunchConfiguration

public ILaunchConfiguration getLaunchConfiguration(String memento)
                                            throws CoreException

Returns a handle to the launch configuration specified by the given memento. The configuration may not exist.

Returns:

a handle to the launch configuration specified by the given memento

Throws:

CoreException - if the given memento is invalid or an exception occurs parsing the memento

Since:

2.0

See Also:

ILaunchConfiguration.getMemento()

getLaunchConfigurationTypes

public ILaunchConfigurationType[] getLaunchConfigurationTypes()

Returns all defined launch configuration type extensions

Returns:

all defined launch configuration type extensions

Since:

2.0

getLaunchConfigurationType

public ILaunchConfigurationType getLaunchConfigurationType(String id)

Returns the launch configuration type extension with the specified id, or null if it does not exist.

Parameters:

id - unique identifier for a launch configuration type extension

Returns:

the launch configuration type extension with the specified id, or null if it does not exist

Since:

2.0

addLaunchConfigurationListener

public void addLaunchConfigurationListener(ILaunchConfigurationListener listener)

Adds the given launch configuration listener to the list of listeners notified when a launch configuration is added, removed, or changed. Has no effect if the given listener is already registered.

Parameters:

listener - launch configuration listener

Since:

2.0

removeLaunchConfigurationListener

public void removeLaunchConfigurationListener(ILaunchConfigurationListener listener)

Removes the given launch configuration listener from the list of listeners notified when a launch configuration is added, removed, or changed. Has no effect if the given listener is not already registered.

Parameters:

listener - launch configuration listener

Since:

2.0

isExistingLaunchConfigurationName

public boolean isExistingLaunchConfigurationName(String name)
                                          throws CoreException

Return true if there is a launch configuration with the specified name, false otherwise.

Parameters:

name - the name of the launch configuration whose existence is being checked

Throws:

CoreException - if unable to retrieve existing launch configuration names

Since:

2.0

generateUniqueLaunchConfigurationNameFrom

public String generateUniqueLaunchConfigurationNameFrom(String namePrefix)

Return a String that can be used as the name of a launch configuration. The name is guaranteed to be unique (no existing launch configurations will have this name). The name that is returned uses the namePrefix as a starting point. If there is no existing launch configuration with this name, then namePrefix is returned. Otherwise, the value returned consists of the specified prefix plus some suffix that guarantees uniqueness.

Parameters:

namePrefix - the String that the returned name must begin with

Since:

2.0

newSourceLocator

public IPersistableSourceLocator newSourceLocator(String identifier)
                                           throws CoreException

Creates and returns a new source locator of the specified type.

Parameters:

identifier - the identifier associated with a persistable source locator extension

Returns:

a source locator

Throws:

CoreException - if an exception occurs creating the source locator

Since:

2.0