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 | 117 |
1 files changed, 60 insertions, 57 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 index 375dc34ca..cd78a8ca4 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2011 IBM Corporation and others. + * Copyright (c) 2000, 2013 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 @@ -10,7 +10,7 @@ *******************************************************************************/ package org.eclipse.debug.core; - + import java.util.Set; import org.eclipse.core.resources.IContainer; @@ -29,7 +29,7 @@ import org.eclipse.debug.core.sourcelookup.ISourcePathComputer; * type extension. * <pre> * <extension point="org.eclipse.debug.core.launchConfigurationTypes"> - * <launchConfigurationType + * <launchConfigurationType * id="com.example.ExampleIdentifier" * delegate="com.example.ExampleLaunchConfigurationDelegate" * modes="run, debug" @@ -81,47 +81,48 @@ import org.eclipse.debug.core.sourcelookup.ISourcePathComputer; * @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 - */ + */ + @Deprecated 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 @@ -129,84 +130,85 @@ public interface ILaunchConfigurationType extends IAdaptable { * @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 - */ + * of modes + */ + @Deprecated 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 if a problem is encountered * @since 3.3 */ - public ILaunchDelegate[] getDelegates(Set modes) throws CoreException; - + public ILaunchDelegate[] getDelegates(Set<String> 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 if a problem is encountered - * + * * @since 3.3 */ - public ILaunchDelegate getPreferredDelegate(Set modes) throws CoreException; - + public ILaunchDelegate getPreferredDelegate(Set<String> 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 if a problem is encountered - * + * * @since 3.3 */ - public void setPreferredDelegate(Set modes, ILaunchDelegate delegate) throws CoreException; - + public void setPreferredDelegate(Set<String> 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); - + public boolean supportsModeCombination(Set<String> 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. + * launch delegate extension's <code>sourceLocatorId</code> attribute. * <p> * Only one source locator should be provided per launch configuration type * and its launch delegates. @@ -216,7 +218,7 @@ public interface ILaunchConfigurationType extends IAdaptable { * @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 @@ -224,52 +226,53 @@ public interface ILaunchConfigurationType extends IAdaptable { * <code>sourcePathComputerId</code> attribute. * <p> * Only one source path computer should be provided per launch configuration type - * and its launch delegates. + * 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(); - + 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 + * 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(); - + @Deprecated + public Set<String> 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(); - + public Set<Set<String>> 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 + * 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. @@ -291,11 +294,11 @@ public interface ILaunchConfigurationType extends IAdaptable { * 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>. @@ -303,10 +306,10 @@ public interface ILaunchConfigurationType extends IAdaptable { * 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 */ |