Copyright (c) 2000, 2017 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
IBM Corporation - initial API and implementation
Axel Richard (Obeo) - Bug 41353 - Launch configurations prototypes
/*******************************************************************************
* Copyright (c) 2000, 2017 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Axel Richard (Obeo) - Bug 41353 - Launch configurations prototypes
*******************************************************************************/
package org.eclipse.debug.core;
import java.util.Map;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.model.IDebugTarget;
import org.eclipse.debug.core.model.IPersistableSourceLocator;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.debug.core.sourcelookup.ISourceContainerType;
import org.eclipse.debug.core.sourcelookup.ISourcePathComputer;
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.
See Also: - ILaunch
- ILaunchListener
@noimplement This interface is not intended to be implemented by clients. @noextend This interface is not intended to be extended by clients.
/**
* 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.
* @see ILaunch
* @see ILaunchListener
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
*/
public interface ILaunchManager {
A launch in a normal, non-debug mode(value "run"
).
/**
* A launch in a normal, non-debug mode(value <code>"run"</code>).
*/
String RUN_MODE= "run"; //$NON-NLS-1$
A launch in a special debug mode (value "debug"
).
/**
* A launch in a special debug mode (value <code>"debug"</code>).
*/
String DEBUG_MODE= "debug"; //$NON-NLS-1$
A launch in a special profile mode (value "profile"
).
Since: 3.0
/**
* A launch in a special profile mode (value <code>"profile"</code>).
* @since 3.0
*/
String PROFILE_MODE= "profile"; //$NON-NLS-1$
Launch configuration attribute - a boolean value that indicates if the
launch configuration is 'private'. A private configuration is one that
does not appear in the user interface (launch history or the launch
configuration dialog).
Since: 3.6
/**
* Launch configuration attribute - a boolean value that indicates if the
* launch configuration is 'private'. A private configuration is one that
* does not appear in the user interface (launch history or the launch
* configuration dialog).
*
* @since 3.6
*/
String ATTR_PRIVATE = "org.eclipse.debug.ui.private"; //$NON-NLS-1$
Launch configuration attribute name. The value is a map of environment
variables passed into Runtime.exec(...) when a launch configuration is launched.
Default value is null
which indicates the default environment
should be used.
Since: 3.0
/**
* Launch configuration attribute name. The value is a map of environment
* variables passed into Runtime.exec(...) when a launch configuration is launched.
* Default value is <code>null</code> which indicates the default environment
* should be used.
*
* @since 3.0
*/
String ATTR_ENVIRONMENT_VARIABLES = DebugPlugin.getUniqueIdentifier() + ".environmentVariables"; //$NON-NLS-1$
Launch configuration attribute name. The value is a boolean value specifying
whether the environment variables in a launch configuration
should be appended to the native environment (i.e. when true
),
or if they should replace the environment (i.e. false
). The
default value is true
.
Since: 3.0
/**
* Launch configuration attribute name. The value is a boolean value specifying
* whether the environment variables in a launch configuration
* should be appended to the native environment (i.e. when <code>true</code>),
* or if they should replace the environment (i.e. <code>false</code>). The
* default value is <code>true</code>.
*
* @since 3.0
*/
String ATTR_APPEND_ENVIRONMENT_VARIABLES = DebugPlugin.getUniqueIdentifier() + ".appendEnvironmentVariables"; //$NON-NLS-1$
Adds the specified launch and notifies listeners. Has no
effect if an identical launch is already registered.
Params: - launch – the launch to add
Since: 2.0
/**
* Adds the specified launch and notifies listeners. Has no
* effect if an identical launch is already registered.
*
* @param launch the launch to add
* @since 2.0
*/
void addLaunch(ILaunch launch);
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.
Params: - listener – launch configuration listener
Since: 2.0
/**
* 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.
*
* @param listener launch configuration listener
* @since 2.0
*/
void addLaunchConfigurationListener(ILaunchConfigurationListener listener);
Adds the specified launch objects and notifies listeners. Has no
effect on identical launch objects already registered.
Params: - launches – the launch objects to add
Since: 2.1
/**
* Adds the specified launch objects and notifies listeners. Has no
* effect on identical launch objects already registered.
*
* @param launches the launch objects to add
* @since 2.1
*/
void addLaunches(ILaunch[] launches);
Adds the given listener to the collection of registered launch listeners.
Has no effect if an identical listener is already registered.
Params: - listener – the listener to register
Since: 2.1
/**
* Adds the given listener to the collection of registered launch listeners.
* Has no effect if an identical listener is already registered.
*
* @param listener the listener to register
* @since 2.1
*/
void addLaunchListener(ILaunchesListener listener);
Adds the given listener to the collection of registered launch listeners.
Has no effect if an identical listener is already registered.
Params: - listener – the listener to register
/**
* Adds the given listener to the collection of registered launch listeners.
* Has no effect if an identical listener is already registered.
*
* @param listener the listener to register
*/
void addLaunchListener(ILaunchListener listener);
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.
Params: - namePrefix – the String that the returned name must begin with
Returns: launch configuration name Since: 2.0 Deprecated: since 3.6 clients should use the generateLaunchConfigurationName(String)
method which will perform validation of the name and correct unsupported name parts.
/**
* 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 <code>namePrefix</code> as a starting point. If
* there is no existing launch configuration with this name, then <code>namePrefix</code>
* is returned. Otherwise, the value returned consists of the specified prefix plus
* some suffix that guarantees uniqueness.
*
* @param namePrefix the String that the returned name must begin with
* @return launch configuration name
* @since 2.0
* @deprecated since 3.6 clients should use the {@link #generateLaunchConfigurationName(String)} method which
* will perform validation of the name and correct unsupported name parts.
*/
@Deprecated String generateUniqueLaunchConfigurationNameFrom(String namePrefix);
Returns 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.
If the name prefix does not pass name validation any illegal parts of the name will be removed
during the name generation. Illegal characters will be replaced with '_' and illegal names will be
replaced with "_reserved_".
Params: - namePrefix – the string that the returned name should begin with
Returns: launch configuration name Since: 3.6
/**
* Returns 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 <code>namePrefix</code> as a starting point. If
* there is no existing launch configuration with this name, then <code>namePrefix</code>
* is returned. Otherwise, the value returned consists of the specified prefix plus
* some suffix that guarantees uniqueness.
* <p>
* If the name prefix does not pass name validation any illegal parts of the name will be removed
* during the name generation. Illegal characters will be replaced with '_' and illegal names will be
* replaced with "_reserved_".
* </p>
* @param namePrefix the string that the returned name should begin with
* @return launch configuration name
* @since 3.6
*/
String generateLaunchConfigurationName(String namePrefix);
Returns if the given name is valid or not. If an invalid name part is located an IllegalArgumentException
is thrown. Params: - configname – the name to check
Throws: - IllegalArgumentException – if the name is invalid, where an invalid
is either a reserved system name (like 'aux' on Win 32) or the name contains invalid characters (like ':' or '/').
Returns: true if the given name is valid or throws an exception if not, where an invalid name
is either a reserved system name (like 'aux' on Win 32) or the name contains invalid characters (like ':' or '/'). Since: 3.6
/**
* Returns if the given name is valid or not. If an invalid name part is located
* an {@link IllegalArgumentException} is thrown.
*
* @param configname the name to check
* @return true if the given name is valid or throws an exception if not, where an invalid name
* is either a reserved system name (like 'aux' on Win 32) or the name contains invalid characters (like ':' or '/').
* @throws IllegalArgumentException if the name is invalid, where an invalid
* is either a reserved system name (like 'aux' on Win 32) or the name contains invalid characters (like ':' or '/').
* @since 3.6
*/
boolean isValidLaunchConfigurationName(String configname) throws IllegalArgumentException;
Returns the collection of debug targets currently registered with this
launch manager.
Returns: an array of debug targets
/**
* Returns the collection of debug targets currently registered with this
* launch manager.
*
* @return an array of debug targets
*/
IDebugTarget[] getDebugTargets();
Returns an array of environment variables to be used when
launching the given configuration or null
if unspecified.
Each entry is of the form "var_name=value
".
Params: - configuration – launch configuration
Throws: - CoreException – if unable to access associated attribute or if
unable to resolve a variable in an environment variable's value
Returns: an array of environment variables to use when launching the given
configuration or null
if unspecified Since: 3.0
/**
* Returns an array of environment variables to be used when
* launching the given configuration or <code>null</code> if unspecified.
* Each entry is of the form "<code>var_name=value</code>".
*
* @return an array of environment variables to use when launching the given
* configuration or <code>null</code> if unspecified
* @param configuration launch configuration
* @throws CoreException if unable to access associated attribute or if
* unable to resolve a variable in an environment variable's value
* @since 3.0
*/
String[] getEnvironment(ILaunchConfiguration configuration) throws CoreException;
This method returns the character encoding to use when launching the specified ILaunchConfiguration
.
The returned encoding can be derived from one of three places in the following order:
- An attribute saved on the configuration itself (where no attribute means use the default encoding).
- The mapped resources for the configuration, in the event one of them has a specific encoding that
is not the workspace default. If there are more than one mapped resource we optimistically ask only the first resource
for its encoding.
- We ask the
ResourcesPlugin
for the workspace preference (which resolves back to the system
property file.encoding
if the user has made no changes to the workspace encoding preference).
Params: - configuration – the
ILaunchConfiguration
to get the encoding for
Throws: - CoreException – if a problem is encountered
Returns: the encoding to use when launching the specified ILaunchConfiguration
Since: 3.4
/**
* This method returns the character encoding to use when launching the specified <code>ILaunchConfiguration</code>.
* The returned encoding can be derived from one of three places in the following order:
* <ol>
* <li>An attribute saved on the configuration itself (where no attribute means use the default encoding).</li>
* <li>The mapped resources for the configuration, in the event one of them has a specific encoding that
* is not the workspace default. If there are more than one mapped resource we optimistically ask only the first resource
* for its encoding.</li>
* <li>We ask the <code>ResourcesPlugin</code> for the workspace preference (which resolves back to the system
* property <code>file.encoding</code> if the user has made no changes to the workspace encoding preference).</li>
* </ol>
* @param configuration the <code>ILaunchConfiguration</code> to get the encoding for
* @return the encoding to use when launching the specified <code>ILaunchConfiguration</code>
* @throws CoreException if a problem is encountered
*
* @since 3.4
*/
String getEncoding(ILaunchConfiguration configuration) throws CoreException;
Returns a handle to the launch configuration contained
in the specified file. This method does not check if the specified IFile
is
a launch configuration file or that it exists in the local or
remote file system.
Since 3.12, the returned configuration may be a launch configuration template.
Params: - file – launch configuration file
Returns: a handle to the launch configuration contained
in the specified file Since: 2.0
/**
* Returns a handle to the launch configuration contained
* in the specified file. This method does not check if the specified <code>IFile</code> is
* a launch configuration file or that it exists in the local or
* remote file system.
* <p>
* Since 3.12, the returned configuration may be a launch configuration template.
* </p>
*
* @param file launch configuration file
* @return a handle to the launch configuration contained
* in the specified file
* @since 2.0
*/
ILaunchConfiguration getLaunchConfiguration(IFile file);
Returns a handle to the launch configuration specified by
the given memento. The configuration may not exist.
Since 3.12, the returned configuration may be a launch configuration template.
Params: - memento – launch configuration memento
Throws: - CoreException – if the given memento is invalid or
an exception occurs parsing the memento
See Also: Returns: a handle to the launch configuration specified by
the given memento Since: 2.0
/**
* Returns a handle to the launch configuration specified by
* the given memento. The configuration may not exist.
* <p>
* Since 3.12, the returned configuration may be a launch configuration template.
* </p>
*
* @param memento launch configuration memento
* @return a handle to the launch configuration specified by
* the given memento
* @exception CoreException if the given memento is invalid or
* an exception occurs parsing the memento
* @see ILaunchConfiguration#getMemento()
* @since 2.0
*/
ILaunchConfiguration getLaunchConfiguration(String memento) throws CoreException;
Returns all launch configurations defined in the workspace.
Throws: - CoreException – if an exception occurs retrieving configurations
See Also: Returns: all launch configurations defined in the workspace Since: 2.0
/**
* Returns all launch configurations defined in the workspace.
*
* @return all launch configurations defined in the workspace
* @exception CoreException if an exception occurs retrieving configurations
* @since 2.0
* @see ILaunchConfigurationType#getPrototypes()
*/
ILaunchConfiguration[] getLaunchConfigurations() throws CoreException;
Returns all launch configurations of the specified type defined in the workspace
Does not include launch configuration templates.
Params: - type – a launch configuration type
Throws: - CoreException – if an error occurs while retrieving
a launch configuration
See Also: Returns: all launch configurations of the specified type defined in the workspace Since: 2.0
/**
* Returns all launch configurations of the specified type defined in the workspace
* <p>
* Does not include launch configuration templates.
* </p>
* @param type a launch configuration type
* @return all launch configurations of the specified type defined in the workspace
* @exception CoreException if an error occurs while retrieving
* a launch configuration
* @since 2.0
* @see ILaunchConfigurationType#getPrototypes()
*/
ILaunchConfiguration[] getLaunchConfigurations(ILaunchConfigurationType type) throws CoreException;
Returns all launch configurations defined in the workspace of the specified
kind(s) (configurations and/or prototypes).
Params: - kinds – bit mask of kinds of configurations to consider
Throws: - CoreException – if an exception occurs retrieving configurations
See Also: Returns: all launch configurations defined in the workspace Since: 3.12
/**
* Returns all launch configurations defined in the workspace of the specified
* kind(s) (configurations and/or prototypes).
*
* @param kinds bit mask of kinds of configurations to consider
* @return all launch configurations defined in the workspace
* @exception CoreException if an exception occurs retrieving configurations
* @since 3.12
* @see ILaunchConfiguration#CONFIGURATION
* @see ILaunchConfiguration#PROTOTYPE
* @see ILaunchConfiguration#getKind()
* @see ILaunchConfigurationType#getPrototypes()
*/
ILaunchConfiguration[] getLaunchConfigurations(int kinds) throws CoreException;
Returns all launch configurations of the specified type defined in the workspace
of the specified kind(s) (configurations and/or prototypes).
Params: - type – a launch configuration type
- kinds – bit mask of kinds of configurations to consider
Throws: - CoreException – if an error occurs while retrieving
a launch configuration
See Also: Returns: all launch configurations of the specified type defined in the workspace Since: 3.12
/**
* Returns all launch configurations of the specified type defined in the workspace
* of the specified kind(s) (configurations and/or prototypes).
*
* @param type a launch configuration type
* @param kinds bit mask of kinds of configurations to consider
* @return all launch configurations of the specified type defined in the workspace
* @exception CoreException if an error occurs while retrieving
* a launch configuration
* @since 3.12
* @see ILaunchConfiguration#CONFIGURATION
* @see ILaunchConfiguration#PROTOTYPE
* @see ILaunchConfiguration#getKind()
* @see ILaunchConfigurationType#getPrototypes()
*/
ILaunchConfiguration[] getLaunchConfigurations(ILaunchConfigurationType type, int kinds) throws CoreException;
Returns the launch configuration type extension with the specified
id, or null
if it does not exist.
Params: - 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
/**
* Returns the launch configuration type extension with the specified
* id, or <code>null</code> if it does not exist.
*
* @param id unique identifier for a launch configuration type extension
* @return the launch configuration type extension with the specified
* id, or <code>null</code> if it does not exist
* @since 2.0
*/
ILaunchConfigurationType getLaunchConfigurationType(String id);
Returns all defined launch configuration type extensions
Returns: all defined launch configuration type extensions Since: 2.0
/**
* Returns all defined launch configuration type extensions
*
* @return all defined launch configuration type extensions
* @since 2.0
*/
ILaunchConfigurationType[] getLaunchConfigurationTypes();
Returns the collection of launches currently registered
with this launch manager.
Returns: an array of launches
/**
* Returns the collection of launches currently registered
* with this launch manager.
*
* @return an array of launches
*/
ILaunch[] getLaunches();
Returns the launch mode registered with the given mode identifier,
or null
if none.
Params: - mode – mode identifier
Returns: launch mode or null
Since: 3.0
/**
* Returns the launch mode registered with the given mode identifier,
* or <code>null</code> if none.
*
* @param mode mode identifier
* @return launch mode or <code>null</code>
* @since 3.0
*/
ILaunchMode getLaunchMode(String mode);
Returns all registered launch modes.
Returns: all registered launch modes Since: 3.0
/**
* Returns all registered launch modes.
*
* @return all registered launch modes
* @since 3.0
*/
ILaunchMode[] getLaunchModes();
Returns a collection of launch configurations that required migration to be
compatible with current tooling.
Throws: - CoreException – if an exception occurs determining
migration candidates
Returns: a collection of launch configurations that required migration Since: 3.2
/**
* Returns a collection of launch configurations that required migration to be
* compatible with current tooling.
*
* @return a collection of launch configurations that required migration
* @exception org.eclipse.core.runtime.CoreException if an exception occurs determining
* migration candidates
* @since 3.2
*/
ILaunchConfiguration[] getMigrationCandidates() throws CoreException;
When a launch configuration is created or moved, registered launch
configuration listeners (see ILaunchConfigurationListener
)
are notified of an add notification for the new configuration. If the
notification is the result of a move this method will return a handle to
the launch configuration that the added launch configuration was moved
from. This method returns null
if the added launch
configuration was not the result of a rename or move. This information is
only available during the add notification call back
launchConfigurationAdded
.
Renaming a configuration is considered the same as moving a
configuration.
Params: - addedConfiguration – a launch configuration for which an add
notification is being broadcast
Returns: the launch configuration that the added launch configuration was
moved from, or null
if the add notification is not the
result of a move Since: 2.1
/**
* When a launch configuration is created or moved, registered launch
* configuration listeners (see <code>ILaunchConfigurationListener</code>)
* are notified of an add notification for the new configuration. If the
* notification is the result of a move this method will return a handle to
* the launch configuration that the added launch configuration was moved
* from. This method returns <code>null</code> if the added launch
* configuration was not the result of a rename or move. This information is
* only available during the add notification call back
* <code>launchConfigurationAdded</code>.
* <p>
* Renaming a configuration is considered the same as moving a
* configuration.
* </p>
*
* @param addedConfiguration a launch configuration for which an add
* notification is being broadcast
* @return the launch configuration that the added launch configuration was
* moved from, or <code>null</code> if the add notification is not the
* result of a move
* @since 2.1
*/
ILaunchConfiguration getMovedFrom(ILaunchConfiguration addedConfiguration);
When a launch configuration is deleted or moved, registered launch
configuration listeners (see ILaunchConfigurationListener
)
are notified of a remove notification for launch configuration that has
been deleted. If the notification is the result of a move this method
will return a handle to the launch configuration that the removed launch
configuration was moved to. This method returns null
if the
removed launch configuration was not the result of a rename or move. This
information is only available during the add notification call back
launchConfigurationRemoved
.
Renaming a configuration is considered the same as moving a
configuration.
Params: - removedConfiguration – a launch configuration for which a
remove notification is being broadcast
Returns: the launch configuration that the removed launch configuration
was moved to, or null
if the add notification is not the
result of a move Since: 2.1
/**
* When a launch configuration is deleted or moved, registered launch
* configuration listeners (see <code>ILaunchConfigurationListener</code>)
* are notified of a remove notification for launch configuration that has
* been deleted. If the notification is the result of a move this method
* will return a handle to the launch configuration that the removed launch
* configuration was moved to. This method returns <code>null</code> if the
* removed launch configuration was not the result of a rename or move. This
* information is only available during the add notification call back
* <code>launchConfigurationRemoved</code>.
* <p>
* Renaming a configuration is considered the same as moving a
* configuration.
* </p>
*
* @param removedConfiguration a launch configuration for which a
* remove notification is being broadcast
* @return the launch configuration that the removed launch configuration
* was moved to, or <code>null</code> if the add notification is not the
* result of a move
* @since 2.1
*/
ILaunchConfiguration getMovedTo(ILaunchConfiguration removedConfiguration);
Returns the native system environment variables as a map of
variable names and values (Strings).
Note that WIN32 system environment preserves the case of variable names but is otherwise case insensitive. Depending on what you intend to do with the environment, the lack of normalization may or may not be create problems. On WIN32, this method normalizes mixed-case keys variable names to upper case. Use getNativeEnvironmentCasePreserved()
instead to get a WIN32 system environment where the keys are the mixed-case variable names recorded by the OS.
Returns: the native system environment variables; on WIN32, mixed-case
variable names (keys) have been normalized to upper case
(key type: String
; value type: String
) Since: 3.0
/**
* Returns the native system environment variables as a map of
* variable names and values (Strings).
* <p>
* Note that WIN32 system environment preserves
* the case of variable names but is otherwise case insensitive.
* Depending on what you intend to do with the environment, the
* lack of normalization may or may not be create problems. On
* WIN32, this method normalizes mixed-case keys variable names
* to upper case. Use {@link #getNativeEnvironmentCasePreserved()}
* instead to get a WIN32 system environment where the keys are
* the mixed-case variable names recorded by the OS.
* </p>
*
* @return the native system environment variables; on WIN32, mixed-case
* variable names (keys) have been normalized to upper case
* (key type: <code>String</code>; value type: <code>String</code>)
* @since 3.0
*/
Map<String, String> getNativeEnvironment();
Returns the native system environment variables as a map of
variable names and values (Strings).
Note that WIN32 system environment preserves the case of variable names but is otherwise case insensitive. Depending on what you intend to do with the environment, the lack of normalization may or may not be create problems. This method returns mixed-case keys using the variable names recorded by the OS. Use getNativeEnvironment()
instead to get a WIN32 system environment where all keys have been normalized to upper case.
Returns: the native system environment variables; on WIN32, mixed-case
variable names (keys) are returned without normalization
(key type: String
; value type: String
) Since: 3.1
/**
* Returns the native system environment variables as a map of
* variable names and values (Strings).
* <p>
* Note that WIN32 system environment preserves
* the case of variable names but is otherwise case insensitive.
* Depending on what you intend to do with the environment, the
* lack of normalization may or may not be create problems. This
* method returns mixed-case keys using the variable names
* recorded by the OS.
* Use {@link #getNativeEnvironment()} instead to get a WIN32 system
* environment where all keys have been normalized to upper case.
* </p>
*
* @return the native system environment variables; on WIN32, mixed-case
* variable names (keys) are returned without normalization
* (key type: <code>String</code>; value type: <code>String</code>)
* @since 3.1
*/
Map<String, String> getNativeEnvironmentCasePreserved();
Returns the collection of processes currently registered with this
launch manager.
Returns: an array of processes
/**
* Returns the collection of processes currently registered with this
* launch manager.
*
* @return an array of processes
*/
IProcess[] getProcesses();
Returns the source container type extension registered with the
given unique identifier, or null
if none.
Params: - id – unique identifier of a source container type extension
Returns: the source container type extension registered with the
given unique identifier, or null
if none Since: 3.0
/**
* Returns the source container type extension registered with the
* given unique identifier, or <code>null</code> if none.
*
* @param id unique identifier of a source container type extension
* @return the source container type extension registered with the
* given unique identifier, or <code>null</code> if none
* @since 3.0
*/
ISourceContainerType getSourceContainerType(String id);
Returns all registered source container type extensions.
Returns: all registered source container type extensions Since: 3.0
/**
* Returns all registered source container type extensions.
*
* @return all registered source container type extensions
* @since 3.0
*/
ISourceContainerType[] getSourceContainerTypes();
Returns a source path computer to compute a default source lookup path for
the given launch configuration, or null
if a source path
computer has not been registered for the associated launch configuration
type.
Params: - configuration – a launch configuration
Throws: - CoreException – if an exception occurs while instantiating a source
path computer
Returns: a source path computer registered for the associated launch
configurations type, or null
if unspecified Since: 3.0
/**
* Returns a source path computer to compute a default source lookup path for
* the given launch configuration, or <code>null</code> if a source path
* computer has not been registered for the associated launch configuration
* type.
*
* @param configuration a launch configuration
* @return a source path computer registered for the associated launch
* configurations type, or <code>null</code> if unspecified
* @throws CoreException if an exception occurs while instantiating a source
* path computer
* @since 3.0
*/
ISourcePathComputer getSourcePathComputer(ILaunchConfiguration configuration) throws CoreException;
Returns the source path computer extension registered with the given
unique identifier, or null
if none.
Params: - id – source path computer identifier
Returns: the source path computer extension registered with the given
unique identifier, or null
if none Since: 3.0
/**
* Returns the source path computer extension registered with the given
* unique identifier, or <code>null</code> if none.
*
* @param id source path computer identifier
* @return the source path computer extension registered with the given
* unique identifier, or <code>null</code> if none
* @since 3.0
*/
ISourcePathComputer getSourcePathComputer(String id);
Return true
if there is a launch configuration with the specified name,
false
otherwise.
Params: - name – the name of the launch configuration whose existence is being checked
Throws: - CoreException – if unable to retrieve existing launch configuration names
Returns: whether a launch configuration already exists with the given name Since: 2.0
/**
* Return <code>true</code> if there is a launch configuration with the specified name,
* <code>false</code> otherwise.
*
* @return whether a launch configuration already exists with the given name
* @param name the name of the launch configuration whose existence is being checked
* @exception CoreException if unable to retrieve existing launch configuration names
* @since 2.0
*/
boolean isExistingLaunchConfigurationName(String name) throws CoreException;
Returns whether the given launch is currently registered.
Params: - launch – a launch
Returns: whether the launch is currently registered Since: 3.1
/**
* Returns whether the given launch is currently registered.
*
* @param launch a launch
* @return whether the launch is currently registered
* @since 3.1
*/
boolean isRegistered(ILaunch launch);
Creates and returns a new source locator of the specified
type.
Params: - identifier – the identifier associated with a
persistable source locator extension
Throws: - CoreException – if an exception occurs creating
the source locator
Returns: a source locator Since: 2.0
/**
* Creates and returns a new source locator of the specified
* type.
*
* @param identifier the identifier associated with a
* persistable source locator extension
* @return a source locator
* @exception CoreException if an exception occurs creating
* the source locator
* @since 2.0
*/
IPersistableSourceLocator newSourceLocator(String identifier) throws CoreException;
Removes the specified launch and notifies listeners.
Has no effect if an identical launch is not already
registered.
Params: - launch – the launch to remove
Since: 2.0
/**
* Removes the specified launch and notifies listeners.
* Has no effect if an identical launch is not already
* registered.
*
* @param launch the launch to remove
* @since 2.0
*/
void removeLaunch(ILaunch launch);
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.
Params: - listener – launch configuration listener
Since: 2.0
/**
* 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.
*
* @param listener launch configuration listener
* @since 2.0
*/
void removeLaunchConfigurationListener(ILaunchConfigurationListener listener);
Removes the specified launch objects and notifies listeners.
Has no effect on identical launch objects that are not already
registered.
Params: - launches – the launch objects to remove
Since: 2.1
/**
* Removes the specified launch objects and notifies listeners.
* Has no effect on identical launch objects that are not already
* registered.
*
* @param launches the launch objects to remove
* @since 2.1
*/
void removeLaunches(ILaunch[] launches);
Removes the given listener from the collection of registered launch listeners.
Has no effect if an identical listener is not already registered.
Params: - listener – the listener to unregister
Since: 2.1
/**
* Removes the given listener from the collection of registered launch listeners.
* Has no effect if an identical listener is not already registered.
*
* @param listener the listener to unregister
* @since 2.1
*/
void removeLaunchListener(ILaunchesListener listener);
Removes the given listener from the collection of registered launch listeners.
Has no effect if an identical listener is not already registered.
Params: - listener – the listener to unregister
/**
* Removes the given listener from the collection of registered launch listeners.
* Has no effect if an identical listener is not already registered.
*
* @param listener the listener to unregister
*/
void removeLaunchListener(ILaunchListener listener);
}