Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Rennie2011-07-06 15:29:03 +0000
committerMichael Rennie2011-07-06 15:29:03 +0000
commit4e1445faf207d52593e07eed3a473095f6808e26 (patch)
tree5e1b02c4a3adc1f36fe391ec315a08f083d4a711 /org.eclipse.debug.core/core
parent03ca55d0cebccbc06615f6f48b03c4acce4f4600 (diff)
downloadeclipse.platform.debug-4e1445faf207d52593e07eed3a473095f6808e26.tar.gz
eclipse.platform.debug-4e1445faf207d52593e07eed3a473095f6808e26.tar.xz
eclipse.platform.debug-4e1445faf207d52593e07eed3a473095f6808e26.zip
[nobug] fix all of the Javadoc warnings
Diffstat (limited to 'org.eclipse.debug.core/core')
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/DebugPlugin.java2
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java1198
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java8
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchManager.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/RefreshUtil.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/commands/AbstractDebugCommand.java5
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/DebugElement.java6
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/AbstractSourceLookupDirector.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainer.java6
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainerTypeDelegate.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/CompositeSourceContainer.java3
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ContainerSourceContainer.java3
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ExternalArchiveSourceContainer.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java8
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java50
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java3
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java9
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java6
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java41
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java8
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java17
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java37
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java5
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java10
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java3
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java5
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java8
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java3
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java98
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java13
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java7
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java4
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java2
35 files changed, 825 insertions, 771 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugPlugin.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugPlugin.java
index 7b9d27b71..e1f2e6448 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugPlugin.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugPlugin.java
@@ -1234,7 +1234,7 @@ public class DebugPlugin extends Plugin {
*
* @param message error message
* @param exception underlying exception, or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
private static void abort(String message, Throwable exception) throws CoreException {
IStatus status = new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, message, exception);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java
index d79e3545c..374b3e61f 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -253,7 +253,7 @@ public interface IBreakpointManager {
* Returns an array of {@link IBreakpointImportParticipant}s for the given
* breakpoint marker id, never <code>null</code>.
*
- * @param markertype
+ * @param markertype the {@link String} identifier of the marker type
* @return an array of {@link IBreakpointImportParticipant}s for the given marker type,
* never <code>null</code>
* @throws CoreException if an exception occurs
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java
index b6df8537e..a5cb36658 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java
@@ -1,599 +1,599 @@
-/*******************************************************************************
- * 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.List;
-import java.util.Map;
-import java.util.Set;
-
-import org.eclipse.core.filesystem.EFS;
-import org.eclipse.core.resources.IFile;
-import org.eclipse.core.resources.IResource;
-import org.eclipse.core.runtime.CoreException;
-import org.eclipse.core.runtime.IAdaptable;
-import org.eclipse.core.runtime.IPath;
-import org.eclipse.core.runtime.IProgressMonitor;
-
-/**
- * A launch configuration describes how to launch an application.
- * Each launch configuration is an instance of a type of launch
- * configuration as described by a launch configuration type
- * extension. Each launch configuration has a launch configuration
- * delegate which performs the actual launching of a
- * configuration.
- * <p>
- * A launch configuration may be shared in a repository via
- * standard VCM mechanisms, or may be stored locally, essentially
- * making the launch configuration private for a single user.
- * Thus, a launch configuration may stored as a file in the
- * workspace (shared), or as a file in the debug plug-in's state
- * location.
- * </p>
- * A launch configuration is a handle to its underlying storage.
- * Methods annotated as "handle-only" do not require a configuration
- * to exist. Methods that require an underlying configuration to exist
- * throw a <code>CoreException</code> when an underlying configuration
- * is missing.
- * </p>
- * <p>
- * A launch configuration is modified by obtaining a working copy
- * of a launch configuration, modifying the working copy, and then
- * saving the working copy.
- * </p>
- * <p>
- * Clients that define a launch configuration delegate extension implement the
- * <code>ILaunchConfigurationDelegate</code> interface.
- * </p>
- * @see ILaunchConfigurationType
- * @see org.eclipse.debug.core.model.ILaunchConfigurationDelegate
- * @see ILaunchConfigurationWorkingCopy
- * @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 ILaunchConfiguration extends IAdaptable {
-
- /**
- * The file extension for launch configuration files
- * (value <code>"launch"</code>).
- */
- public static final String LAUNCH_CONFIGURATION_FILE_EXTENSION = "launch"; //$NON-NLS-1$
-
- /**
- * Launch configuration attribute storing an identifier of
- * a persistable source locator extension. When this attribute is
- * specified, a new source locator will be created automatically and
- * associated with the launch for this configuration.
- *
- * @see org.eclipse.debug.core.model.IPersistableSourceLocator
- */
- public static final String ATTR_SOURCE_LOCATOR_ID = DebugPlugin.getUniqueIdentifier() + ".source_locator_id"; //$NON-NLS-1$
-
- /**
- * Launch configuration attribute storing a memento of a
- * source locator. When this attribute is specified in
- * conjunction with a source locator id, the source locator
- * created for a launch will be initialized with this memento.
- * When not specified, but a source locator id is specified,
- * the source locator will be initialized to default values.
- *
- * @see org.eclipse.debug.core.model.IPersistableSourceLocator
- */
- public static final String ATTR_SOURCE_LOCATOR_MEMENTO = DebugPlugin.getUniqueIdentifier() + ".source_locator_memento"; //$NON-NLS-1$
-
- /**
- * Returns whether the contents of this launch configuration are
- * equal to the contents of the given launch configuration.
- *
- * @param configuration launch configuration
- * @return whether the contents of this launch configuration are equal to the contents
- * of the specified launch configuration.
- */
- public boolean contentsEqual(ILaunchConfiguration configuration);
-
- /**
- * Returns a copy of this launch configuration, as a
- * working copy, with the specified name. The new
- * working copy does not refer back to this configuration
- * as its original launch configuration (the working copy
- * will return <code>null</code> for <code>getOriginal()</code>).
- * When the working copy is saved it will not affect this
- * launch configuration.
- *
- * @param name the name of the copy
- * @return a copy of this launch configuration
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while initializing the contents of the
- * working copy from this configuration's underlying storage.</li>
- * </ul>
- * @see ILaunchConfigurationWorkingCopy#getOriginal()
- */
- public ILaunchConfigurationWorkingCopy copy(String name) throws CoreException;
-
- /**
- * Deletes this launch configuration. This configuration's underlying
- * storage is deleted. Has no effect if this configuration
- * does not exist.
- *
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while deleting this configuration's
- * underlying storage.</li>
- * </ul>
- */
- public void delete() throws CoreException;
-
- /**
- * Returns whether this launch configuration's underlying
- * storage exists. This is a handle-only method.
- *
- * @return whether this launch configuration's underlying
- * storage exists
- */
- public boolean exists();
-
- /**
- * Returns the boolean-valued attribute with the given name.
- * Returns the given default value if the attribute is undefined.
- *
- * @param attributeName the name of the attribute
- * @param defaultValue the value to use if no value is found
- * @return the value or the default value if no value was found.
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while retrieving the attribute from
- * underlying storage.</li>
- * <li>An attribute with the given name exists, but does not
- * have a boolean value</li>
- * </ul>
- */
- public boolean getAttribute(String attributeName, boolean defaultValue) throws CoreException;
-
- /**
- * Returns the integer-valued attribute with the given name.
- * Returns the given default value if the attribute is undefined.
- *
- * @param attributeName the name of the attribute
- * @param defaultValue the value to use if no value is found
- * @return the value or the default value if no value was found.
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while retrieving the attribute from
- * underlying storage.</li>
- * <li>An attribute with the given name exists, but does not
- * have an integer value</li>
- * </ul>
- */
- public int getAttribute(String attributeName, int defaultValue) throws CoreException;
-
- /**
- * Returns the <code>java.util.List</code>-valued attribute with the given name.
- * Returns the given default value if the attribute is undefined.
- *
- * @param attributeName the name of the attribute
- * @param defaultValue the value to use if no value is found
- * @return the value or the default value if no value was found.
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while retrieving the attribute from
- * underlying storage.</li>
- * <li>An attribute with the given name exists, but does not
- * have a List value</li>
- * </ul>
- */
- public List getAttribute(String attributeName, List defaultValue) throws CoreException;
-
- /**
- * Returns the <code>java.util.Set</code>-valued attribute with the given name.
- * Returns the given default value if the attribute is undefined.
- *
- * @param attributeName the name of the attribute
- * @param defaultValue the value to use if no value is found
- * @return the value or the default value if no value was found.
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while retrieving the attribute from
- * underlying storage.</li>
- * <li>An attribute with the given name exists, but does not
- * have a List value</li>
- * </ul>
- *
- * @since 3.3
- */
- public Set getAttribute(String attributeName, Set defaultValue) throws CoreException;
-
- /**
- * Returns the <code>java.util.Map</code>-valued attribute with the given name.
- * Returns the given default value if the attribute is undefined.
- *
- * @param attributeName the name of the attribute
- * @param defaultValue the value to use if no value is found
- * @return the value or the default value if no value was found.
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while retrieving the attribute from
- * underlying storage.</li>
- * <li>An attribute with the given name exists, but does not
- * have a Map value</li>
- * </ul>
- */
- public Map getAttribute(String attributeName, Map defaultValue) throws CoreException;
-
- /**
- * Returns the string-valued attribute with the given name.
- * Returns the given default value if the attribute is undefined.
- *
- * @param attributeName the name of the attribute
- * @param defaultValue the value to use if no value is found
- * @return the value or the default value if no value was found.
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while retrieving the attribute from
- * underlying storage.</li>
- * <li>An attribute with the given name exists, but does not
- * have a String value</li>
- * </ul>
- */
- public String getAttribute(String attributeName, String defaultValue) throws CoreException;
-
- /**
- * Returns a map containing the attributes in this launch configuration.
- * Returns an empty map if this configuration has no attributes.
- * <p>
- * Modifying the map does not affect this launch configuration's attributes.
- * A launch configuration is modified by obtaining a working copy of that
- * launch configuration, modifying the working copy, and then saving the working
- * copy.
- * </p>
- * @return a map of attribute keys and values
- * @exception CoreException unable to generate/retrieve an attribute map
- * @since 2.1
- */
- public Map getAttributes() throws CoreException;
-
- /**
- * Returns this launch configuration's type's category, or <code>null</code>
- * if unspecified. This is a handle-only method.
- *
- * @return this launch configuration's type's category, or <code>null</code>
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>Unable to retrieve or instantiate this launch configuration's type.</li>
- * </ul>
- * @since 2.1
- */
- public String getCategory() throws CoreException;
-
- /**
- * Returns the file this launch configuration is stored
- * in, or <code>null</code> if this configuration is stored
- * locally with the workspace. This is a handle-only method.
- *
- * @return the file this launch configuration is stored
- * in, or <code>null</code> if this configuration is stored
- * locally with the workspace
- */
- public IFile getFile();
-
- /**
- * Returns the location of this launch configuration as a
- * path in the local file system or <code>null</code> if it cannot
- * be mapped to a location in the local file system. This is a handle-only method.
- * <p>
- * Since 3.5, this method can return <code>null</code>. For example, when a
- * launch configuration is stored in the workspace as an {@link IFile} in
- * an external file system ({@link EFS}).
- * </p>
- *
- * @return the location of this launch configuration as a
- * path file system or <code>null</code> if it cannot be mapped
- * to a location in the local file system. Since 3.5, this method
- * can return <code>null</code>.
- * @deprecated Since a launch configuration does not need to be stored in the local
- * file system, this attribute should no longer be used to identify a launch configuration.
- */
- public IPath getLocation();
-
- /**
- * Returns the resources this launch configuration is associated with or <code>null</code>
- * if none. Clients contributing launch configuration types are responsible for maintaining
- * resource mappings as appropriate.
- *
- * @return the resources this launch configuration is associated with or <code>null</code>
- * @throws CoreException unable to get the mapped resource
- * @since 3.2
- */
- public IResource[] getMappedResources() throws CoreException;
-
- /**
- * Returns a memento for this launch configuration, or <code>null</code>
- * if unable to generate a memento for this configuration. A memento
- * can be used to re-create a launch configuration, via the
- * launch manager.
- *
- * @return a memento for this configuration
- * @see ILaunchManager#getLaunchConfiguration(String)
- * @exception CoreException if an exception occurs generating this
- * launch configuration's memento
- */
- public String getMemento() throws CoreException;
-
- /**
- * Returns the name of this launch configuration. This is
- * a handle-only method.
- *
- * @return the name of this launch configuration
- */
- public String getName();
-
- /**
- * Returns the launch modes that have been set on this configuration.
- * An empty set is returned if no specific launch modes have been set
- * on a launch configuration.
- * <p>
- * Setting launch modes on a configuration allows a launch to be
- * performed in mixed mode - for example, debug and profile at the
- * same time.
- * </p>
- * @return this configuration's launch modes, possibly an empty set
- * @exception CoreException if an exception occurs retrieving modes
- * @since 3.3
- */
- public Set getModes() throws CoreException;
-
- /**
- * Returns the preferred launch delegate that has been set on this
- * configuration or <code>null</code> if one is not specified.
- *
- * @param modes mode set for which a preferred delegate has been requested
- * @return this configuration's preferred launch delegate for the specified mode set, or
- * <code>null</code> if one is not specified
- * @exception CoreException if an exception occurs retrieving preferred delegate
- * @since 3.3
- */
- public ILaunchDelegate getPreferredDelegate(Set modes) throws CoreException;
-
- /**
- * Returns the type of this launch configuration. This is a
- * handle-only method.
- *
- * @return the type of this launch configuration
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>Unable to retrieve or instantiate this launch configuration's type.</li>
- * </ul>
- * @see ILaunchConfigurationType
- */
- public ILaunchConfigurationType getType() throws CoreException;
-
- /**
- * Returns a working copy of this launch configuration.
- * Since 3.3, if this method is called on a working copy, a nested working
- * copy is created (a working copy of a working copy).
- * Changes to the working copy will be applied to this
- * launch configuration when saved, or to the parent working copy.
- * The working copy will refer to this launch configuration as its original
- * launch configuration, or the working copy it was created from.
- * <p>
- * When a working copy (B) is created from a working copy (A), the newly
- * created working copy (B) is initialized with the attributes from
- * the first working copy (A). Whenever a working copy is saved, it is written
- * back to the working copy from which it was created: in this example working
- * copy B will write back to working copy A, and A will write back to the
- * original launch configuration.
- * </p>
- * @return a working copy of this launch configuration, or a nested working copy if called
- * on an instance of <code>ILaunchConfigurationWorkingCopy</code>
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>An exception occurs while initializing the contents of the
- * working copy from this configuration's underlying storage.</li>
- * </ul>
- * @see ILaunchConfigurationWorkingCopy#getOriginal()
- */
- public ILaunchConfigurationWorkingCopy getWorkingCopy() throws CoreException;
-
- /**
- * Returns whether this configuration contains an attribute with the given name.
- *
- * @param attributeName the name of the attribute
- * @return true if this configuration has the specified attribute false otherwise
- * @throws CoreException if unable to retrieve attributes
- *
- * @since 3.4
- */
- public boolean hasAttribute(String attributeName) throws CoreException;
-
- /**
- * Returns whether this launch configuration is stored
- * locally within the workspace. This is a handle-only method.
- *
- * @return whether this launch configuration is stored
- * locally with the workspace
- */
- public boolean isLocal();
-
- /**
- * Returns whether this launch configuration is a candidate for migration.
- *
- * @return whether this launch configuration is a candidate for migration
- * @throws CoreException
- * @see ILaunchConfigurationMigrationDelegate
- * @since 3.2
- */
- public boolean isMigrationCandidate() throws CoreException ;
-
- /**
- * Returns whether this launch configuration is a working
- * copy. Launch configurations which return <code>true</code>
- * to this method can be safely cast to
- * <code>org.eclipse.debug.core.ILaunchConfigurationWorkingCopy</code>.
- * This is a handle-only method.
- *
- * @return whether this launch configuration is a working
- * copy
- */
- public boolean isWorkingCopy();
-
- /**
- * Launches this configuration in the specified mode by delegating to
- * this configuration's launch configuration delegate, and returns the
- * resulting launch.
- * <p>
- * Equivalent to calling <code>launch(String, IProgressMontitor, boolean)</code>
- * with a <code>build</code> flag of <code>false</code>.
- * </p>
- * @param mode the mode in which to launch, one of the mode constants
- * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
- * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
- * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
- * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
- * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
- * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
- * @return the resulting launch
- * @exception CoreException if this method fails. Reasons include:<ul>
- * <li>unable to instantiate the underlying launch configuration delegate</li>
- * <li>the launch fails (in the delegate)</code>
- * </ul>
- */
- public ILaunch launch(String mode, IProgressMonitor monitor) throws CoreException;
-
- /**
- * Launches this configuration in the specified mode by delegating to
- * this configuration's launch configuration delegate, and returns the
- * resulting launch.
- * <p>
- * If this configuration's launch delegate implements
- * <code>ILaunchConfigurationDelegate2</code>, the launch delegate will
- * be consulted to provide a launch object for the launch,
- * perform pre-launch checks, and build before the launch.
- * If <code>build</code> is <code>true</code> and the associated launch
- * delegate does not implement <code>ILaunchConfigurationDelegate2</code>
- * an incremental workspace build will be performed before the launch
- * by the debug platform.
- * </p>
- * <p>
- * The resulting launch object is registered with the launch manager
- * before passing it to this configuration's delegate launch method, for
- * contributions (debug targets and processes).
- * </p>
- * <p>
- * If the delegate contributes a source locator to the launch, that
- * source locator is used. Otherwise an appropriate source locator is
- * contributed to the launch based on the values of
- * <code>ATTR_SOURCE_LOCATOR_ID</code> and
- * <code>ATTR_SOURCE_LOCATOR_MEMENTO</code>. If the launch is canceled (via
- * the given progress monitor), the launch is removed from the launch
- * manager. The launch is returned whether canceled or not. Invoking this
- * method causes the underlying launch configuration delegate to be
- * instantiated (if not already).
- * </p>
- * @param mode the mode in which to launch, one of the mode constants
- * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
- * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
- * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
- * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
- * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
- * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
- * @param build whether the workspace should be built before the launch
- * @return resulting launch
- * @throws CoreException if an exception occurs during the launch sequence
- * @since 3.0
- */
- public ILaunch launch(String mode, IProgressMonitor monitor, boolean build) throws CoreException;
-
- /**
- * Launches this configuration in the specified mode by delegating to
- * this configuration's launch configuration delegate, and returns the
- * resulting launch.
- * <p>
- * If this configuration's launch delegate implements
- * <code>ILaunchConfigurationDelegate2</code>, the launch delegate will
- * be consulted to provide a launch object for the launch,
- * perform pre-launch checks, and build before the launch.
- * If <code>build</code> is <code>true</code> and the associated launch
- * delegate does not implement <code>ILaunchConfigurationDelegate2</code>
- * an incremental workspace build will be performed before the launch
- * by the debug platform.
- * </p>
- * <p>
- * When <code>register</code> is <code>true</code>, the resulting launch object
- * is registered with the launch manager before passing it to this configuration's delegate
- * launch method, for contributions (debug targets and processes). When
- * <code>register</code> is <code>false</code>, the launch is not registered with
- * the launch manager. Clients that launch configurations without registering
- * a launch should register appropriate debug event filters to intercept events
- * from unregistered launches.
- * </p>
- * <p>
- * If the delegate contributes a source locator to the launch, that
- * source locator is used. Otherwise an appropriate source locator is
- * contributed to the launch based on the values of
- * <code>ATTR_SOURCE_LOCATOR_ID</code> and
- * <code>ATTR_SOURCE_LOCATOR_MEMENTO</code>. If the launch is canceled (via
- * the given progress monitor), the launch is removed from the launch
- * manager. The launch is returned whether canceled or not. Invoking this
- * method causes the underlying launch configuration delegate to be
- * instantiated (if not already).
- * </p>
- * @param mode the mode in which to launch, one of the mode constants
- * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
- * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
- * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
- * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
- * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
- * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
- * @param build whether the workspace should be built before the launch
- * @param register whether to register the resulting launch with the launch manager
- * @return resulting launch
- * @throws CoreException if an exception occurs during the launch sequence
- * @since 3.1
- */
- public ILaunch launch(String mode, IProgressMonitor monitor, boolean build, boolean register) throws CoreException;
-
- /**
- * Migrates this launch configuration to be compatible with current tooling.
- * Has no effect if this configuration is not a candidate for migration.
- * Migration is performed by a launch configuration migration delegate.
- * @throws CoreException if migration fails
- * @since 3.2
- * @see ILaunchConfigurationMigrationDelegate
- */
- public void migrate() throws CoreException;
-
- /**
- * Returns whether this launch configuration supports the
- * specified mode. This is a handle-only method.
- *
- * @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 launch configuration supports the
- * specified mode
- * @exception CoreException if this method fails. Reasons include:
- * <ul>
- * <li>Unable to retrieve this launch configuration's type.</li>
- * </ul>
- */
- public boolean supportsMode(String mode) throws CoreException;
-
- /**
- * Returns whether this launch configuration is read-only.
- * A read-only configuration cannot be modified.
- *
- * @return whether this configuration is read-only
- *
- * @since 3.3
- */
- public boolean isReadOnly();
-}
+/*******************************************************************************
+ * Copyright (c) 2000, 2011 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.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.eclipse.core.filesystem.EFS;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.IProgressMonitor;
+
+/**
+ * A launch configuration describes how to launch an application.
+ * Each launch configuration is an instance of a type of launch
+ * configuration as described by a launch configuration type
+ * extension. Each launch configuration has a launch configuration
+ * delegate which performs the actual launching of a
+ * configuration.
+ * <p>
+ * A launch configuration may be shared in a repository via
+ * standard VCM mechanisms, or may be stored locally, essentially
+ * making the launch configuration private for a single user.
+ * Thus, a launch configuration may stored as a file in the
+ * workspace (shared), or as a file in the debug plug-in's state
+ * location.
+ * </p>
+ * A launch configuration is a handle to its underlying storage.
+ * Methods annotated as "handle-only" do not require a configuration
+ * to exist. Methods that require an underlying configuration to exist
+ * throw a <code>CoreException</code> when an underlying configuration
+ * is missing.
+ * </p>
+ * <p>
+ * A launch configuration is modified by obtaining a working copy
+ * of a launch configuration, modifying the working copy, and then
+ * saving the working copy.
+ * </p>
+ * <p>
+ * Clients that define a launch configuration delegate extension implement the
+ * <code>ILaunchConfigurationDelegate</code> interface.
+ * </p>
+ * @see ILaunchConfigurationType
+ * @see org.eclipse.debug.core.model.ILaunchConfigurationDelegate
+ * @see ILaunchConfigurationWorkingCopy
+ * @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 ILaunchConfiguration extends IAdaptable {
+
+ /**
+ * The file extension for launch configuration files
+ * (value <code>"launch"</code>).
+ */
+ public static final String LAUNCH_CONFIGURATION_FILE_EXTENSION = "launch"; //$NON-NLS-1$
+
+ /**
+ * Launch configuration attribute storing an identifier of
+ * a persistable source locator extension. When this attribute is
+ * specified, a new source locator will be created automatically and
+ * associated with the launch for this configuration.
+ *
+ * @see org.eclipse.debug.core.model.IPersistableSourceLocator
+ */
+ public static final String ATTR_SOURCE_LOCATOR_ID = DebugPlugin.getUniqueIdentifier() + ".source_locator_id"; //$NON-NLS-1$
+
+ /**
+ * Launch configuration attribute storing a memento of a
+ * source locator. When this attribute is specified in
+ * conjunction with a source locator id, the source locator
+ * created for a launch will be initialized with this memento.
+ * When not specified, but a source locator id is specified,
+ * the source locator will be initialized to default values.
+ *
+ * @see org.eclipse.debug.core.model.IPersistableSourceLocator
+ */
+ public static final String ATTR_SOURCE_LOCATOR_MEMENTO = DebugPlugin.getUniqueIdentifier() + ".source_locator_memento"; //$NON-NLS-1$
+
+ /**
+ * Returns whether the contents of this launch configuration are
+ * equal to the contents of the given launch configuration.
+ *
+ * @param configuration launch configuration
+ * @return whether the contents of this launch configuration are equal to the contents
+ * of the specified launch configuration.
+ */
+ public boolean contentsEqual(ILaunchConfiguration configuration);
+
+ /**
+ * Returns a copy of this launch configuration, as a
+ * working copy, with the specified name. The new
+ * working copy does not refer back to this configuration
+ * as its original launch configuration (the working copy
+ * will return <code>null</code> for <code>getOriginal()</code>).
+ * When the working copy is saved it will not affect this
+ * launch configuration.
+ *
+ * @param name the name of the copy
+ * @return a copy of this launch configuration
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while initializing the contents of the
+ * working copy from this configuration's underlying storage.</li>
+ * </ul>
+ * @see ILaunchConfigurationWorkingCopy#getOriginal()
+ */
+ public ILaunchConfigurationWorkingCopy copy(String name) throws CoreException;
+
+ /**
+ * Deletes this launch configuration. This configuration's underlying
+ * storage is deleted. Has no effect if this configuration
+ * does not exist.
+ *
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while deleting this configuration's
+ * underlying storage.</li>
+ * </ul>
+ */
+ public void delete() throws CoreException;
+
+ /**
+ * Returns whether this launch configuration's underlying
+ * storage exists. This is a handle-only method.
+ *
+ * @return whether this launch configuration's underlying
+ * storage exists
+ */
+ public boolean exists();
+
+ /**
+ * Returns the boolean-valued attribute with the given name.
+ * Returns the given default value if the attribute is undefined.
+ *
+ * @param attributeName the name of the attribute
+ * @param defaultValue the value to use if no value is found
+ * @return the value or the default value if no value was found.
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while retrieving the attribute from
+ * underlying storage.</li>
+ * <li>An attribute with the given name exists, but does not
+ * have a boolean value</li>
+ * </ul>
+ */
+ public boolean getAttribute(String attributeName, boolean defaultValue) throws CoreException;
+
+ /**
+ * Returns the integer-valued attribute with the given name.
+ * Returns the given default value if the attribute is undefined.
+ *
+ * @param attributeName the name of the attribute
+ * @param defaultValue the value to use if no value is found
+ * @return the value or the default value if no value was found.
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while retrieving the attribute from
+ * underlying storage.</li>
+ * <li>An attribute with the given name exists, but does not
+ * have an integer value</li>
+ * </ul>
+ */
+ public int getAttribute(String attributeName, int defaultValue) throws CoreException;
+
+ /**
+ * Returns the <code>java.util.List</code>-valued attribute with the given name.
+ * Returns the given default value if the attribute is undefined.
+ *
+ * @param attributeName the name of the attribute
+ * @param defaultValue the value to use if no value is found
+ * @return the value or the default value if no value was found.
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while retrieving the attribute from
+ * underlying storage.</li>
+ * <li>An attribute with the given name exists, but does not
+ * have a List value</li>
+ * </ul>
+ */
+ public List getAttribute(String attributeName, List defaultValue) throws CoreException;
+
+ /**
+ * Returns the <code>java.util.Set</code>-valued attribute with the given name.
+ * Returns the given default value if the attribute is undefined.
+ *
+ * @param attributeName the name of the attribute
+ * @param defaultValue the value to use if no value is found
+ * @return the value or the default value if no value was found.
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while retrieving the attribute from
+ * underlying storage.</li>
+ * <li>An attribute with the given name exists, but does not
+ * have a List value</li>
+ * </ul>
+ *
+ * @since 3.3
+ */
+ public Set getAttribute(String attributeName, Set defaultValue) throws CoreException;
+
+ /**
+ * Returns the <code>java.util.Map</code>-valued attribute with the given name.
+ * Returns the given default value if the attribute is undefined.
+ *
+ * @param attributeName the name of the attribute
+ * @param defaultValue the value to use if no value is found
+ * @return the value or the default value if no value was found.
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while retrieving the attribute from
+ * underlying storage.</li>
+ * <li>An attribute with the given name exists, but does not
+ * have a Map value</li>
+ * </ul>
+ */
+ public Map getAttribute(String attributeName, Map defaultValue) throws CoreException;
+
+ /**
+ * Returns the string-valued attribute with the given name.
+ * Returns the given default value if the attribute is undefined.
+ *
+ * @param attributeName the name of the attribute
+ * @param defaultValue the value to use if no value is found
+ * @return the value or the default value if no value was found.
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while retrieving the attribute from
+ * underlying storage.</li>
+ * <li>An attribute with the given name exists, but does not
+ * have a String value</li>
+ * </ul>
+ */
+ public String getAttribute(String attributeName, String defaultValue) throws CoreException;
+
+ /**
+ * Returns a map containing the attributes in this launch configuration.
+ * Returns an empty map if this configuration has no attributes.
+ * <p>
+ * Modifying the map does not affect this launch configuration's attributes.
+ * A launch configuration is modified by obtaining a working copy of that
+ * launch configuration, modifying the working copy, and then saving the working
+ * copy.
+ * </p>
+ * @return a map of attribute keys and values
+ * @exception CoreException unable to generate/retrieve an attribute map
+ * @since 2.1
+ */
+ public Map getAttributes() throws CoreException;
+
+ /**
+ * Returns this launch configuration's type's category, or <code>null</code>
+ * if unspecified. This is a handle-only method.
+ *
+ * @return this launch configuration's type's category, or <code>null</code>
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>Unable to retrieve or instantiate this launch configuration's type.</li>
+ * </ul>
+ * @since 2.1
+ */
+ public String getCategory() throws CoreException;
+
+ /**
+ * Returns the file this launch configuration is stored
+ * in, or <code>null</code> if this configuration is stored
+ * locally with the workspace. This is a handle-only method.
+ *
+ * @return the file this launch configuration is stored
+ * in, or <code>null</code> if this configuration is stored
+ * locally with the workspace
+ */
+ public IFile getFile();
+
+ /**
+ * Returns the location of this launch configuration as a
+ * path in the local file system or <code>null</code> if it cannot
+ * be mapped to a location in the local file system. This is a handle-only method.
+ * <p>
+ * Since 3.5, this method can return <code>null</code>. For example, when a
+ * launch configuration is stored in the workspace as an {@link IFile} in
+ * an external file system ({@link EFS}).
+ * </p>
+ *
+ * @return the location of this launch configuration as a
+ * path file system or <code>null</code> if it cannot be mapped
+ * to a location in the local file system. Since 3.5, this method
+ * can return <code>null</code>.
+ * @deprecated Since a launch configuration does not need to be stored in the local
+ * file system, this attribute should no longer be used to identify a launch configuration.
+ */
+ public IPath getLocation();
+
+ /**
+ * Returns the resources this launch configuration is associated with or <code>null</code>
+ * if none. Clients contributing launch configuration types are responsible for maintaining
+ * resource mappings as appropriate.
+ *
+ * @return the resources this launch configuration is associated with or <code>null</code>
+ * @throws CoreException unable to get the mapped resource
+ * @since 3.2
+ */
+ public IResource[] getMappedResources() throws CoreException;
+
+ /**
+ * Returns a memento for this launch configuration, or <code>null</code>
+ * if unable to generate a memento for this configuration. A memento
+ * can be used to re-create a launch configuration, via the
+ * launch manager.
+ *
+ * @return a memento for this configuration
+ * @see ILaunchManager#getLaunchConfiguration(String)
+ * @exception CoreException if an exception occurs generating this
+ * launch configuration's memento
+ */
+ public String getMemento() throws CoreException;
+
+ /**
+ * Returns the name of this launch configuration. This is
+ * a handle-only method.
+ *
+ * @return the name of this launch configuration
+ */
+ public String getName();
+
+ /**
+ * Returns the launch modes that have been set on this configuration.
+ * An empty set is returned if no specific launch modes have been set
+ * on a launch configuration.
+ * <p>
+ * Setting launch modes on a configuration allows a launch to be
+ * performed in mixed mode - for example, debug and profile at the
+ * same time.
+ * </p>
+ * @return this configuration's launch modes, possibly an empty set
+ * @exception CoreException if an exception occurs retrieving modes
+ * @since 3.3
+ */
+ public Set getModes() throws CoreException;
+
+ /**
+ * Returns the preferred launch delegate that has been set on this
+ * configuration or <code>null</code> if one is not specified.
+ *
+ * @param modes mode set for which a preferred delegate has been requested
+ * @return this configuration's preferred launch delegate for the specified mode set, or
+ * <code>null</code> if one is not specified
+ * @exception CoreException if an exception occurs retrieving preferred delegate
+ * @since 3.3
+ */
+ public ILaunchDelegate getPreferredDelegate(Set modes) throws CoreException;
+
+ /**
+ * Returns the type of this launch configuration. This is a
+ * handle-only method.
+ *
+ * @return the type of this launch configuration
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>Unable to retrieve or instantiate this launch configuration's type.</li>
+ * </ul>
+ * @see ILaunchConfigurationType
+ */
+ public ILaunchConfigurationType getType() throws CoreException;
+
+ /**
+ * Returns a working copy of this launch configuration.
+ * Since 3.3, if this method is called on a working copy, a nested working
+ * copy is created (a working copy of a working copy).
+ * Changes to the working copy will be applied to this
+ * launch configuration when saved, or to the parent working copy.
+ * The working copy will refer to this launch configuration as its original
+ * launch configuration, or the working copy it was created from.
+ * <p>
+ * When a working copy (B) is created from a working copy (A), the newly
+ * created working copy (B) is initialized with the attributes from
+ * the first working copy (A). Whenever a working copy is saved, it is written
+ * back to the working copy from which it was created: in this example working
+ * copy B will write back to working copy A, and A will write back to the
+ * original launch configuration.
+ * </p>
+ * @return a working copy of this launch configuration, or a nested working copy if called
+ * on an instance of <code>ILaunchConfigurationWorkingCopy</code>
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>An exception occurs while initializing the contents of the
+ * working copy from this configuration's underlying storage.</li>
+ * </ul>
+ * @see ILaunchConfigurationWorkingCopy#getOriginal()
+ */
+ public ILaunchConfigurationWorkingCopy getWorkingCopy() throws CoreException;
+
+ /**
+ * Returns whether this configuration contains an attribute with the given name.
+ *
+ * @param attributeName the name of the attribute
+ * @return true if this configuration has the specified attribute false otherwise
+ * @throws CoreException if unable to retrieve attributes
+ *
+ * @since 3.4
+ */
+ public boolean hasAttribute(String attributeName) throws CoreException;
+
+ /**
+ * Returns whether this launch configuration is stored
+ * locally within the workspace. This is a handle-only method.
+ *
+ * @return whether this launch configuration is stored
+ * locally with the workspace
+ */
+ public boolean isLocal();
+
+ /**
+ * Returns whether this launch configuration is a candidate for migration.
+ *
+ * @return whether this launch configuration is a candidate for migration
+ * @throws CoreException if a problem is encountered
+ * @see ILaunchConfigurationMigrationDelegate
+ * @since 3.2
+ */
+ public boolean isMigrationCandidate() throws CoreException ;
+
+ /**
+ * Returns whether this launch configuration is a working
+ * copy. Launch configurations which return <code>true</code>
+ * to this method can be safely cast to
+ * <code>org.eclipse.debug.core.ILaunchConfigurationWorkingCopy</code>.
+ * This is a handle-only method.
+ *
+ * @return whether this launch configuration is a working
+ * copy
+ */
+ public boolean isWorkingCopy();
+
+ /**
+ * Launches this configuration in the specified mode by delegating to
+ * this configuration's launch configuration delegate, and returns the
+ * resulting launch.
+ * <p>
+ * Equivalent to calling <code>launch(String, IProgressMontitor, boolean)</code>
+ * with a <code>build</code> flag of <code>false</code>.
+ * </p>
+ * @param mode the mode in which to launch, one of the mode constants
+ * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
+ * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
+ * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
+ * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
+ * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
+ * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
+ * @return the resulting launch
+ * @exception CoreException if this method fails. Reasons include:<ul>
+ * <li>unable to instantiate the underlying launch configuration delegate</li>
+ * <li>the launch fails (in the delegate)</code>
+ * </ul>
+ */
+ public ILaunch launch(String mode, IProgressMonitor monitor) throws CoreException;
+
+ /**
+ * Launches this configuration in the specified mode by delegating to
+ * this configuration's launch configuration delegate, and returns the
+ * resulting launch.
+ * <p>
+ * If this configuration's launch delegate implements
+ * <code>ILaunchConfigurationDelegate2</code>, the launch delegate will
+ * be consulted to provide a launch object for the launch,
+ * perform pre-launch checks, and build before the launch.
+ * If <code>build</code> is <code>true</code> and the associated launch
+ * delegate does not implement <code>ILaunchConfigurationDelegate2</code>
+ * an incremental workspace build will be performed before the launch
+ * by the debug platform.
+ * </p>
+ * <p>
+ * The resulting launch object is registered with the launch manager
+ * before passing it to this configuration's delegate launch method, for
+ * contributions (debug targets and processes).
+ * </p>
+ * <p>
+ * If the delegate contributes a source locator to the launch, that
+ * source locator is used. Otherwise an appropriate source locator is
+ * contributed to the launch based on the values of
+ * <code>ATTR_SOURCE_LOCATOR_ID</code> and
+ * <code>ATTR_SOURCE_LOCATOR_MEMENTO</code>. If the launch is canceled (via
+ * the given progress monitor), the launch is removed from the launch
+ * manager. The launch is returned whether canceled or not. Invoking this
+ * method causes the underlying launch configuration delegate to be
+ * instantiated (if not already).
+ * </p>
+ * @param mode the mode in which to launch, one of the mode constants
+ * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
+ * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
+ * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
+ * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
+ * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
+ * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
+ * @param build whether the workspace should be built before the launch
+ * @return resulting launch
+ * @throws CoreException if an exception occurs during the launch sequence
+ * @since 3.0
+ */
+ public ILaunch launch(String mode, IProgressMonitor monitor, boolean build) throws CoreException;
+
+ /**
+ * Launches this configuration in the specified mode by delegating to
+ * this configuration's launch configuration delegate, and returns the
+ * resulting launch.
+ * <p>
+ * If this configuration's launch delegate implements
+ * <code>ILaunchConfigurationDelegate2</code>, the launch delegate will
+ * be consulted to provide a launch object for the launch,
+ * perform pre-launch checks, and build before the launch.
+ * If <code>build</code> is <code>true</code> and the associated launch
+ * delegate does not implement <code>ILaunchConfigurationDelegate2</code>
+ * an incremental workspace build will be performed before the launch
+ * by the debug platform.
+ * </p>
+ * <p>
+ * When <code>register</code> is <code>true</code>, the resulting launch object
+ * is registered with the launch manager before passing it to this configuration's delegate
+ * launch method, for contributions (debug targets and processes). When
+ * <code>register</code> is <code>false</code>, the launch is not registered with
+ * the launch manager. Clients that launch configurations without registering
+ * a launch should register appropriate debug event filters to intercept events
+ * from unregistered launches.
+ * </p>
+ * <p>
+ * If the delegate contributes a source locator to the launch, that
+ * source locator is used. Otherwise an appropriate source locator is
+ * contributed to the launch based on the values of
+ * <code>ATTR_SOURCE_LOCATOR_ID</code> and
+ * <code>ATTR_SOURCE_LOCATOR_MEMENTO</code>. If the launch is canceled (via
+ * the given progress monitor), the launch is removed from the launch
+ * manager. The launch is returned whether canceled or not. Invoking this
+ * method causes the underlying launch configuration delegate to be
+ * instantiated (if not already).
+ * </p>
+ * @param mode the mode in which to launch, one of the mode constants
+ * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
+ * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
+ * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
+ * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
+ * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
+ * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
+ * @param build whether the workspace should be built before the launch
+ * @param register whether to register the resulting launch with the launch manager
+ * @return resulting launch
+ * @throws CoreException if an exception occurs during the launch sequence
+ * @since 3.1
+ */
+ public ILaunch launch(String mode, IProgressMonitor monitor, boolean build, boolean register) throws CoreException;
+
+ /**
+ * Migrates this launch configuration to be compatible with current tooling.
+ * Has no effect if this configuration is not a candidate for migration.
+ * Migration is performed by a launch configuration migration delegate.
+ * @throws CoreException if migration fails
+ * @since 3.2
+ * @see ILaunchConfigurationMigrationDelegate
+ */
+ public void migrate() throws CoreException;
+
+ /**
+ * Returns whether this launch configuration supports the
+ * specified mode. This is a handle-only method.
+ *
+ * @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 launch configuration supports the
+ * specified mode
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>Unable to retrieve this launch configuration's type.</li>
+ * </ul>
+ */
+ public boolean supportsMode(String mode) throws CoreException;
+
+ /**
+ * Returns whether this launch configuration is read-only.
+ * A read-only configuration cannot be modified.
+ *
+ * @return whether this configuration is read-only
+ *
+ * @since 3.3
+ */
+ public boolean isReadOnly();
+}
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 1a24538b5..375dc34ca 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, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -140,7 +140,7 @@ public interface ILaunchConfigurationType extends IAdaptable {
* @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
+ * @throws CoreException if a problem is encountered
* @since 3.3
*/
public ILaunchDelegate[] getDelegates(Set modes) throws CoreException;
@@ -151,7 +151,7 @@ public interface ILaunchConfigurationType extends IAdaptable {
*
* @param modes the set of modes to support
* @return the preferred delegate or <code>null</code> if none
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*
* @since 3.3
*/
@@ -164,7 +164,7 @@ public interface ILaunchConfigurationType extends IAdaptable {
*
* @param modes launch mode combination
* @param delegate preferred launch delegate or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*
* @since 3.3
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchManager.java
index 08be84bfe..4796bec88 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchManager.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2009 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -197,7 +197,7 @@ public interface ILaunchManager {
* </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
+ * @throws CoreException if a problem is encountered
*
* @since 3.4
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/RefreshUtil.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/RefreshUtil.java
index 2c516a2a7..0a2a2bc44 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/RefreshUtil.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/RefreshUtil.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2009 IBM Corporation and others.
+ * Copyright (c) 2009, 2011 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
@@ -258,7 +258,7 @@ public class RefreshUtil {
* Returns whether the refresh scope specified by the given launch
* configuration is recursive.
*
- * @param configuration
+ * @param configuration the {@link ILaunchConfiguration}
* @return whether the refresh scope is recursive
* @throws CoreException
* if unable to access the associated attribute
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/commands/AbstractDebugCommand.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/commands/AbstractDebugCommand.java
index 1dc6b994b..82addc5ab 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/commands/AbstractDebugCommand.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/commands/AbstractDebugCommand.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006, 2009 IBM Corporation and others.
+ * Copyright (c) 2006, 2011 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
@@ -52,7 +52,7 @@ public abstract class AbstractDebugCommand implements IDebugCommandHandler {
/**
* Creates a new job to update the specified request
*
- * @param stateRequest
+ * @param stateRequest the {@link IEnabledStateRequest}
*/
UpdateJob(IEnabledStateRequest stateRequest) {
super(getEnabledStateTaskName());
@@ -304,6 +304,7 @@ public abstract class AbstractDebugCommand implements IDebugCommandHandler {
* @param monitor progress monitor
* @param request can be used to cancel this update request
* @return whether this command can be executed for the given targets
+ * @throws CoreException if a problem is encountered
*/
protected abstract boolean isExecutable(Object[] targets, IProgressMonitor monitor, IEnabledStateRequest request) throws CoreException;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/DebugElement.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/DebugElement.java
index 2d139433f..bf5a31865 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/DebugElement.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/DebugElement.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2005, 2007 IBM Corporation and others.
+ * Copyright (c) 2005, 2011 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
@@ -147,7 +147,7 @@ public abstract class DebugElement extends PlatformObject implements IDebugEleme
*
* @param message exception message
* @param e underlying exception or <code>null</code>
- * @throws DebugException
+ * @throws DebugException if a problem is encountered
*/
protected void requestFailed(String message, Throwable e) throws DebugException {
throw new DebugException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(),
@@ -159,7 +159,7 @@ public abstract class DebugElement extends PlatformObject implements IDebugEleme
*
* @param message exception message
* @param e underlying exception or <code>null</code>
- * @throws DebugException
+ * @throws DebugException if a problem is encountered
*/
protected void notSupported(String message, Throwable e) throws DebugException {
throw new DebugException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(),
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/AbstractSourceLookupDirector.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/AbstractSourceLookupDirector.java
index 1060e589c..f6918d659 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/AbstractSourceLookupDirector.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/AbstractSourceLookupDirector.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004, 2009 IBM Corporation and others.
+ * Copyright (c) 2004, 2011 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
@@ -230,7 +230,7 @@ public abstract class AbstractSourceLookupDirector implements ISourceLookupDirec
*
* @param message error message
* @param exception underlying exception, or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void abort(String message, Throwable exception) throws CoreException {
IStatus status = new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, message, exception);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainer.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainer.java
index cab9d8854..613d62ca9 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainer.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainer.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2009 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -40,7 +40,7 @@ public abstract class AbstractSourceContainer extends PlatformObject implements
*
* @param message error message
* @param exception underlying exception, or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void abort(String message, Throwable exception) throws CoreException {
IStatus status = new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, message, exception);
@@ -52,7 +52,7 @@ public abstract class AbstractSourceContainer extends PlatformObject implements
*
* @param message error message
* @param exception underlying exception, or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
* @since 3.3
*/
protected void warn(String message, Throwable exception) throws CoreException {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainerTypeDelegate.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainerTypeDelegate.java
index cffc4dabe..bbbff4f76 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainerTypeDelegate.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/AbstractSourceContainerTypeDelegate.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2009 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -32,7 +32,7 @@ public abstract class AbstractSourceContainerTypeDelegate implements ISourceCont
*
* @param message error message
* @param exception underlying exception, or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void abort(String message, Throwable exception) throws CoreException {
IStatus status = new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, message, exception);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/CompositeSourceContainer.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/CompositeSourceContainer.java
index ca07e6ad7..ed442127b 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/CompositeSourceContainer.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/CompositeSourceContainer.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2003, 2009 IBM Corporation and others.
+ * Copyright (c) 2003, 2011 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
@@ -116,6 +116,7 @@ public abstract class CompositeSourceContainer extends AbstractSourceContainer {
/**
* Creates the source containers in this composite container.
* Subclasses should override this methods.
+ * @return the array of {@link ISourceContainer}s
*
* @throws CoreException if unable to create the containers
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ContainerSourceContainer.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ContainerSourceContainer.java
index fc9ea661b..82a0290a0 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ContainerSourceContainer.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ContainerSourceContainer.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2003, 2009 IBM Corporation and others.
+ * Copyright (c) 2003, 2011 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
@@ -199,6 +199,7 @@ public abstract class ContainerSourceContainer extends CompositeSourceContainer
* Validates the given string as a path for a file in this container.
*
* @param name path name
+ * @return <code>true</code> if the path is valid <code>false</code> otherwise
*/
private boolean validateFile(String name) {
IContainer container = getContainer();
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ExternalArchiveSourceContainer.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ExternalArchiveSourceContainer.java
index d1bb037e9..70241e758 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ExternalArchiveSourceContainer.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/containers/ExternalArchiveSourceContainer.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -135,6 +135,7 @@ public class ExternalArchiveSourceContainer extends AbstractSourceContainer {
*
* @param file zip file to search in
* @param name file name
+ * @return the {@link ZipEntry} with the given name or <code>null</code>
* @exception CoreException if an exception occurs while detecting the root
*/
private ZipEntry searchRoots(ZipFile file, String name) throws CoreException {
@@ -208,6 +209,7 @@ public class ExternalArchiveSourceContainer extends AbstractSourceContainer {
/**
* Returns the archive to search in.
+ * @return the {@link ZipFile} to search in
*
* @throws CoreException if unable to access the archive
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java
index 6bd2824e2..72a93b1d6 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2008 IBM Corporation and others.
+ * Copyright (c) 2008, 2011 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
@@ -29,7 +29,7 @@ import org.eclipse.debug.core.model.IBreakpointImportParticipant;
</extension>
* </pre>
*
- * @noextend This class is not intended to be subclassed by clients.
+ * @noextend This class is not intended to be sub-classed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*
* @since 3.5
@@ -55,7 +55,7 @@ public class BreakpointImportParticipantDelegate {
* a problem loading the delegate
*
* @return the {@link IBreakpointImportParticipant} or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
public IBreakpointImportParticipant getDelegate() throws CoreException {
if(fParticipant == null) {
@@ -68,7 +68,7 @@ public class BreakpointImportParticipantDelegate {
* Returns the marker type this participant is registered for.
*
* @return the marker type this participant is registered for
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
public String getType() throws CoreException {
return fElement.getAttribute(IConfigurationElementConstants.TYPE);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java
index c7f12a82f..4275ff851 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java
@@ -21,20 +21,6 @@ import java.util.Map;
import java.util.Set;
import java.util.Vector;
-import com.ibm.icu.text.MessageFormat;
-
-import org.eclipse.core.runtime.CoreException;
-import org.eclipse.core.runtime.IConfigurationElement;
-import org.eclipse.core.runtime.IExtensionPoint;
-import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.core.runtime.ISafeRunnable;
-import org.eclipse.core.runtime.IStatus;
-import org.eclipse.core.runtime.ListenerList;
-import org.eclipse.core.runtime.Platform;
-import org.eclipse.core.runtime.SafeRunner;
-import org.eclipse.core.runtime.Status;
-import org.eclipse.core.runtime.jobs.Job;
-
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IMarkerDelta;
import org.eclipse.core.resources.IProject;
@@ -46,7 +32,17 @@ import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
-
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExtensionPoint;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.ISafeRunnable;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.ListenerList;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.core.runtime.SafeRunner;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.IBreakpointListener;
@@ -56,6 +52,8 @@ import org.eclipse.debug.core.IBreakpointsListener;
import org.eclipse.debug.core.model.IBreakpoint;
import org.eclipse.debug.core.model.IBreakpointImportParticipant;
+import com.ibm.icu.text.MessageFormat;
+
/**
* The breakpoint manager manages all registered breakpoints
* for the debug plug-in. It is instantiated by the debug plug-in at startup.
@@ -79,7 +77,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* Map of breakpoint import participants.
* Map has the form:
- * <pre>Map(String - markerid, List of {@link IBreakpointImportParticipantDelegate})</pre>
+ * <pre>Map(String - marker_id, List of {@link IBreakpointImportParticipant})</pre>
*/
private HashMap fImportParticipants = null;
@@ -253,6 +251,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
*
* @param resource the resource which contains the breakpoints
* @param notify whether to notify of the breakpoint additions
+ * @throws CoreException if a problem is encountered
*/
private void loadBreakpoints(IResource resource, boolean notify) throws CoreException {
initBreakpointExtensions();
@@ -287,6 +286,9 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
* does this for us (at shutdown, transient markers are not saved). However,
* the code is still present to delete non-persisted markers from old
* workspaces.
+ * @param resource the {@link IResource} to get markers for
+ * @return the complete listing of persisted markers for the given {@link IResource}
+ * @throws CoreException if a problem is encountered
*/
protected IMarker[] getPersistedMarkers(IResource resource) throws CoreException {
IMarker[] markers= resource.findMarkers(IBreakpoint.BREAKPOINT_MARKER, true, IResource.DEPTH_INFINITE);
@@ -363,6 +365,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* Convenience method to get the workspace
+ * @return the default {@link IWorkspace}
*/
private IWorkspace getWorkspace() {
return ResourcesPlugin.getWorkspace();
@@ -394,6 +397,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
* The BreakpointManager waits to load the breakpoints
* of the workspace until a request is made to retrieve the
* breakpoints.
+ * @return the underlying {@link Vector} of breakpoints
*/
private synchronized Vector getBreakpoints0() {
if (fBreakpoints == null) {
@@ -556,8 +560,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
*
* @param breakpoints the breakpoints to register
* @param notify whether to notify listeners of the add
- * @param loading whether the given breakpoints are being automatically loaded
- * from previously persisted markers
+ * @throws CoreException if a problem is encountered
*/
private void addBreakpoints(IBreakpoint[] breakpoints, boolean notify) throws CoreException {
List added = new ArrayList(breakpoints.length);
@@ -607,7 +610,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
* Returns whether change notification is to be suppressed for the given breakpoint.
* Used when adding breakpoints and changing the "REGISTERED" attribute.
*
- * @param breakpoint
+ * @param breakpoint the breakpoint
* @return boolean whether change notification is suppressed
*/
protected boolean isChangeSuppressed(IBreakpoint breakpoint) {
@@ -628,6 +631,8 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* Verifies that the breakpoint marker has the minimal required attributes,
* and throws a debug exception if not.
+ * @param breakpoint the {@link IBreakpoint} to verify
+ * @throws DebugException if a problem is encountered
*/
private void verifyBreakpoint(IBreakpoint breakpoint) throws DebugException {
try {
@@ -783,6 +788,9 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* Wrapper for handling adds
+ * @param rDelta the {@link IResourceDelta}
+ * @param marker the new {@link IMarker}
+ * @param mDelta the accompanying {@link IMarkerDelta}
*/
protected void handleAddBreakpoint(IResourceDelta rDelta, IMarker marker, IMarkerDelta mDelta) {
if (0 != (rDelta.getFlags() & IResourceDelta.MOVED_FROM)) {
@@ -812,6 +820,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* Wrapper for handling removes
+ * @param marker the {@link IMarker}
*/
protected void handleRemoveBreakpoint(IMarker marker) {
synchronized (fPostChangMarkersChanged) {
@@ -826,6 +835,8 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* Wrapper for handling changes
+ * @param marker the {@link IMarker} that was changed
+ * @param delta the {@link IMarkerDelta}
*/
protected void handleChangeBreakpoint(IMarker marker, IMarkerDelta delta) {
IBreakpoint breakpoint= getBreakpoint(marker);
@@ -838,6 +849,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis
/**
* A project has been opened or closed. Updates the breakpoints for
* that project
+ * @param project the {@link IProject} that was changed
*/
private void handleProjectResourceOpenStateChange(final IResource project) {
if (!project.isAccessible()) {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java
index 5b0360c12..0fc30b27a 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -481,7 +481,6 @@ public class ExpressionManager extends PlatformObject implements IExpressionMana
* expressions to store this change as indicated
*
* @param expression the changed expression
- * @param persist whether to persist the expressions
*/
protected void watchExpressionChanged(IWatchExpression expression) {
boolean notify = false;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java
index 11344dde6..7970718ab 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java
@@ -176,7 +176,7 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig
/**
* Given a name that ends with .launch, return the simple name of the configuration.
*
- * @param fileName
+ * @param fileName the name to parse
* @return simple name
* @since 3.5
*/
@@ -328,8 +328,8 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig
/**
* Returns whether the given objects are equal or both <code>null</code>.
*
- * @param o1
- * @param o2
+ * @param o1 the object
+ * @param o2 the object to be compared to o1
* @return whether the given objects are equal or both <code>null</code>
* @since 3.5
*/
@@ -485,7 +485,7 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig
* is in a project that is closed or does not exist, <code>null</code> is returned.
*
* @return file store this configuration is persisted in or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
* @since 3.5
*/
public IFileStore getFileStore() throws CoreException {
@@ -645,6 +645,7 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig
* by this configuration.
*
* @param launch the launch on which to set the source locator
+ * @throws CoreException if a problem is encountered
*/
protected void initializeSourceLocator(ILaunch launch) throws CoreException {
if (launch.getSourceLocator() == null) {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java
index 810ffeb31..3b2751197 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -38,7 +38,9 @@ public class LaunchConfigurationComparator implements Comparator {
}
/**
- * Returns the resolver delegate (and creates if required)
+ * Returns the {@link Comparator} delegate
+ *
+ * @return the {@link Comparator}
*/
protected Comparator getComparator() {
if (fDelegate == null) {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java
index 0b9cde3f6..e62171c5f 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -117,7 +117,7 @@ public class LaunchConfigurationInfo {
/**
* Sets the attributes in this info to those in the given map.
*
- * @param map
+ * @param map the {@link Map} of attributes to set
*/
protected void setAttributes(Map map) {
if (map == null) {
@@ -130,6 +130,8 @@ public class LaunchConfigurationInfo {
/**
* Returns the <code>String</code> attribute with the given key or the
* given default value if undefined.
+ * @param key the attribute name
+ * @param defaultValue the value to be returned if the given key does not exist in the attribute table
*
* @return attribute specified by given key or the defaultValue if undefined
* @throws CoreException
@@ -155,6 +157,8 @@ public class LaunchConfigurationInfo {
/**
* Returns the <code>int</code> attribute with the given key or the given
* default value if undefined.
+ * @param key the name of the attribute
+ * @param defaultValue the default value to return if the key does not appear in the attribute table
*
* @return attribute specified by given key or the defaultValue if undefined
* @throws CoreException
@@ -180,6 +184,8 @@ public class LaunchConfigurationInfo {
/**
* Returns the <code>boolean</code> attribute with the given key or the
* given default value if undefined.
+ * @param key the name of the attribute
+ * @param defaultValue the default value to return if the key does not appear in the attribute table
*
* @return attribute specified by given key or the defaultValue if undefined
* @throws CoreException
@@ -205,6 +211,8 @@ public class LaunchConfigurationInfo {
/**
* Returns the <code>java.util.List</code> attribute with the given key or
* the given default value if undefined.
+ * @param key the name of the attribute
+ * @param defaultValue the default value to return if the key does not appear in the attribute table
*
* @return attribute specified by given key or the defaultValue if undefined
* @throws CoreException
@@ -230,6 +238,8 @@ public class LaunchConfigurationInfo {
/**
* Returns the <code>java.util.Set</code> attribute with the given key or
* the given default value if undefined.
+ * @param key the name of the attribute
+ * @param defaultValue the default value to return if the key does not xist in the attribute table
*
* @return attribute specified by given key or the defaultValue if undefined
* @throws CoreException
@@ -257,6 +267,8 @@ public class LaunchConfigurationInfo {
/**
* Returns the <code>java.util.Map</code> attribute with the given key or
* the given default value if undefined.
+ * @param key the name of the attribute
+ * @param defaultValue the default value to return if the key does not exist in the attribute table
*
* @return attribute specified by given key or the defaultValue if undefined
* @throws CoreException
@@ -400,6 +412,11 @@ public class LaunchConfigurationInfo {
/**
* Helper method that creates a 'key value' element of the specified type
* with the specified attribute values.
+ * @param doc the {@link Document}
+ * @param elementType the {@link Element} type to create
+ * @param key the {@link Element} key
+ * @param value the {@link Element} value
+ * @return the new {@link Element}
*/
protected Element createKeyValueElement(Document doc, String elementType, String key, String value) {
Element element = doc.createElement(elementType);
@@ -414,7 +431,7 @@ public class LaunchConfigurationInfo {
*
* @param doc the doc to add the element to
* @param elementType the type of the element
- * @param setKey the key for the element
+ * @param listKey the key for the element
* @param list the list to fill the new element with
* @return the new element
*/
@@ -464,7 +481,7 @@ public class LaunchConfigurationInfo {
*
* @param doc the doc to add the element to
* @param elementType the type of the element
- * @param setKey the key for the element
+ * @param mapKey the key for the element
* @param map the map to fill the new element with
* @return the new element
*
@@ -490,7 +507,7 @@ public class LaunchConfigurationInfo {
/**
* Initializes the mapping of attributes from the XML file
* @param root the root node from the XML document
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void initializeFromXML(Element root) throws CoreException {
if (!root.getNodeName().equalsIgnoreCase(LAUNCH_CONFIGURATION)) {
@@ -544,7 +561,7 @@ public class LaunchConfigurationInfo {
/**
* Loads a <code>String</code> from the specified element into the local attribute mapping
* @param element the element to load from
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void setStringAttribute(Element element) throws CoreException {
setAttribute(getKeyAttribute(element), getValueAttribute(element));
@@ -553,7 +570,7 @@ public class LaunchConfigurationInfo {
/**
* Loads an <code>Integer</code> from the specified element into the local attribute mapping
* @param element the element to load from
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void setIntegerAttribute(Element element) throws CoreException {
setAttribute(getKeyAttribute(element), new Integer(getValueAttribute(element)));
@@ -562,7 +579,7 @@ public class LaunchConfigurationInfo {
/**
* Loads a <code>Boolean</code> from the specified element into the local attribute mapping
* @param element the element to load from
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected void setBooleanAttribute(Element element) throws CoreException {
setAttribute(getKeyAttribute(element), Boolean.valueOf(getValueAttribute(element)));
@@ -655,7 +672,7 @@ public class LaunchConfigurationInfo {
* Returns the <code>String</code> representation of the 'key' attribute from the specified element
* @param element the element to read from
* @return the value
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected String getKeyAttribute(Element element) throws CoreException {
String key = element.getAttribute(KEY);
@@ -669,7 +686,7 @@ public class LaunchConfigurationInfo {
* Returns the <code>String</code> representation of the 'value' attribute from the specified element
* @param element the element to read from
* @return the value
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
protected String getValueAttribute(Element element) throws CoreException {
String value = element.getAttribute(VALUE);
@@ -773,7 +790,7 @@ public class LaunchConfigurationInfo {
/**
* Returns if the attribute map contains the specified key
- * @param attributeName
+ * @param attributeName the name of the attribute to check for
* @return true if the attribute map contains the specified key, false otherwise
*
* @since 3.4.0
@@ -786,7 +803,7 @@ public class LaunchConfigurationInfo {
* Removes the specified attribute from the mapping and returns
* its value, or <code>null</code> if none. Does nothing
* if the attribute name is <code>null</code>
- * @param attributeName
+ * @param attributeName the name of the attribute to remove
* @return attribute value or <code>null</code>
*
* @since 3.4.0
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java
index f3d3a555f..39890ae86 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -401,7 +401,7 @@ public class LaunchConfigurationType extends PlatformObject implements ILaunchCo
* if we initialize the delegate and it has not been provided, return false instead of failing
* @param candidate the candidate to inspect for migration suitability
* @return true if the specified launch configuration is suitable for migration, false otherwise
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*
* @since 3.2
*/
@@ -415,7 +415,7 @@ public class LaunchConfigurationType extends PlatformObject implements ILaunchCo
/**
* This method initializes the migration delegate
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
private synchronized void initializeMigrationDelegate() throws CoreException {
if(fElement.getAttribute(IConfigurationElementConstants.MIGRATION_DELEGATE) != null && fMigrationDelegate == null) {
@@ -440,7 +440,7 @@ public class LaunchConfigurationType extends PlatformObject implements ILaunchCo
* Migrates the specified launch configuration by loading its delegate.
* In the event the migration delegate has not been provided do nothing.
* @param candidate the candidate launch configuration to migrate
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*
* @since 3.2
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java
index fb2820235..da3db4b35 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -173,9 +173,9 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen
/**
* Saves with progress.
*
- * @param monitor
+ * @param monitor the {@link IProgressMonitor}
* @return the saved <code>ILaunchConfiguration</code>
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*
* @since 3.3
*/
@@ -228,7 +228,8 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen
/**
* Performs the actual saving of the launch configuration.
- * @throws CoreException
+ * @param monitor the {@link IProgressMonitor}
+ * @throws CoreException if a problem is encountered
*/
private void doSave0(IProgressMonitor monitor) throws CoreException {
SubMonitor lmonitor = SubMonitor.convert(monitor, MessageFormat.format(DebugCoreMessages.LaunchConfigurationWorkingCopy_0, new String[] {getName()}), 2);
@@ -259,6 +260,7 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen
/**
* Writes the new configuration information to a file.
+ * @param monitor the {@link IProgressMonitor}
*
* @exception CoreException if writing the file fails
*/
@@ -388,9 +390,9 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen
/**
* Updates the given monitor with the given tick count and polls for cancellation. If the monitor
* is cancelled an {@link OperationCanceledException} is thrown
- * @param monitor
- * @param ticks
- * @throws OperationCanceledException
+ * @param monitor the {@link IProgressMonitor}
+ * @param ticks the amount of work to advance the monitor
+ * @throws OperationCanceledException if the user cancels the operation
*/
private void updateMonitor(IProgressMonitor monitor, int ticks) throws OperationCanceledException {
if(monitor != null) {
@@ -642,6 +644,7 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen
/**
* Returns whether change notification should be
* suppressed
+ * @return if changes notification should be suppressed
*/
protected boolean suppressChangeNotification() {
return fSuppressChange;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java
index 29174c1fc..37858a6c2 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -741,6 +741,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* method preserves mixed-case keys using the variable names
* recorded by the OS.
* </p>
+ * @param cache the map
* @since 3.1
*/
private void cacheNativeEnvironment(Map cache) {
@@ -892,6 +893,9 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
/**
* Return an instance of DebugException containing the specified message and Throwable.
+ * @param message the message for the new {@link DebugException}
+ * @param throwable the underlying {@link Exception}
+ * @return the new {@link DebugException}
*/
protected DebugException createDebugException(String message, Throwable throwable) {
return new DebugException(
@@ -907,6 +911,13 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* the specified stream. Simply pass out any exceptions encountered so that
* caller can deal with them. This is important since caller may need access to the
* actual exception.
+ *
+ * @param stream the {@link InputStream} to read from
+ * @return the new {@link LaunchConfigurationInfo}
+ * @throws CoreException if a problem is encountered
+ * @throws ParserConfigurationException if the stream fails to parse
+ * @throws IOException if there is a problem handling the given stream or writing the new info file
+ * @throws SAXException if there is a SAX parse exception
*/
protected LaunchConfigurationInfo createInfoFromXML(InputStream stream) throws CoreException,
ParserConfigurationException,
@@ -926,8 +937,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* container (and sub-containers)
*
* @param container the container to search
- * @exception CoreException an exception occurs traversing
- * the container.
* @return all launch configurations in the given container
*/
protected List findLaunchConfigurations(IContainer container) {
@@ -1100,6 +1109,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* Return a sorted array of the names of all <code>ILaunchConfiguration</code>s in
* the workspace. These are cached, and cache is cleared when a new config is added,
* deleted or changed.
+ * @return the sorted array of {@link ILaunchConfiguration} names
*/
protected synchronized String[] getAllSortedConfigNames() {
if (fSortedConfigNames == null) {
@@ -1127,6 +1137,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
/**
* Returns comparators, loading if required
+ * @return the complete map of {@link ILaunchConfiguration} {@link Comparator}s
*/
protected Map getComparators() {
initializeComparators();
@@ -1139,7 +1150,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
*
* @param root XML document
* @return list of launch configurations
- * @exception IOException if an exception occurs reading the XML
+ * @throws CoreException if a problem is encountered
*/
protected List getConfigsFromXML(Element root) throws CoreException {
DebugException invalidFormat =
@@ -1305,6 +1316,8 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* Returns the info object for the specified launch configuration.
* If the configuration exists, but is not yet in the cache,
* an info object is built and added to the cache.
+ * @param config the {@link ILaunchConfiguration} to get the info object from
+ * @return the {@link LaunchConfigurationInfo} object from the given {@link ILaunchConfiguration}
*
* @exception CoreException if an exception occurs building
* the info object
@@ -1887,10 +1900,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
/**
* Load comparator extensions.
- *
- * @exception CoreException if an exception occurs reading
- * the extensions
- *
*/
private synchronized void initializeLaunchModes() {
if (fLaunchModes == null) {
@@ -1934,9 +1943,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
/**
* Register source locators.
- *
- * @exception CoreException if an exception occurs reading
- * the extensions
*/
private synchronized void initializeSourceLocators() {
if (fSourceLocators == null) {
@@ -2010,6 +2016,8 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
/**
* Returns whether the given String is composed solely of digits
+ * @param string the {@link String} to check
+ * @return <code>true</code> if the given {@link String} is a number <code>false</code> otherwise
*/
private boolean isNumber(String string) {
int numChars= string.length();
@@ -2161,7 +2169,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* launch configurations from the cached index.
*
* @param project the project that has been closed
- * @exception CoreException if writing the index fails
*/
protected void projectClosed(IProject project) {
List configs = getLaunchConfigurations(project);
@@ -2180,7 +2187,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
* configs in the project to the index of all configs.
*
* @param project the project that has been opened
- * @exception CoreException if reading the index fails
*/
protected void projectOpened(IProject project) {
List configs = findLaunchConfigurations(project);
@@ -2417,6 +2423,9 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
/**
* Throws a debug exception with the given throwable that occurred
* while processing the given configuration.
+ * @param config the {@link ILaunchConfiguration} causing the exception
+ * @param e the {@link Exception} to throw
+ * @throws DebugException the new {@link DebugException} wrapping the given {@link Exception} and {@link ILaunchConfiguration}
* @since 3.5
*/
private void throwException(LaunchConfiguration config, Throwable e) throws DebugException {
@@ -2592,7 +2601,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe
*
* @param in the file to copy
* @param out the file to be copied out to
- * @throws IOException
+ * @throws IOException if the file read fails
* @since 3.4.0
*/
private void copyFile(File in, File out) throws IOException {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java
index 48a25f627..d596460ca 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004, 2007 IBM Corporation and others.
+ * Copyright (c) 2004, 2011 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
@@ -50,6 +50,7 @@ public class LaunchMode implements ILaunchMode {
/**
* Verifies the given attribute exists
+ * @param name the attribute name to check
*
* @exception CoreException if attribute does not exist
*/
@@ -63,7 +64,7 @@ public class LaunchMode implements ILaunchMode {
* This method is used to create a new internal error describing that the specified attribute
* is missing
* @param attrName the name of the attribute that is missing
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
private void missingAttribute(String attrName) throws CoreException {
throw new CoreException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, MessageFormat.format(DebugCoreMessages.LaunchMode_1,new String[]{attrName}), null));
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java
index 5c5c02931..abe87bd1c 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2009 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -204,9 +204,9 @@ public class LogicalStructureManager {
/**
*
- * @param types
+ * @param types the array of types
* @param selected the type that is selected for the given combo or <code>null</code>
- * if the user has deselected any structure for the given combo
+ * if the user has de-selected any structure for the given combo
*/
public void setEnabledType(ILogicalStructureType[] types, ILogicalStructureType selected) {
String combo= getComboString(types);
@@ -223,8 +223,8 @@ public class LogicalStructureManager {
/**
* Returns the string representing the given combination of logical
* structure types. This string will be a series of comma-separated
- * indeces representing the various types. If any of the given types
- * don't have indeces associated with them, this method will create
+ * indices representing the various types. If any of the given types
+ * don't have indices associated with them, this method will create
* the appropriate index.
* @param types the logical structure types
* @return the string representing the given combination of logical
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java
index 6aea4bea8..b478b3107 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -60,6 +60,7 @@ public class LogicalStructureProvider {
/**
* Return the ILogicalStructureProvider for this extension.
+ * @return the {@link ILogicalStructureProvider}
*/
protected ILogicalStructureProvider getDelegate() {
if (fDelegate == null) {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java
index 95633f5a6..029a15c85 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -60,6 +60,7 @@ public class LogicalStructureType implements ILogicalStructureType {
/**
* Verifies the given attribute exists
+ * @param name the name to verify
*
* @exception CoreException if attribute does not exist
*/
@@ -72,7 +73,7 @@ public class LogicalStructureType implements ILogicalStructureType {
/**
* Throws a new <code>CoreException</code> about the specified attribute being missing
* @param attrName the name of the missing attribute
- * @throws CoreException
+ * @throws CoreException if a problem is encountered
*/
private void missingAttribute(String attrName) throws CoreException {
throw new CoreException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, MessageFormat.format(DebugCoreMessages.LogicalStructureType_1, new String[]{attrName}), null));
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java
index 25a381d84..a42f94845 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2004, 2007 IBM Corporation and others.
+ * Copyright (c) 2004, 2011 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
@@ -250,8 +250,8 @@ public class MemoryBlockManager implements IMemoryBlockManager, IDebugEventSetLi
/**
* Notifies the listeners about the given memory blocks and the event to be sent
- * @param memBlocks
- * @param event
+ * @param memBlocks the array of memory blocks
+ * @param event the event to notify to the blocks
*/
private void notifyListeners(IMemoryBlock[] memBlocks, int event) {
getMemoryBlockNotifier().notify(memBlocks, event);
@@ -268,7 +268,7 @@ public class MemoryBlockManager implements IMemoryBlockManager, IDebugEventSetLi
/**
* Handles a debug event
- * @param event
+ * @param event the {@link DebugEvent}
*/
public void handleDebugEvent(DebugEvent event) {
Object obj = event.getSource();
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java
index c5fa6dae0..7dd37305c 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -111,6 +111,7 @@ public class OutputStreamMonitor implements IFlushableStreamMonitor {
/**
* Notifies the listeners that text has
* been appended to the stream.
+ * @param text the text that was appended to the stream
*/
private void fireStreamAppended(String text) {
getNotifier().notifyAppend(text);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java
index 5fc5fd99b..e79766c83 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java
@@ -42,10 +42,10 @@ public final class Preferences {
/**
* Sets a string preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to set the value in
*/
public static synchronized void setString(String qualifier, String key, String value, IScopeContext context) {
if(context != null) {
@@ -66,10 +66,10 @@ public final class Preferences {
/**
* Sets a boolean preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to set the value in
*/
public static synchronized void setBoolean(String qualifier, String key, boolean value, IScopeContext context) {
if(context != null) {
@@ -90,10 +90,10 @@ public final class Preferences {
/**
* Sets a integer preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to set the value in
*/
public static synchronized void setInt(String qualifier, String key, int value, IScopeContext context) {
if(context != null) {
@@ -114,10 +114,10 @@ public final class Preferences {
/**
* Sets a long preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to set the value in
*/
public static synchronized void setLong(String qualifier, String key, long value, IScopeContext context) {
if(context != null) {
@@ -138,10 +138,10 @@ public final class Preferences {
/**
* Sets a byte array preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to set the value in
*/
public static synchronized void setByteArray(String qualifier, String key, byte[] value, IScopeContext context) {
if(context != null) {
@@ -162,10 +162,10 @@ public final class Preferences {
/**
* Sets a double preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to set the value in
*/
public static synchronized void setDouble(String qualifier, String key, double value, IScopeContext context) {
if(context != null) {
@@ -186,10 +186,10 @@ public final class Preferences {
/**
* Sets a float preference in the {@link InstanceScope} or the given {@link IScopeContext} if it
* is not <code>null</code>. Preferences set in a given context are flushed as they are set.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the value
- * @param context
+ * @param context the context to setthe value in
*/
public static synchronized void setFloat(String qualifier, String key, float value, IScopeContext context) {
if(context != null) {
@@ -209,7 +209,7 @@ public final class Preferences {
/**
* Sets a string in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -219,7 +219,7 @@ public final class Preferences {
/**
* Sets a boolean in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -229,7 +229,7 @@ public final class Preferences {
/**
* Sets a byte array in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -239,7 +239,7 @@ public final class Preferences {
/**
* Sets a double in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -249,7 +249,7 @@ public final class Preferences {
/**
* Sets a float in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -259,7 +259,7 @@ public final class Preferences {
/**
* Sets a integer in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -269,7 +269,7 @@ public final class Preferences {
/**
* Sets a long in the {@link DefaultScope}
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key
* @param value the new value
*/
@@ -280,7 +280,7 @@ public final class Preferences {
/**
* Sets the given preference to its default value. This is done by removing any set value
* from the {@link InstanceScope}. Has no effect if the given key is <code>null</code>.
- * @param qualifier
+ * @param qualifier the preference qualifier
* @param key the key for the preference
*/
public static synchronized void setToDefault(String qualifier, String key) {
@@ -292,9 +292,9 @@ public final class Preferences {
/**
* Returns the default boolean value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the boolean value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -305,9 +305,9 @@ public final class Preferences {
/**
* Returns the default string value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the string value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -318,9 +318,9 @@ public final class Preferences {
/**
* Returns the default byte array value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the byte array value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -331,9 +331,9 @@ public final class Preferences {
/**
* Returns the default integer value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the integer value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -344,9 +344,9 @@ public final class Preferences {
/**
* Returns the default long value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the long value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -357,9 +357,9 @@ public final class Preferences {
/**
* Returns the default double value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the double value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -370,9 +370,9 @@ public final class Preferences {
/**
* Returns the default float value stored in the {@link DefaultScope} for the given key
* or the specified default value if the key does not appear in the {@link DefaultScope}
- * @param qualifier
- * @param key
- * @param defaultvalue
+ * @param qualifier the preference qualifier
+ * @param key the preference key
+ * @param defaultvalue the default value
*
* @return the float value set in the {@link DefaultScope} for the given key, or the specified default value.
*/
@@ -381,9 +381,9 @@ public final class Preferences {
}
/**
- * Save the preferences for the given plugin identifier.
+ * Save the preferences for the given plug-in identifier.
* It should be noted that all pending preference changes will be flushed with this method.
- * @param qualifier
+ * @param qualifier the preference qualifier
*/
public static synchronized void savePreferences(String qualifier) {
try {
@@ -397,8 +397,8 @@ public final class Preferences {
/**
* Adds the given preference listener to the {@link DefaultScope} and the {@link InstanceScope}
- * @param qualifier
- * @param listener
+ * @param qualifier the preference qualifier
+ * @param listener the listener to register
*/
public static void addPreferenceListener(String qualifier, IEclipsePreferences.IPreferenceChangeListener listener) {
contexts[DEFAULT_CONTEXT].getNode(qualifier).addPreferenceChangeListener(listener);
@@ -407,8 +407,8 @@ public final class Preferences {
/**
* Removes the given preference listener from the {@link DefaultScope} and the {@link InstanceScope}
- * @param qualifier
- * @param listener
+ * @param qualifier the preference qualifier
+ * @param listener the listener to register
*/
public static void removePreferenceListener(String qualifier, IEclipsePreferences.IPreferenceChangeListener listener) {
contexts[DEFAULT_CONTEXT].getNode(qualifier).removePreferenceChangeListener(listener);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java
index 8be2ba3b4..82fa104b4 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -136,7 +136,7 @@ public class WatchExpression implements IWatchExpression {
/**
* Fires the given debug event
- * @param event
+ * @param event the {@link DebugEvent}
*/
protected void fireEvent(DebugEvent event) {
DebugPlugin.getDefault().fireDebugEventSet(new DebugEvent[] {event});
@@ -146,8 +146,6 @@ public class WatchExpression implements IWatchExpression {
* Notifies the expression manager that this watch expression's
* values have changed so the manager can update the
* persisted expression.
- *
- * @param persist whether to persist the expression
*/
private void watchExpressionChanged() {
((ExpressionManager)DebugPlugin.getDefault().getExpressionManager()).watchExpressionChanged(this);
@@ -229,7 +227,9 @@ public class WatchExpression implements IWatchExpression {
}
/**
- * @param enabled
+ * Set the enabled state of the {@link WatchExpression}
+ *
+ * @param enabled the new enabled state
*/
public void setEnabled(boolean enabled) {
fEnabled= enabled;
@@ -238,7 +238,8 @@ public class WatchExpression implements IWatchExpression {
}
/**
- * @param expression
+ * Set the text of the expression
+ * @param expression the new expression text
*/
public void setExpressionText(String expression) {
fExpressionText= expression;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java
index 65081fd3a..f8c67a243 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -355,6 +355,7 @@ public final class XMLMemento {
/**
* Places the element's attributes into the document.
+ * @param element1 the element
* @param copyText true if the first text node should be copied
*/
private void putElement(Element element1, boolean copyText) {
@@ -416,8 +417,8 @@ public final class XMLMemento {
}
/**
- * @param key
- * @param value
+ * @param key the attribute key
+ * @param value the boolean value for the key
* @since 3.4
*/
public void putBoolean(String key, boolean value) {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java
index 935d11532..7bd6f4331 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -75,7 +75,7 @@ public class SourceContainerType implements ISourceContainerType {
/**
* Lazily instantiates and returns the underlying source container type.
- *
+ * @return the {@link ISourceContainerTypeDelegate}
* @exception CoreException if unable to instantiate
*/
private ISourceContainerTypeDelegate getDelegate() throws CoreException {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java
index 21bc87d27..fa06e2aaf 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 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
@@ -51,7 +51,7 @@ public class SourcePathComputer implements ISourcePathComputer {
/**
* Lazily instantiates and returns the underlying source container type.
- *
+ * @return the {@link ISourcePathComputerDelegate}
* @exception CoreException if unable to instantiate
*/
private ISourcePathComputerDelegate getDelegate() throws CoreException {
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java
index 91c9bc45b..710df3595 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java
@@ -105,7 +105,7 @@ public class ResourceResolver implements IDynamicVariableResolver {
*
* @param message exception message
* @param exception underlying exception or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if a problem occurs
*/
protected void abort(String message, Throwable exception) throws CoreException {
throw new CoreException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.INTERNAL_ERROR, message, exception));

Back to the top