diff options
Diffstat (limited to 'org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java')
| -rw-r--r-- | org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java | 315 |
1 files changed, 0 insertions, 315 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java deleted file mode 100644 index 1a24538b5..000000000 --- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java +++ /dev/null @@ -1,315 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2000, 2010 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.debug.core; - - -import java.util.Set; - -import org.eclipse.core.resources.IContainer; -import org.eclipse.core.runtime.CoreException; -import org.eclipse.core.runtime.IAdaptable; -import org.eclipse.debug.core.model.ILaunchConfigurationDelegate; -import org.eclipse.debug.core.sourcelookup.ISourcePathComputer; - -/** - * Describes and creates instances of a specific type of - * launch configuration. Launch configuration types are - * defined by extensions. - * <p> - * A launch configuration type extension is defined in <code>plugin.xml</code>. - * Following is an example definition of a launch configuration - * type extension. - * <pre> - * <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> - * </pre> - * The attributes are specified as follows: - * <ul> - * <li><code>id</code> specifies a unique identifier for this launch configuration - * type.</li> - * <li><code>delegate</code> specifies the fully qualified name of the java class - * that implements <code>ILaunchConfigurationDelegate</code>. Launch configuration - * instances of this type will delegate to instances of this class - * to perform launching.</li> - * <li><code>modes</code> specifies a comma separated list of the modes this - * type of launch configuration supports - <code>"run"</code> and/or <code>"debug"</code>.</li> - * <li><code>name</code> specifies a human readable name for this type - * of launch configuration.</li> - * <li><code>category</code> is an optional attribute that specifies a category - * for this launch configuration type. Categories are client defined. This - * attribute was added in the 2.1 release.</li> - * <li><code>sourceLocatorId</code> an optional unique identifier of a sourceLocator extension that - * is used to create the source locator for sessions launched using launch configurations - * of this type. This attribute was added in the 3.0 release.</li> - * <li><code>sourcePathComputerId</code> an optional unique identifier of a sourcePathComputer extension - * that is used to compute a default source lookup path for launch configurations of this type. - * This attribute was added in the 3.0 release.</li> - * </ul> - * </p> - * <p> - * The <code>category</code> 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 <code>getAttribute</code> has also been - * added. Launch configurations that are to be recognized as standard run/debug - * launch configurations should not specify the <code>category</code> attribute. - * </p> - * <p> - * Clients that define a launch configuration delegate extension implement the - * <code>ILaunchConfigurationDelegate</code> interface. - * </p> - * @see ILaunchConfiguration - * @since 2.0 - * @noimplement This interface is not intended to be implemented by clients. - * @noextend This interface is not intended to be extended by clients. - */ -public interface ILaunchConfigurationType extends IAdaptable { - - /** - * Returns the attribute with the given name, as specified by this launch - * configuration type's extension definition, or <code>null</code> if - * unspecified. - * - * @param attributeName attribute name - * @return the specified extension attribute, or <code>null</code> - * @since 2.1 - */ - public String getAttribute(String attributeName); - - /** - * Returns this launch configuration type's category, or <code>null</code> - * if unspecified. This corresponds to the category attribute specified in - * the extension definition. - * - * @return this launch configuration type's category, or <code>null</code> - * @since 2.1 - */ - public String getCategory(); - - /** - * Returns the launch configuration delegate for launch - * configurations of this type, for <code>run</code> mode. - * The first time this method is called, the delegate is instantiated. - * - * @return launch configuration delegate - * @exception CoreException if unable to instantiate the - * delegate - * @deprecated use <code>getDelegate(String)</code> to specify mode - */ - public ILaunchConfigurationDelegate getDelegate() throws CoreException; - - /** - * 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 <code>org.eclipse.debug.core.launchDelegates</code> - * - * @param mode launch mode - * @return launch configuration delegate - * @exception CoreException if unable to instantiate the - * delegate - * @since 3.0 - * @deprecated since 3.3, the method <code>getDelegates(Set)</code> should be used - * instead, as there can be more than one capable delegate per mode or combination - * of modes - */ - public ILaunchConfigurationDelegate getDelegate(String mode) throws CoreException; - - /** - * Returns the delegates capable of launching in the specified modes, possibly - * an empty set. - * - * @param modes set of launch modes - * @return the <code>ILaunchDelegate</code>s capable of launching - * in the specified modes or an empty collection if none - * @throws CoreException - * @since 3.3 - */ - public ILaunchDelegate[] getDelegates(Set modes) throws CoreException; - - /** - * Returns the preferred launch delegate for this type in the specified mode combination - * or <code>null</code> if there is no preferred delegate. - * - * @param modes the set of modes to support - * @return the preferred delegate or <code>null</code> if none - * @throws CoreException - * - * @since 3.3 - */ - public ILaunchDelegate getPreferredDelegate(Set modes) throws CoreException; - - /** - * Sets the preferred launch delegate for this type in the specified mode combination. - * Specify <code>null</code> as a preferred delegate to remove any preferred delegate - * setting for this launch configuration type. - * - * @param modes launch mode combination - * @param delegate preferred launch delegate or <code>null</code> - * @throws CoreException - * - * @since 3.3 - */ - public void setPreferredDelegate(Set modes, ILaunchDelegate delegate) throws CoreException; - - /** - * Returns whether this launch configuration supports the specified launch - * mode combination. - * - * @param modes launch mode combination - * @return whether the launch mode combination is supported - * @since 3.3 - */ - public boolean supportsModeCombination(Set modes); - - /** - * Returns the unique identifier for this type of launch configuration - * - * @return the unique identifier for this type of launch configuration - */ - public String getIdentifier(); - - /** - * Returns the name of this type of launch configuration. - * - * @return the name of this type of launch configuration - */ - public String getName(); - - /** - * Returns the identifier of the plug-in that contributes this launch configuration type. - * - * @return the identifier of the plug-in that contributes this launch configuration type - * @since 3.0 - */ - public String getPluginIdentifier(); - - /** - * Returns the identifier of the persistable source locator registered with - * this launch configurations type, or <code>null</code> if unspecified. - * A source locator can be specified by a launch configuration type or - * launch delegate extension's <code>sourceLocatorId</code> attribute. - * <p> - * Only one source locator should be provided per launch configuration type - * and its launch delegates. - * </p> - * @return the identifier of the persistable source locator registered with - * this launch configurations type, or <code>null</code> if unspecified - * @since 3.0 - */ - public String getSourceLocatorId(); - - /** - * Returns the source path computer registered with this launch configuration - * type or <code>null</code> if unspecified. A source path computer can be - * specified by a launch configuration type or launch delegate extension's - * <code>sourcePathComputerId</code> attribute. - * <p> - * Only one source path computer should be provided per launch configuration type - * and its launch delegates. - * </p> - * @return the source path computer registered with this launch configuration - * type or <code>null</code> if unspecified - * @since 3.0 - */ - public ISourcePathComputer getSourcePathComputer(); - - /** - * Returns all of the registered supported modes for this launch configuration type. - * This method does not return null. - * - * <p> - * 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 - * </p> - * - * @return the set of all supported modes - * @since 3.2 - * - * @deprecated Since 3.3 all modes are provided as sets and not individual strings. The method <code>getSupportedModeCombinations</code> - * should be used instead to retrieve the complete listing of supported modes and their allowable combinations. - */ - public Set getSupportedModes(); - - /** - * Returns a <code>java.util.Set</code> of <code>java.util.Set</code>s containing all of the - * supported launch mode combinations for this type. - * - * @return a set of sets of all the supported mode combinations supported by this type - * - * @since 3.3 - */ - public Set getSupportedModeCombinations(); - - /** - * 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 - * <code>ILaunchManager</code>. - * - * @return whether this launch configuration type is public. - */ - public boolean isPublic(); - - /** - * Returns a new launch configuration working copy of this type, - * that resides in the specified container, with the given name. - * When <code>container</code> is </code>null</code>, the configuration - * will reside locally in the metadata area. - * Note: a launch configuration is not actually created until the working copy is saved. - * <p> - * The configuration <code>name</code> parameter cannot contain file separator characters - * (sub directories) when the <code>container</code> is <code>null</code> (i.e. when the - * configuration is to be stored in the local metadata area. - * </p> - * @param container the container in which the new configuration will - * reside, or <code>null</code> if the configuration should reside - * locally with the metadata. - * @param name name for the launch configuration - * @return a new launch configuration working copy instance of this type - * @exception CoreException if an instance of this type - * of launch configuration could not be created for any - * reason - */ - public ILaunchConfigurationWorkingCopy newInstance(IContainer container, String name) throws CoreException; - - /** - * Returns whether this type of launch configuration supports - * the specified mode. - * - * @param mode a mode in which a configuration can be launched, one of - * the mode constants defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or - * <code>DEBUG_MODE</code>. - * @return whether this kind of launch configuration supports the - * specified mode - */ - public boolean supportsMode(String mode); - - /** - * Returns the name of the plug-in that contributed this launch configuration type. - * - * @return name of contributing plug-in - * @since 3.3 - */ - public String getContributorName(); - -} |