diff options
85 files changed, 1271 insertions, 1049 deletions
diff --git a/org.eclipse.debug.core/META-INF/MANIFEST.MF b/org.eclipse.debug.core/META-INF/MANIFEST.MF index 8d8545d2a..8d3813a20 100644 --- a/org.eclipse.debug.core/META-INF/MANIFEST.MF +++ b/org.eclipse.debug.core/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.debug.core; singleton:=true -Bundle-Version: 3.7.1.qualifier +Bundle-Version: 3.7.100.qualifier Bundle-ClassPath: . Bundle-Activator: org.eclipse.debug.core.DebugPlugin Bundle-Vendor: %providerName diff --git a/org.eclipse.debug.tests/.settings/org.eclipse.jdt.core.prefs b/org.eclipse.debug.tests/.settings/org.eclipse.jdt.core.prefs index dddfa83b6..b3ec742b2 100644 --- a/org.eclipse.debug.tests/.settings/org.eclipse.jdt.core.prefs +++ b/org.eclipse.debug.tests/.settings/org.eclipse.jdt.core.prefs @@ -1,4 +1,4 @@ -#Thu May 05 15:12:47 CDT 2011 +#Wed Jul 06 14:26:17 CDT 2011 eclipse.preferences.version=1 org.eclipse.jdt.core.builder.cleanOutputFolder=clean org.eclipse.jdt.core.builder.duplicateResourceTask=warning @@ -22,10 +22,10 @@ org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning org.eclipse.jdt.core.compiler.problem.autoboxing=ignore org.eclipse.jdt.core.compiler.problem.comparingIdentical=warning org.eclipse.jdt.core.compiler.problem.deadCode=warning -org.eclipse.jdt.core.compiler.problem.deprecation=warning +org.eclipse.jdt.core.compiler.problem.deprecation=ignore org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled -org.eclipse.jdt.core.compiler.problem.discouragedReference=warning +org.eclipse.jdt.core.compiler.problem.discouragedReference=ignore org.eclipse.jdt.core.compiler.problem.emptyStatement=warning org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore @@ -35,6 +35,7 @@ org.eclipse.jdt.core.compiler.problem.finalParameterBound=ignore org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning org.eclipse.jdt.core.compiler.problem.forbiddenReference=ignore org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning +org.eclipse.jdt.core.compiler.problem.includeNullInfoFromAsserts=disabled org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=warning @@ -56,6 +57,7 @@ org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=dis org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore +org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning org.eclipse.jdt.core.compiler.problem.missingSynchronizedOnInheritedMethod=ignore org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning @@ -69,11 +71,15 @@ org.eclipse.jdt.core.compiler.problem.potentialNullReference=warning org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning org.eclipse.jdt.core.compiler.problem.redundantNullCheck=ignore org.eclipse.jdt.core.compiler.problem.redundantSuperinterface=ignore +org.eclipse.jdt.core.compiler.problem.reportMethodCanBePotentiallyStatic=ignore +org.eclipse.jdt.core.compiler.problem.reportMethodCanBeStatic=ignore org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning +org.eclipse.jdt.core.compiler.problem.suppressOptionalErrors=disabled org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning +org.eclipse.jdt.core.compiler.problem.unavoidableGenericTypeProblems=enabled org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning @@ -87,6 +93,7 @@ org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverridin org.eclipse.jdt.core.compiler.problem.unusedImport=error org.eclipse.jdt.core.compiler.problem.unusedLabel=warning org.eclipse.jdt.core.compiler.problem.unusedLocal=warning +org.eclipse.jdt.core.compiler.problem.unusedObjectAllocation=ignore org.eclipse.jdt.core.compiler.problem.unusedParameter=warning org.eclipse.jdt.core.compiler.problem.unusedParameterIncludeDocCommentReference=enabled org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled diff --git a/org.eclipse.debug.tests/META-INF/MANIFEST.MF b/org.eclipse.debug.tests/META-INF/MANIFEST.MF index 03ab9a44c..e4b5c9232 100644 --- a/org.eclipse.debug.tests/META-INF/MANIFEST.MF +++ b/org.eclipse.debug.tests/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.debug.tests;singleton:=true -Bundle-Version: 3.7.0.qualifier +Bundle-Version: 3.7.100.qualifier Bundle-Activator: org.eclipse.debug.tests.TestsPlugin Bundle-Localization: plugin Require-Bundle: org.eclipse.ui;bundle-version="[3.6.0,4.0.0)", diff --git a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/CheckTests.java b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/CheckTests.java index 51812ff00..4532a81d8 100644 --- a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/CheckTests.java +++ b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/CheckTests.java @@ -168,7 +168,7 @@ abstract public class CheckTests extends TestCase { fListener.reset(elementPath, element, -1, true, false); model.postDelta(delta); - while (!fListener.isFinished(TestModelUpdatesListener.LABEL_COMPLETE | TestModelUpdatesListener.MODEL_CHANGED_COMPLETE)) + while (!fListener.isFinished(ITestModelUpdatesListenerConstants.LABEL_COMPLETE | ITestModelUpdatesListenerConstants.MODEL_CHANGED_COMPLETE)) if (!fDisplay.readAndDispatch ()) Thread.sleep(0); model.validateData(fViewer, TreePath.EMPTY); } diff --git a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/JFaceViewerTopIndexTests.java b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/JFaceViewerTopIndexTests.java index 7ca0eceb1..668612860 100644 --- a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/JFaceViewerTopIndexTests.java +++ b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/JFaceViewerTopIndexTests.java @@ -81,9 +81,14 @@ public class JFaceViewerTopIndexTests extends TestCase implements ITestModelUpda } protected ITreeModelContentProviderTarget getCTargetViewer() { - return (ITreeModelContentProviderTarget)fViewer; + return fViewer; } + /** + * @param display the display + * @param shell the shell + * @return the new viewer + */ protected TreeModelViewer createViewer(Display display, Shell shell) { return new TreeModelViewer(fShell, SWT.VIRTUAL | SWT.MULTI, new PresentationContext("TestViewer")); } diff --git a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/SelectionTests.java b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/SelectionTests.java index e062ed719..3ebb062a0 100644 --- a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/SelectionTests.java +++ b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/SelectionTests.java @@ -212,7 +212,7 @@ abstract public class SelectionTests extends TestCase implements ITestModelUpdat // delta only wait for the delta to be processed. fListener.reset(); model.postDelta(delta); - while (!fListener.isFinished(TestModelUpdatesListener.MODEL_CHANGED_COMPLETE)) + while (!fListener.isFinished(ITestModelUpdatesListenerConstants.MODEL_CHANGED_COMPLETE)) if (!fDisplay.readAndDispatch ()) Thread.sleep(0); // Check to make sure the selection was made @@ -260,7 +260,7 @@ abstract public class SelectionTests extends TestCase implements ITestModelUpdat // Refresh the viewer model.postDelta( new ModelDelta(model.getRootElement(), IModelDelta.CONTENT) ); - while (!fListener.isFinished(TestModelUpdatesListener.ALL_UPDATES_COMPLETE)) + while (!fListener.isFinished(ITestModelUpdatesListenerConstants.ALL_UPDATES_COMPLETE)) if (!fDisplay.readAndDispatch ()) Thread.sleep(0); // Check to make sure the selection was made diff --git a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/TestModel.java b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/TestModel.java index d64f6bb0b..6647bd226 100644 --- a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/TestModel.java +++ b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/TestModel.java @@ -270,6 +270,12 @@ public class TestModel implements IElementContentProvider, IElementLabelProvider } + /** + * @param context the context + * @param viewerInput the input + * @param path the path + * @param checked the checked state + */ public void elementChecked(IPresentationContext context, Object viewerInput, TreePath path, boolean checked) { TestElement element = getElement(path); Assert.assertFalse(element.getGrayed()); diff --git a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/VirtualViewerLazyModeTests.java b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/VirtualViewerLazyModeTests.java index 300f76424..2eb78d354 100644 --- a/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/VirtualViewerLazyModeTests.java +++ b/org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/VirtualViewerLazyModeTests.java @@ -54,6 +54,11 @@ public class VirtualViewerLazyModeTests extends TestCase { fShell.open (); } + /** + * @param display the display + * @param shell the shell + * @return the viewer + */ protected ITreeModelViewer createViewer(Display display, Shell shell) { return new VirtualTreeModelViewer(display, SWT.VIRTUAL, new PresentationContext("TestViewer")); } diff --git a/org.eclipse.debug.ui/.settings/.api_filters b/org.eclipse.debug.ui/.settings/.api_filters new file mode 100644 index 000000000..42b56487b --- /dev/null +++ b/org.eclipse.debug.ui/.settings/.api_filters @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<component id="org.eclipse.debug.ui" version="2">
+ <resource path="ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationViewer.java" type="org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationViewer">
+ <filter comment="Known illegal extension" id="571473929">
+ <message_arguments>
+ <message_argument value="TreeViewer"/>
+ <message_argument value="LaunchConfigurationViewer"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/internal/ui/preferences/LaunchPerspectivePreferencePage.java" type="org.eclipse.debug.internal.ui.preferences.LaunchPerspectivePreferencePage$PerspectivesTreeViewer">
+ <filter comment="Known illegal extension" id="571473929">
+ <message_arguments>
+ <message_argument value="TreeViewer"/>
+ <message_argument value="PerspectivesTreeViewer"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/internal/ui/sourcelookup/SourceContainerViewer.java" type="org.eclipse.debug.internal.ui.sourcelookup.SourceContainerViewer">
+ <filter comment="Known illegal extension" id="571473929">
+ <message_arguments>
+ <message_argument value="TreeViewer"/>
+ <message_argument value="SourceContainerViewer"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ProjectSourceContainerDialog.java" type="org.eclipse.debug.internal.ui.sourcelookup.browsers.ProjectSourceContainerDialog">
+ <filter comment="Known illegal extension" id="571473929">
+ <message_arguments>
+ <message_argument value="ListSelectionDialog"/>
+ <message_argument value="ProjectSourceContainerDialog"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/internal/ui/viewers/model/InternalTreeModelViewer.java" type="org.eclipse.debug.internal.ui.viewers.model.InternalTreeModelViewer">
+ <filter comment="Known illegal extension" id="571473929">
+ <message_arguments>
+ <message_argument value="TreeViewer"/>
+ <message_argument value="InternalTreeModelViewer"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/internal/ui/viewers/model/TreeCursor.java" type="org.eclipse.debug.internal.ui.viewers.model.TreeCursor">
+ <filter comment="Known illegal reference" id="640708718">
+ <message_arguments>
+ <message_argument value="TypedListener(SWTEventListener)"/>
+ <message_argument value="TreeCursor"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsViewer.java" type="org.eclipse.debug.internal.ui.views.breakpoints.BreakpointsViewer">
+ <filter comment="Known illegal extension" id="571473929">
+ <message_arguments>
+ <message_argument value="CheckboxTreeViewer"/>
+ <message_argument value="BreakpointsViewer"/>
+ </message_arguments>
+ </filter>
+ </resource>
+ <resource path="ui/org/eclipse/debug/ui/actions/AbstractLaunchHistoryAction.java" type="org.eclipse.debug.ui.actions.AbstractLaunchHistoryAction">
+ <filter comment="Known leaked internal types" id="576725006">
+ <message_arguments>
+ <message_argument value="ILaunchHistoryChangedListener"/>
+ <message_argument value="AbstractLaunchHistoryAction"/>
+ </message_arguments>
+ </filter>
+ <filter comment="Known leaked internal types" id="643842064">
+ <message_arguments>
+ <message_argument value="LaunchHistory"/>
+ <message_argument value="AbstractLaunchHistoryAction"/>
+ <message_argument value="getLaunchHistory()"/>
+ </message_arguments>
+ </filter>
+ </resource>
+</component>
diff --git a/org.eclipse.debug.ui/META-INF/MANIFEST.MF b/org.eclipse.debug.ui/META-INF/MANIFEST.MF index b980672ed..86a32d2bc 100644 --- a/org.eclipse.debug.ui/META-INF/MANIFEST.MF +++ b/org.eclipse.debug.ui/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.debug.ui; singleton:=true -Bundle-Version: 3.7.100.qualifier +Bundle-Version: 3.7.200.qualifier Bundle-Activator: org.eclipse.debug.internal.ui.DebugUIPlugin Bundle-Vendor: %providerName Bundle-Localization: plugin @@ -28,7 +28,7 @@ Export-Package: org.eclipse.debug.internal.ui;x-friends:="org.eclipse.jdt.debug. org.eclipse.debug.internal.ui.launchConfigurations;x-internal:=true, org.eclipse.debug.internal.ui.memory;x-internal:=true, org.eclipse.debug.internal.ui.memory.provisional;x-internal:=true, - org.eclipse.debug.internal.ui.model.elements;x-internal:=true, + org.eclipse.debug.internal.ui.model.elements;x-friends:="org.eclipse.debug.examples.ui", org.eclipse.debug.internal.ui.preferences;x-internal:=true, org.eclipse.debug.internal.ui.sourcelookup;x-internal:=true, org.eclipse.debug.internal.ui.sourcelookup.browsers;x-internal:=true, @@ -43,7 +43,7 @@ Export-Package: org.eclipse.debug.internal.ui;x-friends:="org.eclipse.jdt.debug. org.eclipse.cdt.dsf.gdb.ui, org.eclipse.debug.tests", org.eclipse.debug.internal.ui.viewers.provisional;x-friends:="org.eclipse.debug.tests", - org.eclipse.debug.internal.ui.viewers.update;x-internal:=true, + org.eclipse.debug.internal.ui.viewers.update;x-friends:="org.eclipse.debug.examples.ui", org.eclipse.debug.internal.ui.views;x-internal:=true, org.eclipse.debug.internal.ui.views.breakpoints;x-internal:=true, org.eclipse.debug.internal.ui.views.console;x-internal:=true, diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugCheckboxSelectionDialog.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugCheckboxSelectionDialog.java index 27b7119ea..38f483cee 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugCheckboxSelectionDialog.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugCheckboxSelectionDialog.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2010 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 @@ -42,7 +42,7 @@ public abstract class AbstractDebugCheckboxSelectionDialog extends AbstractDebug /** * Constructor - * @param parentShell + * @param parentShell the parent shell */ public AbstractDebugCheckboxSelectionDialog(Shell parentShell) { super(parentShell); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugListSelectionDialog.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugListSelectionDialog.java index d9f641dd2..068772088 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugListSelectionDialog.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugListSelectionDialog.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007, 2009 IBM Corporation and others. + * Copyright (c) 2007, 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 @@ -35,7 +35,7 @@ public abstract class AbstractDebugListSelectionDialog extends AbstractDebugSele /** * Constructor - * @param parentShell + * @param parentShell the parent shell */ public AbstractDebugListSelectionDialog(Shell parentShell) { super(parentShell); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugSelectionDialog.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugSelectionDialog.java index cbf3d0870..e105846d1 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugSelectionDialog.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/AbstractDebugSelectionDialog.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 @@ -42,7 +42,7 @@ public abstract class AbstractDebugSelectionDialog extends SelectionDialog { /** * Constructor - * @param parentShell + * @param parentShell the parent shell */ public AbstractDebugSelectionDialog(Shell parentShell) { super(parentShell); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/DebugUIPlugin.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/DebugUIPlugin.java index f917bb3de..c0903ae72 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/DebugUIPlugin.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/DebugUIPlugin.java @@ -111,14 +111,13 @@ import com.ibm.icu.text.MessageFormat; /** * The Debug UI Plug-in. * - * Since 3.3 this plugin registers an <code>ISaveParticipant</code>, allowing this plugin to participate + * Since 3.3 this plug-in registers an <code>ISaveParticipant</code>, allowing this plug-in to participate * in workspace persistence life-cycles * * @see ISaveParticipant * @see ILaunchListener * @see LaunchConfigurationManager * @see PerspectiveManager - * @see ContextLaunch */ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { @@ -246,7 +245,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * If the debug flag is set the specified message is printed to the console - * @param message + * @param message the message to print the {@link System#out} */ public static void debug(String message) { if (DEBUG) { @@ -256,6 +255,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the singleton instance of the debug plug-in. + * @return the singleton {@link DebugUIPlugin} */ public static DebugUIPlugin getDefault() { if(fgDebugUIPlugin == null) { @@ -266,6 +266,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Convenience method which returns the unique identifier of this plug-in. + * @return the identifier of the plug-in */ public static String getUniqueIdentifier() { return IDebugUIConstants.PLUGIN_ID; @@ -340,6 +341,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the default label provider for the debug UI. + * @return the singleton {@link DefaultLabelProvider} */ public static ILabelProvider getDefaultLabelProvider() { if (fgDefaultLabelProvider == null) { @@ -356,6 +358,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { * @param element the config element defining the extension * @param classAttribute the name of the attribute carrying the class * @return the extension object + * @throws CoreException if an exception occurs */ public static Object createExtension(final IConfigurationElement element, final String classAttribute) throws CoreException { // If plug-n has been loaded create extension. @@ -448,7 +451,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Add the specified <code>ISaveParticipant</code> to the current listing of * registered participants - * @param participant + * @param participant the save participant to add * @return true if this current listing did not already contain the specified participant * @since 3.3 */ @@ -459,7 +462,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Removes the specified <code>ISaveParticipant</code> from the current listing of registered * participants - * @param participant + * @param participant the save participant to remove * @return true if the set contained the specified element * * @since 3.3 @@ -468,8 +471,8 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { return fSaveParticipants.remove(participant); } - /** - * @see AbstractUIPlugin#startup() + /* (non-Javadoc) + * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext) */ public void start(BundleContext context) throws Exception { super.start(context); @@ -551,6 +554,10 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Utility method with conventions + * @param shell the shell to open the dialog on + * @param title the title of the dialog + * @param message the message to display in the dialog + * @param s the underlying {@link IStatus} to display */ public static void errorDialog(Shell shell, String title, String message, IStatus s) { // if the 'message' resource string and the IStatus' message are the same, @@ -563,6 +570,10 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Utility method with conventions + * @param shell the shell to open the dialog on + * @param title the title for the dialog + * @param message the message to display in the dialog + * @param t the underlying exception for the dialog */ public static void errorDialog(Shell shell, String title, String message, Throwable t) { IStatus status; @@ -690,11 +701,10 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { * Opens the {@link LaunchConfigurationsDialog} on the given selection for the given group. A status * can be provided or <code>null</code> and the dialog can initialize the given {@link ILaunchConfiguration} * to its defaults when opening as well - as long as the specified configuration is an {@link ILaunchConfigurationWorkingCopy}. - * @param shell - * @param selection - * @param groupIdentifier - * @param status - * @param setDefaults + * @param shell the shell to open the dialog on + * @param selection the non-null selection to show when the dialog opens + * @param groupIdentifier the identifier of the launch group to open the dialog on + * @param setDefaults if the default values should be set on the opened configuration - if there is one * @return the return code from the dialog.open() call * @since 3.6 */ @@ -713,6 +723,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Save all dirty editors in the workbench. * Returns whether the operation succeeded. + * @param confirm if the user should be asked before saving * * @return whether all saving was completed * @deprecated Saving has been moved to the launch delegate <code>LaunchConfigurationDelegate</code> to allow for scoped saving @@ -728,6 +739,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Save & build the workspace according to the user-specified preferences. Return <code>false</code> if * any problems were encountered, <code>true</code> otherwise. + * @return <code>false</code> if any problems were encountered, <code>true</code> otherwise. * * @deprecated this method is no longer to be used. It is an artifact from 2.0, and all saving is now done with the * launch delegate <code>LaunchConfigurationDelegate</code> @@ -778,7 +790,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the workbench's display. - * + * @return the standard display */ public static Display getStandardDisplay() { return PlatformUI.getWorkbench().getDisplay(); @@ -791,6 +803,8 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { * <li>CONSOLE_SYS_ERR_RGB</li> * <li>CONSOLE_SYS_IN_RGB</li> * <li>CHANGED_VARIABLE_RGB</li> + * @param type the name of the type to ask for + * @return the {@link Color} */ public static Color getPreferenceColor(String type) { return ColorManager.getDefault().getColor(PreferenceConverter.getColor(getDefault().getPreferenceStore(), type)); @@ -852,7 +866,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the perspective manager. * - * @return + * @return the singleton {@link PerspectiveManager} */ public PerspectiveManager getPerspectiveManager() { return fPerspectiveManager; @@ -1171,6 +1185,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the label with any accelerators removed. + * @param label the label to remove accelerators from * * @return label without accelerators */ @@ -1200,6 +1215,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the label with any DBCS accelerator moved to the end of the string. * See bug 186921. + * @param label the label to be adjusted * * @return label with moved accelerator */ @@ -1229,6 +1245,7 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { /** * Returns the image descriptor registry used for this plug-in. + * @return the singleton {@link ImageDescriptorRegistry} * * @since 3.1 */ @@ -1243,8 +1260,8 @@ public class DebugUIPlugin extends AbstractUIPlugin implements ILaunchListener { * Returns an image descriptor for the icon referenced by the given attribute * and configuration element, or <code>null</code> if none. * - * @param element - * @param attr + * @param element the configuration element + * @param attr the name of the attribute * @return image descriptor or <code>null</code> */ public static ImageDescriptor getImageDescriptor(IConfigurationElement element, String attr) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java index a9ff6c2ce..1e4de1297 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.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 @@ -33,8 +33,8 @@ import org.eclipse.ui.IWorkbenchWindow; * This class is an abstract implementation of common features for a debug <code>IViewActionDelegate</code> * * This class is intended to be extended by clients - * @see {@link IViewActionDelegate} - * @see {@link IActionDelegate2} + * @see IViewActionDelegate + * @see IActionDelegate2 */ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate, IActionDelegate2 { @@ -87,6 +87,7 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate /** * Runs this action in the UI thread. + * @param selection the current selection */ private void runInForeground(final IStructuredSelection selection) { final MultiStatus status= @@ -172,6 +173,8 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate /** * Performs the specific action on this element. + * @param element the element context to perform the action on + * @throws DebugException if an exception occurs */ protected abstract void doAction(Object element) throws DebugException; @@ -180,6 +183,7 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate * a failed action. This message appears as the "Message:" in * the error dialog for this action. * Default is to return null. + * @return the message to be displayed in the an error dialog */ protected String getErrorDialogMessage(){ return null; @@ -189,6 +193,7 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate * a failed action. This message appears as the "Reason:" * in the error dialog for this action. * Default is to return the empty String. + * @return the message to be displayed as a status */ protected String getStatusMessage(){ return IInternalDebugCoreConstants.EMPTY_STRING; @@ -218,6 +223,7 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate * have the initial enabled state set with a call to update(IAction, ISelection). * * @param action the presentation for this action + * @param selection the current selection - workbench or text * @return whether the action was initialized */ protected boolean initialize(IAction action, ISelection selection) { @@ -242,7 +248,7 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate /** * Sets the most recent selection * - * @parm selection structured selection + * @param selection structured selection */ private void setSelection(IStructuredSelection selection) { fSelection = selection; @@ -282,6 +288,8 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate /** * Return whether the action should be enabled or not based on the given selection. + * @param selection the selection + * @return if the action should be enabled or not */ protected boolean getEnableStateForSelection(IStructuredSelection selection) { if (selection.size() == 0) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java index f804e9b18..b553c9ab9 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.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 @@ -18,9 +18,9 @@ import org.eclipse.ui.IViewPart; * Base implementation of the 'remove' action for a debug view * * This class is intended to be extended by clients - * @see {@link AbstractSelectionActionDelegate} - * @see {@link org.eclipse.ui.IViewActionDelegate} - * @see {@link org.eclipse.ui.IActionDelegate2} + * @see AbstractSelectionActionDelegate + * @see org.eclipse.ui.IViewActionDelegate + * @see org.eclipse.ui.IActionDelegate2 * */ public abstract class AbstractRemoveActionDelegate extends AbstractSelectionActionDelegate { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java index 62f80191e..67b9f5250 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.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 @@ -24,9 +24,9 @@ import org.eclipse.ui.IWorkbenchWindowActionDelegate; * This class is a base implementation of a 'remove all' debug action * * This class is intended to be extended by clients - * @see {@link IViewActionDelegate} - * @see {@link IActionDelegate2}} - * @see {@link IWorkbenchWindowActionDelegate} + * @see IViewActionDelegate + * @see IActionDelegate2 + * @see IWorkbenchWindowActionDelegate */ public abstract class AbstractRemoveAllActionDelegate implements IViewActionDelegate, IActionDelegate2, IWorkbenchWindowActionDelegate { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java index e77dca8c8..5008a7331 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.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 @@ -31,8 +31,8 @@ import org.eclipse.ui.progress.IWorkbenchSiteProgressService; * * This class is intended to be extended by clients * - * @see {@link IViewActionDelegate} - * @see {@link IActionDelegate2} + * @see IViewActionDelegate + * @see IActionDelegate2 * */ public abstract class AbstractSelectionActionDelegate implements IViewActionDelegate, IActionDelegate2 { @@ -142,7 +142,7 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele /** * Sets the most recent selection * - * @parm selection structured selection + * @param context structured selection */ private void setSelection(IStructuredSelection context) { fSelection = context; @@ -175,6 +175,7 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele /** * Return whether the action should be enabled or not based on the given * selection. + * @param selection the current selection * * @return true if the action should be enabled for the specified selection context * false otherwise @@ -220,7 +221,7 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele /** * Schedules the given job with this action's progress service * - * @param job + * @param job the {@link Job} to schedule */ protected void schedule(Job job) { if (fProgressService == null) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java index df87bd40d..b1378b869 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.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 @@ -19,6 +19,7 @@ import org.eclipse.core.runtime.IAdaptable; import org.eclipse.debug.core.ILaunch; import org.eclipse.debug.core.ILaunchConfiguration; import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy; +import org.eclipse.debug.core.ILaunchMode; import org.eclipse.debug.core.model.IDebugElement; import org.eclipse.debug.core.model.IProcess; import org.eclipse.debug.internal.core.IInternalDebugCoreConstants; @@ -137,7 +138,7 @@ public class AddToFavoritesAction extends SelectionListenerAction { /** * Returns the mode this action applies to - * @return + * @return the {@link ILaunchMode} this action applies to */ protected String getMode() { return fMode; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/BreakpointWorkingSetAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/BreakpointWorkingSetAction.java index 1ed2fff7b..fc6baaa51 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/BreakpointWorkingSetAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/BreakpointWorkingSetAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 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 @@ -20,7 +20,6 @@ import org.eclipse.ui.IViewPart; /** * An action which clears (sets the null) the default breakpoint group. - * @see org.eclipse.debug.core.IBreakpointManager#setAutoGroup(String) */ public abstract class BreakpointWorkingSetAction extends AbstractBreakpointsViewAction implements IPropertyChangeListener { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/ClearDefaultBreakpointGroupAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/ClearDefaultBreakpointGroupAction.java index f6d50a804..70446b413 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/ClearDefaultBreakpointGroupAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/breakpointGroups/ClearDefaultBreakpointGroupAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 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 @@ -15,7 +15,6 @@ import org.eclipse.jface.action.IAction; /** * An action which clears (sets the null) the default breakpoint group. - * @see org.eclipse.debug.core.IBreakpointManager#setAutoGroup(String) */ public class ClearDefaultBreakpointGroupAction extends BreakpointWorkingSetAction { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/variables/ChangeVariableValueAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/variables/ChangeVariableValueAction.java index 41841f3c9..4da195e81 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/variables/ChangeVariableValueAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/variables/ChangeVariableValueAction.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 @@ -38,7 +38,6 @@ import org.eclipse.ui.actions.SelectionProviderAction; * Action for changing the value of primitives and <code>String</code> variables. * This action will attempt to delegate the editing operation to a registered * variable value editor, if any is provided for the variable's debug model. - * @see org.eclipse.debug.ui.actions.VariableValueEditorManager */ public class ChangeVariableValueAction extends SelectionProviderAction { @@ -67,6 +66,7 @@ public class ChangeVariableValueAction extends SelectionProviderAction { * Indicates whether this action is applicable for the current selection. * If the element selected in the viewer is not a standard debug model * element this action is not applicable. + * @return if this action applies to the current selection */ public boolean isApplicable() { return isApplicable; @@ -74,6 +74,7 @@ public class ChangeVariableValueAction extends SelectionProviderAction { /** * Edit the variable value with an in-line text editor. + * @param variable run the action on the given variable */ protected void doActionPerformed(final IVariable variable) { Shell shell = fView.getViewSite().getShell(); @@ -153,6 +154,7 @@ public class ChangeVariableValueAction extends SelectionProviderAction { /** * Updates the enabled state of this action based * on the selection + * @param sel the selection to update */ protected void update(IStructuredSelection sel) { isApplicable = false; @@ -173,8 +175,8 @@ public class ChangeVariableValueAction extends SelectionProviderAction { setEnabled(false); } - /** - * @see IAction#run() + /* (non-Javadoc) + * @see org.eclipse.jface.action.Action#run() */ public void run() { Iterator iterator= getStructuredSelection().iterator(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/commands/actions/DebugCommandService.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/commands/actions/DebugCommandService.java index ba69bd29e..b65c50c15 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/commands/actions/DebugCommandService.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/commands/actions/DebugCommandService.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 @@ -60,7 +60,7 @@ public class DebugCommandService implements IDebugContextListener { /** * Returns the service for a window. * - * @param window + * @param window the window * @return service */ public synchronized static DebugCommandService getService(IWorkbenchWindow window) { @@ -106,8 +106,8 @@ public class DebugCommandService implements IDebugContextListener { /** * Updates the given command type after the next context change. * - * @param commandType - * @param monitor + * @param commandType the command class + * @param action the action to add to the update list */ public void postUpdateCommand(Class commandType, IEnabledTarget action) { synchronized (fCommandUpdates) { @@ -124,8 +124,8 @@ public class DebugCommandService implements IDebugContextListener { /** * Updates the given command type based on the active context. * - * @param commandType - * @param requestMonitor + * @param commandType the command class + * @param action the action to update */ public void updateCommand(Class commandType, IEnabledTarget action) { ISelection context = fContextService.getActiveContext(); @@ -167,10 +167,9 @@ public class DebugCommandService implements IDebugContextListener { /** * Updates the given command type for the specified elements. - * - * @param commandType command class to update + * @param handlerType the handle type class * @param elements elements to update for - * @param monitor status monitor + * @param actions the actions to update */ private void updateCommand(Class handlerType, Object[] elements, IEnabledTarget[] actions) { if (elements.length == 1) { @@ -205,10 +204,10 @@ public class DebugCommandService implements IDebugContextListener { /** * Updates the given command type for the specified elements. - * - * @param commandType command class to update + * @param handlerType the handler type class * @param elements elements to update for - * @param monitor status monitor + * @param participant the participant + * @return if the command stays enabled while the command executes */ public boolean executeCommand(Class handlerType, Object[] elements, ICommandParticipant participant) { if (elements.length == 1) { @@ -249,7 +248,8 @@ public class DebugCommandService implements IDebugContextListener { * Returns a map of command handlers to associated elements, or <code>null</code> if * one is missing. * - * @param elements + * @param elements the elements + * @param handlerType the handler type class * @return map of command handlers to associated elements or <code>null</code> */ private Map collate(Object[] elements, Class handlerType) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/contextlaunching/ContextRunner.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/contextlaunching/ContextRunner.java index 820f6bdf0..7576cf287 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/contextlaunching/ContextRunner.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/contextlaunching/ContextRunner.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007, 2009 IBM Corporation and others. + * Copyright (c) 2007, 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 @@ -74,7 +74,7 @@ public final class ContextRunner { /** * Performs the context launching given the object context and the mode to launch in. - * @param group + * @param group the launch group to launch using */ public void launch(ILaunchGroup group) { IStructuredSelection selection = SelectedResourceManager.getDefault().getCurrentSelection(); @@ -105,8 +105,9 @@ public final class ContextRunner { * Prompts the user to select a way of launching the current resource, where a 'way' * is defined as a launch shortcut. * - * @param resource - * @param group + * @param resource the resource context + * @param group the launch group to launch with + * @param selection the current selection */ protected void selectAndLaunch(IResource resource, ILaunchGroup group, IStructuredSelection selection) { if(group != null) { @@ -274,7 +275,9 @@ public final class ContextRunner { * launch using that shortcut. * * @param resource the resource context + * @param shortcuts the list of applicable shortcuts * @param mode the mode + * @param selection the current selection */ protected void showShortcutSelectionDialog(IResource resource, List shortcuts, String mode, IStructuredSelection selection) { LaunchShortcutSelectionDialog dialog = new LaunchShortcutSelectionDialog(shortcuts, resource, mode); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/AbstractLaunchConfigurationAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/AbstractLaunchConfigurationAction.java index 2d0606fb7..61dee1659 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/AbstractLaunchConfigurationAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/AbstractLaunchConfigurationAction.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 @@ -53,7 +53,9 @@ public abstract class AbstractLaunchConfigurationAction extends SelectionListene /** * Constructor for AbstractLaunchConfigurationAction. - * @param text + * @param text the action label + * @param viewer the viewer the action belongs to + * @param mode the mode the action applies to */ public AbstractLaunchConfigurationAction(String text, Viewer viewer, String mode) { super(text); @@ -109,7 +111,7 @@ public abstract class AbstractLaunchConfigurationAction extends SelectionListene /** * Sets this action's confirmation requestor. * - * @param confirmationRequestor + * @param confirmationRequestor the new {@link IConfirmationRequestor} */ public void setConfirmationRequestor(IConfirmationRequestor confirmationRequestor) { fConfirmationRequestor = confirmationRequestor; @@ -125,7 +127,7 @@ public abstract class AbstractLaunchConfigurationAction extends SelectionListene /** * Show an error dialog on the given exception. * - * @param exception + * @param exception the exception to show in the dialog */ protected void errorDialog(CoreException exception) { ErrorDialog.openError(getShell(), null, null, exception.getStatus()); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/CreateLaunchConfigurationAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/CreateLaunchConfigurationAction.java index e90b7dc00..f274f056d 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/CreateLaunchConfigurationAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/CreateLaunchConfigurationAction.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 @@ -38,6 +38,8 @@ public class CreateLaunchConfigurationAction extends AbstractLaunchConfiguration /** * Constructs an action to create a launch configuration + * @param viewer the viewer + * @param mode the mode the action applies to */ public CreateLaunchConfigurationAction(Viewer viewer, String mode) { super(LaunchConfigurationsMessages.CreateLaunchConfigurationAction_Ne_w_1, viewer, mode); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationManager.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationManager.java index f00f0e32f..5827ad5a9 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationManager.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/launchConfigurations/LaunchConfigurationManager.java @@ -30,7 +30,6 @@ import java.util.Set; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; -import javax.xml.transform.TransformerException; import org.eclipse.core.expressions.IEvaluationContext; import org.eclipse.core.resources.IContainer; @@ -212,11 +211,11 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns whether the given launch configuration should be visible in the - * debug ui. If the config is marked as private, or belongs to a different + * debug UI. If the config is marked as private, or belongs to a different * category (i.e. non-null), then this configuration should not be displayed - * in the debug ui. + * in the debug UI. * - * @param launchConfiguration + * @param launchConfiguration the configuration to check for the {@link IDebugUIConstants#ATTR_PRIVATE} attribute * @return boolean */ public static boolean isVisible(ILaunchConfiguration launchConfiguration) { @@ -259,8 +258,10 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns a listing of <code>IlaunchDeleagtes</code> that does not contain any delegates from disabled activities - * @param delegates the raw listing of delegates to filter + * @param type the type to get the delegates from + * @param modes the set of launch modes to get delegates for * @return the filtered listing of <code>ILaunchDelegate</code>s or an empty array, never <code>null</code>. + * @throws CoreException if an exception occurs * @since 3.3 */ public static ILaunchDelegate[] filterLaunchDelegates(ILaunchConfigurationType type, Set modes) throws CoreException { @@ -336,6 +337,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici * if none. This method does not include any filtering for the returned launch configuration. * * This method is exposed via DebugTools.getLastLaunch + * @param groupId the identifier of the {@link ILaunchGroup} to get the last launch from * * @return the last launch, or <code>null</code> if none */ @@ -368,6 +370,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Add the specified listener to the list of listeners that will be notified when the * launch history changes. + * @param listener the listener to add - adding a duplicate listener has no effect */ public void addLaunchHistoryListener(ILaunchHistoryChangedListener listener) { if (!fLaunchHistoryChangedListeners.contains(listener)) { @@ -378,6 +381,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Remove the specified listener from the list of listeners that will be notified when the * launch history changes. + * @param listener the listener to remove */ public void removeLaunchHistoryListener(ILaunchHistoryChangedListener listener) { fLaunchHistoryChangedListeners.remove(listener); @@ -398,10 +402,8 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns the history listing as XML * @return the history listing as XML - * @throws CoreException - * @throws ParserConfigurationException - * @throws TransformerException - * @throws IOException + * @throws CoreException if an exception occurs + * @throws ParserConfigurationException if there is a problem creating the XML for the launch history */ protected String getHistoryAsXML() throws CoreException, ParserConfigurationException { Document doc = DebugUIPlugin.getDocument(); @@ -430,9 +432,8 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici * Creates a new launch history element and adds it to the specified <code>Document</code> * @param doc the <code>Document</code> to add the new element to * @param historyRootElement the root element - * @param mode the modes the history element should apply to * @param configurations the configurations to create entries for - * @throws CoreException + * @throws CoreException is an exception occurs */ protected void createEntry(Document doc, Element historyRootElement, ILaunchConfiguration[] configurations) throws CoreException { for (int i = 0; i < configurations.length; i++) { @@ -456,6 +457,9 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Write out an XML file indicating the entries on the run & debug history lists and * the most recent launch. + * @throws IOException if writing the history file fails + * @throws CoreException is an exception occurs + * @throws ParserConfigurationException if there is a problem reading the XML */ protected void persistLaunchHistory() throws IOException, CoreException, ParserConfigurationException { synchronized (this) { @@ -617,6 +621,9 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Construct a launch configuration corresponding to the specified XML * element, and place it in the appropriate history. + * @param entry the XML entry to read from + * @param histories the array of histories to try and add the restored configurations to + * @param prepend if any restored items should be added to to top of the launch history */ private void createHistoryElement(Element entry, LaunchHistory[] histories, boolean prepend) { String memento = entry.getAttribute(IConfigurationElementConstants.MEMENTO); @@ -765,6 +772,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns an array of the <code>ILaunchConfiguration</code>s that apply to the specified <code>IResource</code> + * @param types the array of launch configuration type identifiers * @param resource the resource * @return an array of applicable <code>ILaunchConfiguration</code>s for the specified <code>IResource</code> or an empty * array if none, never <code>null</code> @@ -814,9 +822,9 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns if the specified configuration should be considered as a potential candidate - * @param config + * @param config to configuration * @return if the specified configuration should be considered as a potential candidate - * @throws CoreException + * @throws CoreException if an exception occurs */ private boolean acceptConfiguration(ILaunchConfiguration config) throws CoreException { if(config != null && !DebugUITools.isPrivate(config)) { @@ -835,6 +843,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns all launch shortcuts for the given category + * @param category the identifier of the category * * @return all launch shortcuts */ @@ -845,8 +854,8 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Return a list of filtered launch shortcuts, based on the given category. * - * @param unfiltered - * @param category + * @param unfiltered the raw list of shortcuts to filter + * @param category the category to filter by * @return List */ protected List filterShortcuts(List unfiltered, String category) { @@ -907,9 +916,9 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns the first occurrence of any one of the configurations in the provided list, if they are found in the launch history * for the corresponding launch group - * @param configurations - * @param mode - * @param resource + * @param configurations the raw list of configurations to examine + * @param group the launch group to get the launch history from + * @param resource the {@link IResource} context * @return the associated launch configuration from the MRU listing or <code>null</code> if there isn't one * @since 3.3 */ @@ -996,6 +1005,8 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns the image used to display an error in the given tab + * @param tab the tab to get the error image for + * @return the error image associated with the given tab */ public Image getErrorTabImage(ILaunchConfigurationTab tab) { if (fErrorImages == null) { @@ -1019,6 +1030,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Return the launch group with the given id, or <code>null</code> + * @param id the identifier of the {@link LaunchGroupExtension} * * @return the launch group with the given id, or <code>null</code> */ @@ -1044,7 +1056,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Return the launch history with the given group id, or <code>null</code> - * + * @param id the identifier of the launch history * @return the launch history with the given group id, or <code>null</code> */ public LaunchHistory getLaunchHistory(String id) { @@ -1084,7 +1096,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici /** * Returns the default launch group for the given mode. * - * @param mode + * @param mode the mode identifier * @return launch group */ public LaunchGroupExtension getDefaultLaunchGroup(String mode) { @@ -1155,6 +1167,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici * * @param type launch configuration type * @return launch configuration + * @throws CoreException if an excpetion occurs * @since 3.0 */ public static ILaunchConfiguration getSharedTypeConfig(ILaunchConfigurationType type) throws CoreException { @@ -1216,7 +1229,7 @@ public class LaunchConfigurationManager implements ILaunchListener, ISavePartici * Sets the given launch to be the most recent launch in the launch * history (for applicable histories). * <p> - * @param configuration configuration to be set as most recent + * @param launch the launch to prepend to its associated histories * @since 3.3 */ public void setRecentLaunch(ILaunch launch) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/memory/provisional/AbstractAsyncTableRendering.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/memory/provisional/AbstractAsyncTableRendering.java index cecec5685..2aea2b136 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/memory/provisional/AbstractAsyncTableRendering.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/memory/provisional/AbstractAsyncTableRendering.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2010 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 @@ -75,6 +75,7 @@ import org.eclipse.debug.ui.memory.IMemoryRenderingSite; import org.eclipse.debug.ui.memory.IMemoryRenderingSynchronizationService; import org.eclipse.debug.ui.memory.IMemoryRenderingType; import org.eclipse.debug.ui.memory.IResettableMemoryRendering; +import org.eclipse.debug.ui.memory.MemoryRenderingElement; import org.eclipse.jface.action.Action; import org.eclipse.jface.action.IMenuListener; import org.eclipse.jface.action.IMenuManager; @@ -581,7 +582,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende /** * Create the error page of this rendering - * @param parent + * @param parent the parent to add the page to */ private void createMessagePage(Composite parent) { @@ -596,7 +597,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende } /** - * @param parent + * @param parent the parent composite */ private void createTableViewer(final Composite parent) { @@ -1109,7 +1110,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende } /** - * + * @param pageSize the new page size */ private void handlePageSizeChanged(int pageSize) { fPageSize = pageSize; @@ -1175,7 +1176,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende } /** - * @param address + * @param address the changed address */ private void doTopVisibleAddressChanged(final BigInteger address) { if (fIsDisposed) @@ -1423,7 +1424,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende } /** - * @param modelId + * @param modelId the {@link String} model id * @return default number of addressable units per line for the model */ private int getDefaultRowSizeByModel(String modelId) @@ -1440,7 +1441,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende } /** - * @param modelId + * @param modelId the {@link String} model id * @return default number of addressable units per column for the model */ private int getDefaultColumnSizeByModel(String modelId) @@ -2591,7 +2592,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende /** * Handle column size changed event from synchronizer - * @param newColumnSize + * @param newColumnSize the new column size */ private void columnSizeChanged(final int newColumnSize) { // ignore event if rendering is not visible @@ -2631,6 +2632,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende /** * update selected address in synchronizer if update is true. + * @param address the address to update */ private void updateSyncSelectedAddress(BigInteger address) { @@ -2666,6 +2668,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende /** * update top visible address in synchronizer + * @param address the address to update */ private void updateSyncTopAddress(BigInteger address) { @@ -2860,7 +2863,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende * table item if SWT.FULL_SELECTION is not on when the table is created. * Created the following function to work around the problem. * We can remove this method when the bug is fixed. - * @param point + * @param point the given {@link Point} to find the {@link TableItem} for * @return the table item where the point is located, return null if the item cannot be located. */ private TableItem getItem(Point point) @@ -2884,7 +2887,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende /** * Method for figuring out which column the point is located. - * @param point + * @param point the {@link Point} the get the column number for * @return the column index where the point is located, return -1 if column is not found. */ private int getColumn(Point point) @@ -3047,7 +3050,7 @@ public abstract class AbstractAsyncTableRendering extends AbstractBaseTableRende } /** - * @param topVisibleAddress + * @param topVisibleAddress the address to get the description for */ private void createContentDescriptor(final BigInteger topVisibleAddress) { fContentDescriptor = new TableRenderingContentDescriptor(AbstractAsyncTableRendering.this); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointContainerLabelProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointContainerLabelProvider.java index 7d0ac7405..1bf8cfe5e 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointContainerLabelProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointContainerLabelProvider.java @@ -1,156 +1,155 @@ -/*****************************************************************
- * Copyright (c) 2009 Texas Instruments 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:
- * Patrick Chuong (Texas Instruments) - Initial API and implementation (Bug 238956)
- *****************************************************************/
-package org.eclipse.debug.internal.ui.model.elements;
-
-import org.eclipse.core.runtime.CoreException;
-import org.eclipse.core.runtime.IAdaptable;
-import org.eclipse.debug.core.DebugPlugin;
-import org.eclipse.debug.core.model.IBreakpoint;
-import org.eclipse.debug.internal.ui.CompositeDebugImageDescriptor;
-import org.eclipse.debug.internal.ui.DebugUIPlugin;
-import org.eclipse.debug.internal.ui.breakpoints.provisional.IBreakpointContainer;
-import org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext;
-import org.eclipse.jface.resource.ImageDescriptor;
-import org.eclipse.jface.viewers.TreePath;
-import org.eclipse.swt.graphics.FontData;
-import org.eclipse.swt.graphics.Image;
-import org.eclipse.swt.graphics.RGB;
-import org.eclipse.ui.model.IWorkbenchAdapter2;
-
-/**
- * Breakpoint container label provider.
- *
- * @since 3.6
- */
-public class BreakpointContainerLabelProvider extends DebugElementLabelProvider {
- /*
- * (non-Javadoc)
- * @see org.eclipse.debug.internal.ui.model.elements.DebugElementLabelProvider#getImageDescriptor(org.eclipse.jface.viewers.TreePath, org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext, java.lang.String)
- */
- protected ImageDescriptor getImageDescriptor(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException {
- ImageDescriptor desc = super.getImageDescriptor(elementPath, presentationContext, columnId);
- int flags = computeAdornmentFlags();
-
- if (flags > 0) {
- Image image = DebugUIPlugin.getImageDescriptorRegistry().get(desc);
- CompositeDebugImageDescriptor compDesc = new CompositeDebugImageDescriptor(image, flags);
- return compDesc;
- }
- return desc;
- }
-
- /*
- * (non-Javadoc)
- * @see org.eclipse.debug.internal.ui.model.elements.ElementLabelProvider#getChecked(org.eclipse.jface.viewers.TreePath, org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext)
- */
- public boolean getChecked(TreePath path, IPresentationContext presentationContext) throws CoreException {
- Object lastSegment = path.getLastSegment();
- if (lastSegment instanceof IBreakpointContainer) {
- IBreakpointContainer container = (IBreakpointContainer) lastSegment;
- IBreakpoint[] breakpoints = container.getBreakpoints();
- for (int i = 0; i < breakpoints.length; ++i) {
- if (breakpoints[i].isEnabled()) return true;
- }
-
- return false;
- }
-
- return super.getChecked(path, presentationContext);
- }
-
- /*
- * (non-Javadoc)
- * @see org.eclipse.debug.internal.ui.model.elements.ElementLabelProvider#getGrayed(org.eclipse.jface.viewers.TreePath, org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext)
- */
- public boolean getGrayed(TreePath path, IPresentationContext presentationContext) throws CoreException {
- Object lastSegment = path.getLastSegment();
- if (lastSegment instanceof IBreakpointContainer) {
- IBreakpointContainer container = (IBreakpointContainer) lastSegment;
- IBreakpoint[] breakpoints = container.getBreakpoints();
-
- // Return true, gray if some breakpoints are enabled and some are disabled.
- // return false if all breakpoints are either disabled or all are enabled.
- boolean hasEnabled = false;
- boolean hasDisabled = false;
-
- for (int i = 0; i < breakpoints.length; ++i) {
- if (breakpoints[i].isEnabled()) {
- hasEnabled = true;
- } else {
- hasDisabled = true;
- }
-
- if (hasEnabled && hasDisabled) {
- return true;
- }
- }
-
- return false;
- }
-
- return super.getGrayed(path, presentationContext);
- }
-
- // Forward font data requests to the workbench adapter
- protected FontData getFontData(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException {
- Object element = elementPath.getLastSegment();
- FontData fontData = super.getFontData(elementPath, presentationContext, columnId);
- if (fontData == null && element instanceof IAdaptable) {
-
- IWorkbenchAdapter2 adapter = (IWorkbenchAdapter2) ((IAdaptable)element).getAdapter(IWorkbenchAdapter2.class);
- if (adapter != null) {
- fontData = adapter.getFont(element);
- }
- }
- return fontData;
- }
-
- // Forward foreground color requests to the workbench adapter
- protected RGB getForeground(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException {
- Object element = elementPath.getLastSegment();
- RGB rgb = super.getForeground(elementPath, presentationContext, columnId);
- if (rgb == null && element instanceof IAdaptable) {
-
- IWorkbenchAdapter2 adapter = (IWorkbenchAdapter2) ((IAdaptable)element).getAdapter(IWorkbenchAdapter2.class);
- if (adapter != null) {
- rgb = adapter.getForeground(element);
- }
- }
- return rgb;
- }
-
- // Forward background color requests to the workbench adapter
- protected RGB getBackground(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException {
- Object element = elementPath.getLastSegment();
- RGB rgb = super.getBackground(elementPath, presentationContext, columnId);
- if (rgb == null && element instanceof IAdaptable) {
-
- IWorkbenchAdapter2 adapter = (IWorkbenchAdapter2) ((IAdaptable)element).getAdapter(IWorkbenchAdapter2.class);
- if (adapter != null) {
- rgb = adapter.getBackground(element);
- }
- }
- return rgb;
- }
-
- /**
- * Computes and return common adornment flags for the given category.
- *
- * @param element breakpoint category
- * @return adornment flags defined in CompositeDebugImageDescriptor
- */
- private int computeAdornmentFlags() {
- if (!DebugPlugin.getDefault().getBreakpointManager().isEnabled()) {
- return CompositeDebugImageDescriptor.SKIP_BREAKPOINT;
- }
- return 0;
- }
-}
+/***************************************************************** + * Copyright (c) 2009, 2011 Texas Instruments 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: + * Patrick Chuong (Texas Instruments) - Initial API and implementation (Bug 238956) + *****************************************************************/ +package org.eclipse.debug.internal.ui.model.elements; + +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IAdaptable; +import org.eclipse.debug.core.DebugPlugin; +import org.eclipse.debug.core.model.IBreakpoint; +import org.eclipse.debug.internal.ui.CompositeDebugImageDescriptor; +import org.eclipse.debug.internal.ui.DebugUIPlugin; +import org.eclipse.debug.internal.ui.breakpoints.provisional.IBreakpointContainer; +import org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext; +import org.eclipse.jface.resource.ImageDescriptor; +import org.eclipse.jface.viewers.TreePath; +import org.eclipse.swt.graphics.FontData; +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.graphics.RGB; +import org.eclipse.ui.model.IWorkbenchAdapter2; + +/** + * Breakpoint container label provider. + * + * @since 3.6 + */ +public class BreakpointContainerLabelProvider extends DebugElementLabelProvider { + /* + * (non-Javadoc) + * @see org.eclipse.debug.internal.ui.model.elements.DebugElementLabelProvider#getImageDescriptor(org.eclipse.jface.viewers.TreePath, org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext, java.lang.String) + */ + protected ImageDescriptor getImageDescriptor(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException { + ImageDescriptor desc = super.getImageDescriptor(elementPath, presentationContext, columnId); + int flags = computeAdornmentFlags(); + + if (flags > 0) { + Image image = DebugUIPlugin.getImageDescriptorRegistry().get(desc); + CompositeDebugImageDescriptor compDesc = new CompositeDebugImageDescriptor(image, flags); + return compDesc; + } + return desc; + } + + /* + * (non-Javadoc) + * @see org.eclipse.debug.internal.ui.model.elements.ElementLabelProvider#getChecked(org.eclipse.jface.viewers.TreePath, org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext) + */ + public boolean getChecked(TreePath path, IPresentationContext presentationContext) throws CoreException { + Object lastSegment = path.getLastSegment(); + if (lastSegment instanceof IBreakpointContainer) { + IBreakpointContainer container = (IBreakpointContainer) lastSegment; + IBreakpoint[] breakpoints = container.getBreakpoints(); + for (int i = 0; i < breakpoints.length; ++i) { + if (breakpoints[i].isEnabled()) return true; + } + + return false; + } + + return super.getChecked(path, presentationContext); + } + + /* + * (non-Javadoc) + * @see org.eclipse.debug.internal.ui.model.elements.ElementLabelProvider#getGrayed(org.eclipse.jface.viewers.TreePath, org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext) + */ + public boolean getGrayed(TreePath path, IPresentationContext presentationContext) throws CoreException { + Object lastSegment = path.getLastSegment(); + if (lastSegment instanceof IBreakpointContainer) { + IBreakpointContainer container = (IBreakpointContainer) lastSegment; + IBreakpoint[] breakpoints = container.getBreakpoints(); + + // Return true, gray if some breakpoints are enabled and some are disabled. + // return false if all breakpoints are either disabled or all are enabled. + boolean hasEnabled = false; + boolean hasDisabled = false; + + for (int i = 0; i < breakpoints.length; ++i) { + if (breakpoints[i].isEnabled()) { + hasEnabled = true; + } else { + hasDisabled = true; + } + + if (hasEnabled && hasDisabled) { + return true; + } + } + + return false; + } + + return super.getGrayed(path, presentationContext); + } + + // Forward font data requests to the workbench adapter + protected FontData getFontData(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException { + Object element = elementPath.getLastSegment(); + FontData fontData = super.getFontData(elementPath, presentationContext, columnId); + if (fontData == null && element instanceof IAdaptable) { + + IWorkbenchAdapter2 adapter = (IWorkbenchAdapter2) ((IAdaptable)element).getAdapter(IWorkbenchAdapter2.class); + if (adapter != null) { + fontData = adapter.getFont(element); + } + } + return fontData; + } + + // Forward foreground color requests to the workbench adapter + protected RGB getForeground(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException { + Object element = elementPath.getLastSegment(); + RGB rgb = super.getForeground(elementPath, presentationContext, columnId); + if (rgb == null && element instanceof IAdaptable) { + + IWorkbenchAdapter2 adapter = (IWorkbenchAdapter2) ((IAdaptable)element).getAdapter(IWorkbenchAdapter2.class); + if (adapter != null) { + rgb = adapter.getForeground(element); + } + } + return rgb; + } + + // Forward background color requests to the workbench adapter + protected RGB getBackground(TreePath elementPath, IPresentationContext presentationContext, String columnId) throws CoreException { + Object element = elementPath.getLastSegment(); + RGB rgb = super.getBackground(elementPath, presentationContext, columnId); + if (rgb == null && element instanceof IAdaptable) { + + IWorkbenchAdapter2 adapter = (IWorkbenchAdapter2) ((IAdaptable)element).getAdapter(IWorkbenchAdapter2.class); + if (adapter != null) { + rgb = adapter.getBackground(element); + } + } + return rgb; + } + + /** + * Computes and return common adornment flags for the given category. + * + * @return adornment flags defined in CompositeDebugImageDescriptor + */ + private int computeAdornmentFlags() { + if (!DebugPlugin.getDefault().getBreakpointManager().isEnabled()) { + return CompositeDebugImageDescriptor.SKIP_BREAKPOINT; + } + return 0; + } +} diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointManagerContentProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointManagerContentProvider.java index f4c4cb4cb..34970f20f 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointManagerContentProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/model/elements/BreakpointManagerContentProvider.java @@ -132,9 +132,6 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * Constructor * * @param input the breakpoint manager input - * @param proxy the model proxy - * @param filter the debug context selection - * @param comparator the element comparator */ InputData(DefaultBreakpointsViewInput input) { fInput = input; @@ -282,8 +279,7 @@ public class BreakpointManagerContentProvider extends ElementContentProvider /** * Handles the property changed events in presentation contexts. * Sub-classes may override to perform additional handling. - * - * @param presentation Presentation context that changed. + * @param event the event */ private void presentationPropertyChanged(PropertyChangeEvent event) { if (IPresentationContext.PROPERTY_DISPOSED.equals(event.getProperty())) { @@ -455,7 +451,6 @@ public class BreakpointManagerContentProvider extends ElementContentProvider /** * Helper method to add breakpoints to the given input. * - * @param data the input to add the breakpoints * @param breakpoints the breakpoints */ void breakpointsAdded(IBreakpoint[] breakpoints) { @@ -493,7 +488,6 @@ public class BreakpointManagerContentProvider extends ElementContentProvider /** * Helper method to remove breakpoints from a given input. * - * @param data the input to add the breakpoints * @param breakpoints the breakpoints */ void breakpointsRemoved(IBreakpoint[] breakpoints) { @@ -581,6 +575,7 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * @param container the existing container to insert the new elements. * @param refContainer the reference container to compare elements that are added. * @param containerDelta the delta of the existing container. + * @return the breakpoint that was inserted */ private IBreakpoint insertAddedElements(BreakpointContainer container, BreakpointContainer refContainer, ModelDelta containerDelta) { IBreakpoint newBreakpoint = null; @@ -652,8 +647,8 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * @param collection the collection of elements. * @param element the element to search. * @return if element exist in collection, than it is returned, otherwise <code>null</code> is returned. - * @see insertAddedElements - * @see deleteRemovedElements + * @see #insertAddedElements + * @see #deleteRemovedElements */ private Object getElement(Object[] collection, Object element) { for (int i = 0; i < collection.length; ++i) @@ -673,8 +668,8 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * @param rootDelta the root delta. * @param input the view input. * @param organizers the breakpoint organizers. - * @param oldContainer the old container, use to determine whether a new breakpoint should be expanded. - * @param the breakpoint manager. + * @param breakpoints the breakpoints to add to the container + * @return the new root container */ private BreakpointContainer createRootContainer( ModelDelta rootDelta, DefaultBreakpointsViewInput input, @@ -694,9 +689,8 @@ public class BreakpointManagerContentProvider extends ElementContentProvider /** * Fire model change event for the input. * - * @param input the input. * @param delta the model delta. - * @param debugReason the debug string. + * @param select if the viewer selection should change */ synchronized private void postModelChanged(final IModelDelta delta, boolean select) { for (int i = 0; fProxies != null && i < fProxies.size(); i++) { @@ -766,6 +760,7 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * Sub-classes may override this method to filter the breakpoints. * * @param input the breakpoint manager input. + * @param selectionFilter the selection to use as filter * @param breakpoints the list of breakpoint to filter. * @return the filtered list of breakpoint based on the input. */ @@ -892,9 +887,6 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * * @param input the breakpoint manager input to register. * @param proxy the model proxy of the input. - * @param organizers the breakpoint organizer, can be <code>null</code>. - * @param selectionFilter the selection filter, can be <code>null</code>. - * @param comparator the element comparator. */ public void registerModelProxy(DefaultBreakpointsViewInput input, BreakpointManagerProxy proxy) { synchronized(this) { @@ -913,6 +905,7 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * Unregister the breakpoint manager input with this content provider. * * @param input the breakpoint manager input to unregister. + * @param proxy the manager proxy */ public void unregisterModelProxy(DefaultBreakpointsViewInput input, BreakpointManagerProxy proxy) { InputData inputData = (InputData)fInputToData.get(input); @@ -950,6 +943,8 @@ public class BreakpointManagerContentProvider extends ElementContentProvider * Returns the selection filter for the input. * * @param input the selection. + * @param debugContext the current context + * @return the filtered selection or <code>null</code> */ protected IStructuredSelection getSelectionFilter(Object input, IStructuredSelection debugContext) { if (input instanceof DefaultBreakpointsViewInput) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/preferences/RunDebugPropertiesPage.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/preferences/RunDebugPropertiesPage.java index 1112114d1..5c0ebfc88 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/preferences/RunDebugPropertiesPage.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/preferences/RunDebugPropertiesPage.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007, 2008 IBM Corporation and others. + * Copyright (c) 2007, 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 @@ -35,6 +35,7 @@ import org.eclipse.debug.internal.ui.IDebugHelpContextIds; import org.eclipse.debug.internal.ui.SWTFactory; import org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationComparator; import org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationManager; +import org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationsDialog; import org.eclipse.debug.ui.ILaunchGroup; import org.eclipse.jface.dialogs.IDialogConstants; import org.eclipse.jface.viewers.ArrayContentProvider; @@ -65,10 +66,9 @@ import com.ibm.icu.text.MessageFormat; /** * Displays default launch configuration settings for a selected resource - associated launch configurations. * - * @see {@link PropertyPage} - * @see {@link ILaunchConfiguration} - * @see {@link org.eclipse.debug.internal.ui.launchConfigurations.LaunchConfigurationsDialog} - * @see {@link IDebugHelpContextIds#DEFAULT_LAUNCHCONFIGURATION_PROPERTY_PAGE} + * @see PropertyPage + * @see ILaunchConfiguration + * @see LaunchConfigurationsDialog * * CONTEXTLAUNCHING * @@ -425,7 +425,7 @@ public class RunDebugPropertiesPage extends PropertyPage { * Edits the given configuration as a nested working copy. * Returns the code from the dialog used to edit the configuration. * - * @param configuration + * @param configuration the configuration working copy to editor * @param setDefaults whether to set default values in the config * @return dialog return code - OK or CANCEL */ diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/AddSourceContainerDialog.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/AddSourceContainerDialog.java index 3075dbd16..9066819ed 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/AddSourceContainerDialog.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/AddSourceContainerDialog.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 @@ -57,6 +57,9 @@ public class AddSourceContainerDialog extends TitleAreaDialog { /** * Constructor + * @param shell the shell to open this dialog on + * @param viewer the view associated with this dialog + * @param director the backing director */ public AddSourceContainerDialog(Shell shell, SourceContainerViewer viewer, ISourceLookupDirector director) { super(shell); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/BasicContainerContentProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/BasicContainerContentProvider.java index b629d96cd..e7fd8079e 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/BasicContainerContentProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/BasicContainerContentProvider.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2003, 2005 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 @@ -37,8 +37,8 @@ public class BasicContainerContentProvider implements ITreeContentProvider { public void dispose() { } - /** - * @see ITreeContentProvider#getChildren + /* (non-Javadoc) + * @see org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang.Object) */ public Object[] getChildren(Object element) { if (element instanceof IWorkspaceRoot) { @@ -58,31 +58,28 @@ public class BasicContainerContentProvider implements ITreeContentProvider { return new Object[0]; } - /** - * @see ITreeContentProvider#getElements - */ public Object[] getElements(Object element) { return getChildren(element); } - /** - * @see ITreeContentProvider#getParent + /* (non-Javadoc) + * @see org.eclipse.jface.viewers.ITreeContentProvider#getParent(java.lang.Object) */ public Object getParent(Object element) { if (element instanceof IResource) return ((IResource) element).getParent(); return null; } - - /** - * @see ITreeContentProvider#hasChildren + + /* (non-Javadoc) + * @see org.eclipse.jface.viewers.ITreeContentProvider#hasChildren(java.lang.Object) */ public boolean hasChildren(Object element) { return getChildren(element).length > 0; } - /** - * @see IContentProvider#inputChanged + /* (non-Javadoc) + * @see org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object) */ public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveFilter.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveFilter.java index c5d55658c..427221356 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveFilter.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveFilter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 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 @@ -72,8 +72,9 @@ public class ArchiveFilter extends ViewerFilter { /** * Traverse the given container, adding archives to the given set. * Returns whether any files were added - * - * @param root + * @param container the container to check + * @param set the set to add any found archives to + * @return <code>true</code> if any archives have been added false otherwise */ private boolean traverse(IContainer container, Set set) { boolean added = false; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveSourceContainerBrowser.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveSourceContainerBrowser.java index 1b6ed903a..4ae4fc2a9 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveSourceContainerBrowser.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/sourcelookup/browsers/ArchiveSourceContainerBrowser.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 ArchiveSourceContainerBrowser extends AbstractSourceContainerBrowse * given source lookup director. * * @param director source lookup director jars are being added to + * @return the list of any found {@link ArchiveSourceContainer}s */ protected List getSelectedJars(ISourceLookupDirector director) { ISourceContainer[] containers = director.getSourceContainers(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousModel.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousModel.java index b1225caa7..e99a1829f 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousModel.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousModel.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2007 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 @@ -116,7 +116,6 @@ public abstract class AsynchronousModel { * Initializes this model. Called once after creation. * * @param root root element or <code>null</code> - * @param widget root widget/control */ public void init(Object root) { if (root != null) { @@ -154,6 +153,7 @@ public abstract class AsynchronousModel { /** * Returns whether this model has been disposed + * @return <code>true</code> if the model is disposed <code>false</code> otherwise */ public synchronized boolean isDisposed() { return fDisposed; @@ -205,7 +205,7 @@ public abstract class AsynchronousModel { /** * Uninstalls the model proxy installed for the given element, if any. * - * @param element + * @param element the element context */ protected synchronized void disposeModelProxy(Object element) { IModelProxy proxy = (IModelProxy) fModelProxies.remove(element); @@ -234,7 +234,7 @@ public abstract class AsynchronousModel { /** * Returns the presentation this model is installed in * - * @return + * @return the presentation context from the backing viewer */ protected IPresentationContext getPresentationContext() { return fViewer.getPresentationContext(); @@ -260,8 +260,8 @@ public abstract class AsynchronousModel { /** * Maps the given element to the given node. * - * @param element - * @param node + * @param element the element context + * @param node the model node */ protected synchronized void mapElement(Object element, ModelNode node) { ModelNode[] nodes = getNodes(element); @@ -286,7 +286,7 @@ public abstract class AsynchronousModel { /** * Unmaps the given node from its element and widget. * - * @param node + * @param node the model node */ protected synchronized void unmapNode(ModelNode node) { Object element = node.getElement(); @@ -356,7 +356,7 @@ public abstract class AsynchronousModel { /** * Removes the update from the pending updates list. * - * @param update + * @param update the update to remove */ protected void requestComplete(IStatusMonitor update) { synchronized (fPendingUpdates) { @@ -367,7 +367,7 @@ public abstract class AsynchronousModel { /** * An viewer update has been scheduled due to the following update request. * - * @param update + * @param update the update to add */ protected void viewerUpdateScheduled(IStatusMonitor update) { // synch viewer updates and pending updates on same lock - fPendingUpdates @@ -406,7 +406,7 @@ public abstract class AsynchronousModel { /** * Refreshes the given node. * - * @param node + * @param node the model node to update */ protected void updateLabel(ModelNode node) { Object element = node.getElement(); @@ -480,16 +480,16 @@ public abstract class AsynchronousModel { /** * Update this model's viewer preserving its selection. * - * @param update + * @param update the update code to run in the backing viewer's preserving selection method */ protected void preservingSelection(Runnable update) { getViewer().preservingSelection(update); } /** - * The viewer updated associated with a request is compelte. + * The viewer updated associated with a request is complete. * - * @param monitor + * @param monitor the status to remove and complete */ protected void viewerUpdateComplete(IStatusMonitor monitor) { // synch viewer updates and pending updates on same lock - fPendingUpdates @@ -502,7 +502,7 @@ public abstract class AsynchronousModel { /** * An update request was cancelled * - * @param monitor + * @param monitor the monitor to remove */ protected void requestCanceled(AsynchronousRequestMonitor monitor) { synchronized (fPendingUpdates) { @@ -513,7 +513,7 @@ public abstract class AsynchronousModel { /** * Whether any updates are still in progress in the model or against the viewer. * - * @return + * @return <code>true</code> if there are pending changes <code>false</code> otherwise */ protected boolean hasPendingUpdates() { synchronized (fViewerUpdates) { @@ -524,8 +524,8 @@ public abstract class AsynchronousModel { /** * Asynchronous update for add/set children request. * - * @param parent - * @param element + * @param parent the parent model node + * @param element the element context */ protected abstract void add(ModelNode parent, Object element); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousRequestMonitor.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousRequestMonitor.java index fba6d5d8e..c5fc0235c 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousRequestMonitor.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousRequestMonitor.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 @@ -20,7 +20,7 @@ import org.eclipse.ui.progress.WorkbenchJob; /** * Base implementation of an asynchronous request monitor. * <p> - * Not intended to be subclassed or instantiated by clients. For internal use + * Not intended to be sub-classed or instantiated by clients. For internal use * with the <code>AsynchronousViewer</code> implementation. * </p> * @since 3.2 @@ -110,7 +110,7 @@ public abstract class AsynchronousRequestMonitor extends AbstractRequestMonitor * That is, whether this update is for the same node or a child of * the given node. * - * @param ndoe node to test containment on + * @param node node to test containment on * @return whether this update contains the given node */ protected boolean contains(ModelNode node) { @@ -151,7 +151,7 @@ public abstract class AsynchronousRequestMonitor extends AbstractRequestMonitor /** * Returns whether this request is done yet. * - * @return + * @return if the request is done */ protected synchronized boolean isDone() { return fDone; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableModel.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableModel.java index 690347d83..ae6ff9c3a 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableModel.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableModel.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 @@ -24,7 +24,7 @@ public class AsynchronousTableModel extends AsynchronousModel { /** * Constructs a new table model. * - * @param viewer + * @param viewer the backing viewer */ public AsynchronousTableModel(AsynchronousViewer viewer) { super(viewer); @@ -38,7 +38,7 @@ public class AsynchronousTableModel extends AsynchronousModel { /** * Adds the given elements to the table. * - * @param elements + * @param elements the new elements to add */ public void add(Object[] elements) { TableAddRequestMonitor update = new TableAddRequestMonitor(getRootNode(), elements, this); @@ -79,8 +79,8 @@ public class AsynchronousTableModel extends AsynchronousModel { /** * Inserts the given elements to the table. * - * @param elements - * @param index + * @param elements the new elements to insert + * @param index the index to insert the elements at */ public void insert(Object[] elements, int index) { TableAddRequestMonitor update = new TableInsertRequestMonitor(getRootNode(), elements, index, this); @@ -123,7 +123,7 @@ public class AsynchronousTableModel extends AsynchronousModel { /** * Removes the given elements from the table. * - * @param elements + * @param elements the elements to remove */ public void remove(Object[] elements) { TableRemoveRequestMonitor update = new TableRemoveRequestMonitor(getRootNode(), elements, this); @@ -160,8 +160,8 @@ public class AsynchronousTableModel extends AsynchronousModel { /** * Adds the given elements to the table. - * - * @param elements + * @param element the element to replace + * @param replacement the element to replace the old element with */ public void replace(Object element, Object replacement) { TableReplaceRequestMonitor update = new TableReplaceRequestMonitor(getRootNode(), element, replacement, this); @@ -171,8 +171,8 @@ public class AsynchronousTableModel extends AsynchronousModel { /** * Notification add request is complete. - * - * @param elements elements to add + * @param element the element to be replaced + * @param replacement the element that replaced the old element */ protected void replaced(Object element, Object replacement) { Object[] filtered = filter(getRootNode().getElement(), new Object[] { replacement }); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableViewer.java index 785a26baf..a0885ce1d 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousTableViewer.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 @@ -70,8 +70,8 @@ public class AsynchronousTableViewer extends AsynchronousViewer implements Liste * Table must be SWT.VIRTUAL. This is intentional. Labels will never be * retrieved for non-visible items. * - * @see SWT.VIRTUAL - * @param table + * @see SWT#VIRTUAL + * @param table the backing table widget */ public AsynchronousTableViewer(Table table) { Assert.isTrue((table.getStyle() & SWT.VIRTUAL) != 0); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousViewer.java index e5878c461..269faa292 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/AsynchronousViewer.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 @@ -145,6 +145,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Hash lookup is required, don't let subclasses change behavior. + * @param enable if hash lookup should be used in the viewer */ public final void setUseHashlookup(boolean enable) { Assert.isTrue(enable); @@ -214,7 +215,6 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Updates the label for a specific element (node) in the model. * * @param node node to update - * @param item its associated item */ protected void updateLabel(ModelNode node) { // the input is not displayed @@ -396,7 +396,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Sets the context for this viewer. * - * @param context + * @param context the presentation context */ public void setContext(IPresentationContext context) { fContext = context; @@ -522,9 +522,9 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Returns whether the candidate selection should override the current * selection. * - * @param current - * @param curr - * @return + * @param current the current selection + * @param candidate the new selection + * @return if the selection should be overridden */ protected boolean overrideSelection(ISelection current, ISelection candidate) { IModelSelectionPolicy selectionPolicy = getSelectionPolicy(current); @@ -779,6 +779,8 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Returns whether the selection exists in the model + * @param selection the selection context + * @return <code>true</code> if the selecton exists in the model <code>false</code> otherwise */ protected boolean selectionExists(ISelection selection) { if (selection.isEmpty()) { @@ -836,7 +838,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Notification the given model proxy has been added to this viewer's model. * - * @param proxy + * @param proxy the model proxy that has been added */ protected void modelProxyAdded(IModelProxy proxy) { if (fUpdatePolicy instanceof IModelChangedListener) { @@ -847,7 +849,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Notification the given model proxy has been removed from this viewer's model. * - * @param proxy + * @param proxy the model proxy that has been removed */ protected void modelProxyRemoved(IModelProxy proxy) { if (fUpdatePolicy instanceof IModelChangedListener) { @@ -867,7 +869,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * A node in the model has been updated * - * @param node + * @param node the model node that has been changed */ protected void nodeChanged(ModelNode node) { Widget widget = findItem(node); @@ -888,7 +890,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Notification from the model that the update for the given request * has completed. * - * @param monitor + * @param monitor the monitor */ protected void updateComplete(IStatusMonitor monitor) { } @@ -896,22 +898,22 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Clears the given widget * - * @param item + * @param item the widget */ protected abstract void clear(Widget item); /** * Clears the children of the widget. * - * @param item + * @param item the widget to clear children from */ protected abstract void clearChildren(Widget item); /** * Clears the child at the given index. * - * @param parent - * @param childIndex + * @param parent the parent widget + * @param childIndex the index of the child widget to clear */ protected abstract void clearChild(Widget parent, int childIndex); @@ -919,17 +921,17 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Returns the child widget at the given index for the given parent or * <code>null</code> * - * @param parent - * @param index - * @return + * @param parent the parent widget + * @param index the index of the child in the parent widget + * @return the widget at the given index in the parent or <code>null</code> */ protected abstract Widget getChildWidget(Widget parent, int index); /** * Sets the item count for a parent widget * - * @param parent - * @param itemCount + * @param parent the parent widget + * @param itemCount the new item count to set */ protected abstract void setItemCount(Widget parent, int itemCount); @@ -945,7 +947,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Updates the child count for the parent's widget * and clears children to be updated. * - * @param parentNode + * @param parentNode the parent model node */ protected void nodeChildrenChanged(ModelNode parentNode) { Widget widget = findItem(parentNode); @@ -961,7 +963,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Notification children have been added to the end * of the given parent. * - * @param parentNode + * @param parentNode the parent model node */ protected void nodeChildrenAdded(ModelNode parentNode) { Widget widget = findItem(parentNode); @@ -976,7 +978,8 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Notification children have been added to the end * of the given parent. * - * @param parentNode + * @param parentNode the parent model node + * @param index the index of the child that was removed */ protected void nodeChildRemoved(ModelNode parentNode, int index) { Widget widget = findItem(parentNode); @@ -1000,7 +1003,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Unmaps the node from its widget and all of its children nodes from * their widgets. * - * @param node + * @param node the model node */ protected void unmapNode(ModelNode node) { unmapElement(node); @@ -1033,8 +1036,8 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Returns the item for the node or <code>null</code> - * @param node - * @return + * @param node the model node + * @return the widget or <code>null</code> */ protected Widget findItem(ModelNode node) { return findItem((Object)node); @@ -1145,8 +1148,8 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Sets the index of a child node being mapped at the given expansion level * in the tree. * - * @param nodeIndex - * @param level + * @param nodeIndex the index of the node + * @param level the expansion level */ private void setNodeIndex(int nodeIndex, int level) { if (level > (fSetDataIndicies.length - 1)) { @@ -1162,8 +1165,8 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis * Returns the index of a child node being mapped at the given expansion level in * the tree. * - * @param level - * @return + * @param level the expansion level + * @return the child index */ private int getNodeIndex(int level) { return fSetDataIndicies[level]; @@ -1176,7 +1179,7 @@ public abstract class AsynchronousViewer extends StructuredViewer implements Lis /** * Returns the parent widget for the given widget or <code>null</code> * - * @param widget + * @param widget the widget to get the parent from * @return parent widget or <code>null</code> */ protected abstract Widget getParentWidget(Widget widget); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/breadcrumb/BreadcrumbViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/breadcrumb/BreadcrumbViewer.java index c62676899..d659b0bef 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/breadcrumb/BreadcrumbViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/breadcrumb/BreadcrumbViewer.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2008, 2010 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 @@ -150,9 +150,10 @@ public abstract class BreadcrumbViewer extends StructuredViewer { /** * Configure the given drop down viewer. The given input is used for the viewers input. Clients * must at least set the label and the content provider for the viewer. - * - * @param viewer the viewer to configure - * @param input the input for the viewer + * @param parent the parent composite + * @param site the site to create the drop down for + * @param path the path to show + * @return the drop down control */ protected abstract Control createDropDown(Composite parent, IBreadcrumbDropDownSite site, TreePath path); @@ -323,6 +324,7 @@ public abstract class BreadcrumbViewer extends StructuredViewer { /** * This implementation of getSelection() returns an instance of * ITreeSelection. + * @return the current selection */ public ISelection getSelection() { Control control = getControl(); @@ -500,7 +502,7 @@ public abstract class BreadcrumbViewer extends StructuredViewer { /** * The given element was selected from a drop down menu. * - * @param element the selected element + * @param selection the selected element */ void fireMenuSelection(ISelection selection) { fireOpen(new OpenEvent(this, selection)); @@ -552,10 +554,7 @@ public abstract class BreadcrumbViewer extends StructuredViewer { /** * Generates the parent chain of the given element. - * - * @param element element to build the parent chain for - * @return the first index of an item in fBreadcrumbItems which is not - * part of the chain + * @param input element to build the parent chain for */ private void buildItemChain(Object input) { if (fBreadcrumbItems.size() > 0) { @@ -645,6 +644,9 @@ public abstract class BreadcrumbViewer extends StructuredViewer { /** * Creates or updates a breadcrumb item. + * @param index the index + * @param path the path + * @param element the element * * @return whether breadcrumb layout needs to be updated due to this change */ @@ -856,7 +858,7 @@ public abstract class BreadcrumbViewer extends StructuredViewer { * second component * @param ratio * percentage of the first component in the blend - * @return + * @return the blended color */ private static int blend(int v1, int v2, int ratio) { int b = (ratio * v1 + (100 - ratio) * v2) / 100; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenCountUpdate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenCountUpdate.java index 1988c8dff..e8201125f 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenCountUpdate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenCountUpdate.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2010 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 @@ -30,7 +30,13 @@ class ChildrenCountUpdate extends ViewerUpdateMonitor implements IChildrenCountU private List fBatchedRequests = null; /** - * @param contentProvider + * Constructor + * @param contentProvider the content provider to use for the update + * @param viewerInput the current input + * @param elementPath the path of the element to update + * @param element the element to update + * @param elementContentProvider the content provider for the element + * @param context the presentation context */ public ChildrenCountUpdate(ModelContentProvider contentProvider, Object viewerInput, TreePath elementPath, Object element, IElementContentProvider elementContentProvider, IPresentationContext context) { super(contentProvider, viewerInput, elementPath, element, elementContentProvider, context); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenUpdate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenUpdate.java index 81c94cddd..6375f6bdd 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenUpdate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ChildrenUpdate.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2010 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 @@ -31,8 +31,13 @@ public class ChildrenUpdate extends ViewerUpdateMonitor implements IChildrenUpda /** * Constructs a request to update an element * - * @param node node to update - * @param model model containing the node + * @param provider the content provider + * @param viewerInput the current input + * @param elementPath the path to the element being update + * @param element the element + * @param index the index of the element + * @param elementContentProvider the content provider for the element + * @param context the presentation context */ public ChildrenUpdate(ModelContentProvider provider, Object viewerInput, TreePath elementPath, Object element, int index, IElementContentProvider elementContentProvider, IPresentationContext context) { super(provider, viewerInput, elementPath, element, elementContentProvider, context); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/InternalTreeModelViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/InternalTreeModelViewer.java index 1f356c1dc..4cae7cdf7 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/InternalTreeModelViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/InternalTreeModelViewer.java @@ -323,8 +323,8 @@ public class InternalTreeModelViewer extends TreeViewer /** * Constructs a new listener waiting - * @param parentPath - * @param childIndex + * @param parentPath the parent path + * @param childIndex the current child index */ UpdateListener(TreePath parentPath, int childIndex) { fParentPath = parentPath; @@ -526,8 +526,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Sets the underlying model object. - * - * @param path path to the element + * @param data the model object */ void setElement(Object data) { fElement = data; @@ -536,7 +535,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Sets the label update associated with this element * - * @param update + * @param update the new label update */ void setLabelUpdate(VirtualLabelUpdate update) { fLabel = update; @@ -606,6 +605,9 @@ public class InternalTreeModelViewer extends TreeViewer /** * Creates a new update based for the given element and model + * @param model the backing model + * @param element the element to update + * @param elementPath the path of the element */ public VirtualUpdate(VirtualModel model, VirtualElement element, TreePath elementPath) { fPath = elementPath; @@ -714,7 +716,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * update progress monitor * - * @param work + * @param work the number of units worked */ void worked(int work) { fMonitor.worked(work); @@ -722,6 +724,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Schedules a children update. + * @param update the update to schedule */ private synchronized void scheduleUpdate(IChildrenUpdate update) { Object element = update.getElement(); @@ -871,7 +874,9 @@ public class InternalTreeModelViewer extends TreeViewer private int fLength = 0; /** - * @param elementPath + * @param parentPath the parent path + * @param parent the parent element + * @param model the model */ public VirtualChildrenUpdate(TreePath parentPath, VirtualElement parent, VirtualModel model) { super(model, parent, parentPath); @@ -914,8 +919,7 @@ public class InternalTreeModelViewer extends TreeViewer } /** - * @param treeItem - * @param i + * @param i the new offset */ void add(int i) { if (fOffset == -1) { @@ -930,8 +934,9 @@ public class InternalTreeModelViewer extends TreeViewer /** * Constructs a label request for the given element; - * - * @param elementPath + * @param coordinator the model + * @param element the element to update + * @param elementPath the element path */ public VirtualLabelUpdate(VirtualModel coordinator, VirtualElement element, TreePath elementPath) { super(coordinator, element, elementPath); @@ -996,8 +1001,9 @@ public class InternalTreeModelViewer extends TreeViewer } /** - * @param parent - * @param style + * @param parent the parent composite + * @param style the widget style bits + * @param context the presentation context */ public InternalTreeModelViewer(Composite parent, int style, IPresentationContext context) { super(parent, style); @@ -1057,7 +1063,7 @@ public class InternalTreeModelViewer extends TreeViewer } /** - * @param item + * @param item the item */ private void preserveItem(TreeItem item) { Object[] labels = (Object[]) item.getData(PREV_LABEL_KEY); @@ -1242,7 +1248,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Configures the columns for the given viewer input. * - * @param input + * @param input the viewer input */ protected void resetColumns(Object input) { if (input != null) { @@ -1280,8 +1286,6 @@ public class InternalTreeModelViewer extends TreeViewer /** * Configures the columns based on the current settings. - * - * @param input */ protected void configureColumns() { if (fColumnPresentation != null) { @@ -1317,6 +1321,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Resets any persisted column size for the given columns + * @param columnIds the identifiers of the columns to reset */ public void resetColumnSizes(String[] columnIds) { for (int i = 0; i < columnIds.length; i++) { @@ -1369,7 +1374,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Returns whether columns are being displayed currently. * - * @return + * @return if columns are being shown */ public boolean isShowColumns() { if (fColumnPresentation != null) { @@ -1400,7 +1405,7 @@ public class InternalTreeModelViewer extends TreeViewer * * TODO: does this need to be asynchronous? * - * @param presentation + * @param presentation the column presentation to build from */ protected void buildColumns(IColumnPresentation presentation) { // dispose current columns, persisting their weights @@ -1578,7 +1583,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Save viewer state into the given memento. * - * @param memento + * @param memento the {@link IMemento} to save to */ public void saveState(IMemento memento) { if (!fColumnSizes.isEmpty()) { @@ -1635,7 +1640,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Initializes viewer state from the memento * - * @param memento + * @param memento the {@link IMemento} to read from */ public void initState(IMemento memento) { IMemento[] mementos = memento.getChildren(COLUMN_SIZES); @@ -1696,10 +1701,9 @@ public class InternalTreeModelViewer extends TreeViewer /** * Returns whether the candidate selection should override the current * selection. - * - * @param current - * @param curr - * @return + * @param current the current selection + * @param candidate the candidate for the new selection + * @return if the current selection should be replaced with the candidate selection */ public boolean overrideSelection(ISelection current, ISelection candidate) { IModelSelectionPolicy selectionPolicy = ViewerAdapterService.getSelectionPolicy(current, getPresentationContext()); @@ -1878,7 +1882,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Returns the tree path for the given item. - * @param item + * @param item the item to compute the {@link TreePath} for * @return {@link TreePath} */ protected TreePath getTreePathFromItem(Item item) { @@ -1929,8 +1933,8 @@ public class InternalTreeModelViewer extends TreeViewer * workaround for bug 183463 * </p> * @param parent the parent of the widget, or <code>null</code> if the widget is the tree - * @param widget - * @param element + * @param widget the parent widget + * @param element the underlying object * @param index the index of the widget in the children array of its parent, or 0 if the widget is the tree */ private void virtualRefreshExpandedItems(Widget parent, Widget widget, Object element, int index) { @@ -1960,8 +1964,8 @@ public class InternalTreeModelViewer extends TreeViewer * workaround for bug 183463 * * Update the child count - * @param widget - * @param currentChildCount + * @param widget the widget + * @param currentChildCount the current child count */ private void virtualLazyUpdateChildCount(Widget widget, int currentChildCount) { TreePath treePath; @@ -1979,8 +1983,8 @@ public class InternalTreeModelViewer extends TreeViewer * <p> * workaround for bug 183463 * </p> - * @param widget - * @param index + * @param widget the widget + * @param index the index to update */ private void virtualLazyUpdateWidget(Widget widget, int index) { TreePath treePath; @@ -2424,7 +2428,7 @@ public class InternalTreeModelViewer extends TreeViewer /** * Retrieves the element's check box grayed state. * - * @param path + * @param path the path of the element to set grayed * @return grayed */ public boolean getElementGrayed(TreePath path) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ModelContentProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ModelContentProvider.java index 8ba366695..29f769ec1 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ModelContentProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ModelContentProvider.java @@ -316,6 +316,11 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi return fViewer == null; } + /** + * @param viewer the viewer whose input will change + * @param oldInput the old input + * @param newInput the new input + */ public synchronized void inputAboutToChange(ITreeModelContentProviderTarget viewer, Object oldInput, Object newInput) { if (newInput != oldInput && oldInput != null) { for (Iterator itr = fCompareRequestsInProgress.values().iterator(); itr.hasNext();) { @@ -489,14 +494,17 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Restore selection/expansion based on items already in the viewer + * @param delta the {@link ModelDelta} to restore from */ protected abstract void doInitialRestore(ModelDelta delta); /** - * @param delta + * @param delta the {@link ModelDelta} to restore from + * @param knowsHasChildren if the content provider has computed its children + * @param knowsChildCount if the content provider has already computed the child count + * @param checkChildrenRealized if any realized children should be checked */ - abstract void restorePendingStateNode(final ModelDelta delta, boolean knowsHasChildren, boolean knowsChildCount, - boolean checkChildrenRealized); + abstract void restorePendingStateNode(final ModelDelta delta, boolean knowsHasChildren, boolean knowsChildCount, boolean checkChildrenRealized); public void cancelRestore(final TreePath path, final int flags) { if (fInStateRestore) { @@ -712,7 +720,11 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Perform any restoration required for the given tree path. * - * @param path + * @param path the tree path to update + * @param modelIndex the index in the current model + * @param knowsHasChildren if the content provider knows it has children already + * @param knowsChildCount if the content provider knows the current child count already + * @param checkChildrenRealized if any realized children should be checked or not */ protected synchronized void restorePendingStateOnUpdate(final TreePath path, final int modelIndex, final boolean knowsHasChildren, final boolean knowsChildCount, final boolean checkChildrenRealized) { @@ -807,6 +819,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Saves the viewer's state for the previous input. * @param oldInput + * @param input the {@link ModelDelta} input */ protected void saveViewerState(Object input) { IElementMementoProvider stateProvider = ViewerAdapterService.getMementoProvider(input); @@ -1002,9 +1015,9 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Encodes delta elements into mementos using the given provider. + * @param rootDelta the {@link ModelDelta} to encode + * @param defaultProvider the default provider to use when processing the given delta * - * @param delta - * @param stateProvider */ protected void encodeDelta(final ModelDelta rootDelta, final IElementMementoProvider defaultProvider) { final Object input = rootDelta.getElement(); @@ -1165,8 +1178,8 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Called when a state save is starting. - * - * @param manager + * @param input the {@link ModelDelta} input + * @param manager the manager to notify */ private synchronized void stateSaveStarted(Object input, IMementoManager manager) { notifyStateUpdate(input, STATE_SAVE_SEQUENCE_BEGINS, null); @@ -1175,8 +1188,8 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Called when a state save is complete. - * - * @param manager + * @param input the {@link ModelDelta} input + * @param manager the manager to notify */ private synchronized void stateSaveComplete(Object input, IMementoManager manager) { notifyStateUpdate(input, STATE_SAVE_SEQUENCE_COMPLETE, null); @@ -1207,8 +1220,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Uninstalls the model proxy installed for the given element, if any. - * - * @param element + * @param path the {@link TreePath} to dispose the model proxy for */ protected synchronized void disposeModelProxy(TreePath path) { IModelProxy proxy = (IModelProxy) fTreeModelProxies.remove(path); @@ -1268,9 +1280,8 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Installs the model proxy for the given element into this content provider * if not already installed. - * - * @param element - * element to install an update policy for + * @param input the input to install the model proxy on + * @param path the {@link TreePath} to install the proxy for */ protected synchronized void installModelProxy(Object input, TreePath path) { if (!fTreeModelProxies.containsKey(path) && !fModelProxies.containsKey(path.getLastSegment())) { @@ -1393,14 +1404,16 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi } /** - * @see ITreeModelContentProvider#setModelDeltaMask(int) + * @param mask the new mask to set + * @see ITreeModelContentProvider for a list of masks */ public void setModelDeltaMask(int mask) { fModelDeltaMask = mask; } /** - * @see ITreeModelContentProvider#getModelDeltaMask() + * @return the current model delta mask + * @see IModelDelta for a list of masks */ public int getModelDeltaMask() { return fModelDeltaMask; @@ -1419,11 +1432,9 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Updates the viewer with the following deltas. * - * @param nodes - * Model deltas to be processed. - * @param override - * If true, it overrides the mode which suppresses processing of - * SELECT, REVEAL, EXPAND, COLLAPSE flags of {@link IModelDelta}. + * @param nodes Model deltas to be processed. + * @param mask the model delta mask + * @see IModelDelta for a list of masks */ protected void updateNodes(IModelDelta[] nodes, int mask) { for (int i = 0; i < nodes.length; i++) { @@ -1680,8 +1691,8 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi * Returns whether the given index of the specified parent was previously * filtered. * - * @param parentPath - * @param index + * @param parentPath the parent path + * @param index the index of parent path * @return whether the element at the given index was filtered */ protected boolean isFiltered(TreePath parentPath, int index) { @@ -1691,7 +1702,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Notification the given element is being unmapped. * - * @param path + * @param path the path to remove from the {@link FilterTransform} and cancel updates from */ public void unmapPath(TreePath path) { // System.out.println("Unmap " + path.getLastSegment()); @@ -1702,7 +1713,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Returns filtered children or <code>null</code> * - * @param parent + * @param parent the parent path to get children for * @return filtered children or <code>null</code> */ protected int[] getFilteredChildren(TreePath parent) { @@ -1869,7 +1880,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Notification an update request has started * - * @param update + * @param update the update to notify about */ void updateStarted(ViewerUpdateMonitor update) { boolean begin = false; @@ -1897,7 +1908,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi /** * Notification an update request has completed * - * @param update + * @param update the update to notify */ void updateComplete(final ViewerUpdateMonitor update) { notifyUpdate(UPDATE_COMPLETE, update); @@ -2049,8 +2060,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi * Returns whether this given request should be run, or should wait for * parent update to complete. * - * @param update - * @return whether to start the given request + * @param update the update the schedule */ void schedule(ViewerUpdateMonitor update) { synchronized (fRequestsInProgress) { @@ -2119,7 +2129,7 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi * * TODO: should we cancel child updates if a request has been canceled? * - * @param request + * @param request the request that just completed */ void trigger(ViewerUpdateMonitor request) { if (fWaitingRequests.isEmpty()) { @@ -2150,8 +2160,8 @@ abstract class ModelContentProvider implements IContentProvider, IModelChangedLi } /** - * @param key - * @param waiting + * @param key the {@link TreePath} + * @param waiting the list of waiting requests */ private void startHighestPriorityRequest(TreePath key, List waiting) { int priority = 4; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/provisional/IModelProxy.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/provisional/IModelProxy.java index b80f5d956..e661b1e97 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/provisional/IModelProxy.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/provisional/IModelProxy.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2009 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 @@ -10,6 +10,7 @@ *******************************************************************************/ package org.eclipse.debug.internal.ui.viewers.model.provisional; +import org.eclipse.debug.internal.ui.viewers.provisional.AbstractModelProxy; import org.eclipse.jface.viewers.Viewer; /** @@ -25,7 +26,7 @@ import org.eclipse.jface.viewers.Viewer; * within that model for a specific presentation context. * </p> * <p> - * Clients may implement this interface. Implementation of this interface + * Clients may implement this interface. Implementations of this interface * must subclass {@link AbstractModelProxy}. * </p> * @see IModelDelta diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousContentAdapter.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousContentAdapter.java index 01635d16e..975955b54 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousContentAdapter.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousContentAdapter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2006 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 @@ -52,8 +52,8 @@ public abstract class AsynchronousContentAdapter implements IAsynchronousContent /** * Returns the scheduling rule for jobs retrieving children. * - * @param parent - * @param context + * @param parent the parent + * @param context the presentation context * @return scheduling rule or <code>null</code> */ protected ISchedulingRule getRetrieveChildrenRule(Object parent, IPresentationContext context) { @@ -82,8 +82,8 @@ public abstract class AsynchronousContentAdapter implements IAsynchronousContent /** * Returns the scheduling rule for jobs determining if an element is a container. * - * @param parent - * @param context + * @param parent the parent + * @param context the presentation context * @return scheduling rule or <code>null</code> */ protected ISchedulingRule getIsContainerRule(Object parent, IPresentationContext context) { @@ -156,7 +156,7 @@ public abstract class AsynchronousContentAdapter implements IAsynchronousContent /** * Returns whether this adapter supports the given context. * - * @param context + * @param context the presentation context * @return whether this adapter supports the given context */ protected boolean supportsContext(IPresentationContext context) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousLabelAdapter.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousLabelAdapter.java index c2377e093..62c1c2c16 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousLabelAdapter.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/provisional/AsynchronousLabelAdapter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2008 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 @@ -62,8 +62,8 @@ public abstract class AsynchronousLabelAdapter implements IAsynchronousLabelAdap /** * Returns the scheduling rule for label jobs. * - * @param element - * @param context + * @param element the element context + * @param context the presentation context * @return scheduling rule or <code>null</code> */ protected ISchedulingRule getLabelRule(Object element, IPresentationContext context) { @@ -74,6 +74,7 @@ public abstract class AsynchronousLabelAdapter implements IAsynchronousLabelAdap * Returns whether this label adapter requires to be run in the UI thread. * By default, label jobs are not run in the UI thread. Subclasses should * override if required. + * @param object the object context * * @return whether this label adapter requires to be run in the UI thread. */ @@ -86,7 +87,7 @@ public abstract class AsynchronousLabelAdapter implements IAsynchronousLabelAdap * * @param element element to compute label for * @param context presentation context - * @param result monitor to report results to + * @param monitor monitor to report results to */ protected void computeLabels(Object element, IPresentationContext context, ILabelRequestMonitor monitor) { if (!monitor.isCanceled()) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/ViewContextService.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/ViewContextService.java index 96cda0564..fbbafc901 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/ViewContextService.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/ViewContextService.java @@ -224,6 +224,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Activates the views in this context hierarchy. Views are activated top down, allowing * sub-contexts to override settings in a parent context. + * @param page the page context + * @param perspective the perspective description */ public void activateChain(IWorkbenchPage page, IPerspectiveDescriptor perspective) { initializeChain(); @@ -235,6 +237,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi * specified contexts in the given page. * * @param page page to activate views in + * @param perspective the perspective description * @param viewIds id's of views to activate * @param contextIds associated contexts that are activated */ @@ -298,6 +301,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi * Deactivates this context only (not parents) * * @param page workbench page + * @param perspective the perspective description */ public void deactivate(IWorkbenchPage page, IPerspectiveDescriptor perspective) { removeActivated(getId()); @@ -315,7 +319,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi * Notes when a view is opened/closed manually. * * @param opened opened or closed - * @param viewId + * @param viewId the view identifier */ public void setViewOpened(boolean opened, String viewId) { initializeChain(); @@ -340,8 +344,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Save view binding settings into XML document. * - * @param document - * @param root + * @param document the document to save to + * @param root the root XML element * @param alreadyDone views already done */ public void saveBindings(Document document, Element root, Set alreadyDone) { @@ -381,7 +385,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns the id of the view this binding pertains to. * - * @return + * @return the id of the view */ public String getViewId() { return fElement.getAttribute(ATTR_VIEW_ID); @@ -390,7 +394,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether this view binding is set for auto-open. * - * @return + * @return if the view is set to auto-open */ public boolean isAutoOpen() { String autoopen = fElement.getAttribute(ATTR_AUTO_OPEN); @@ -400,7 +404,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether this view binding is set for auto-close. * - * @return + * @return if the view is set to auto-close */ public boolean isAutoClose() { String autoclose = fElement.getAttribute(ATTR_AUTO_CLOSE); @@ -409,7 +413,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether this view was opened by the user in the active perspective. - * @return + * @param perspective the perspective description + * @return if this view was opened by the user */ public boolean isUserOpened(IPerspectiveDescriptor perspective) { return fUserOpened.contains(perspective.getId()); @@ -417,7 +422,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether this view was closed by the user in the active perspective - * @return + * @param perspective the description of the perspective + * @return if this view was closed by the user in the active perspective */ public boolean isUserClosed(IPerspectiveDescriptor perspective) { return fUserClosed.contains(getActivePerspective().getId()); @@ -428,8 +434,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi * * TODO: we really need an API to determine which views are * in a perspective by default, but it does not seem to exist. - * - * @return + * @param perspective the description of the perspective + * @return if this view is part of the active perspective by default */ public boolean isDefault(IPerspectiveDescriptor perspective) { String id = perspective.getId(); @@ -462,7 +468,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether the preference is set to track user view open/close. * - * @return + * @return if the service is set to track user view open/close */ protected boolean isTrackingViews() { return DebugUITools.getPreferenceStore().getBoolean(IInternalDebugUIConstants.PREF_TRACK_VIEWS); @@ -471,7 +477,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Context has been activated, open/show as required. * - * @param page + * @param page the workbench page + * @param perspective the perspective description */ public void activated(IWorkbenchPage page, IPerspectiveDescriptor perspective) { if (!isUserClosed(perspective)) { @@ -497,7 +504,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi * Context has been activated. Check the view stack to see if this view * should be made visible. * - * @param page + * @param page the page to check + * @param relevantViews the array of view identifiers */ public void checkZOrder(IWorkbenchPage page, String[] relevantViews) { // see if view is open already @@ -526,7 +534,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Context has been deactivated, close as required. * - * @param page + * @param page the workbench page + * @param perspective the perspective description */ public void deactivated(IWorkbenchPage page, IPerspectiveDescriptor perspective) { if (!isUserOpened(perspective)) { @@ -547,8 +556,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Save view binding settings into XML document. * - * @param document - * @param root + * @param document the document to save to + * @param root the root XML element */ public void saveBindings(Document document, Element root) { Element viewElement = document.createElement(XML_ELEMENT_VIEW); @@ -602,7 +611,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Creates a service for the given window * - * @param window + * @param window the window to attach this service to */ ViewContextService(IWorkbenchWindow window) { fWindow = window; @@ -749,6 +758,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Parses the comma separated string into a list of strings + * @param listString the comma separated string to parse into a list object * * @return list */ @@ -838,8 +848,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether the given context is the active context in the active perspective. * - * @param contextId - * @return + * @param contextId the id of the context + * @return if the given id is the id for the currently active context */ private boolean isActiveContext(String contextId) { IPerspectiveDescriptor activePerspective = getActivePerspective(); @@ -853,8 +863,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether the given context is activated in the active perspective. * - * @param contextId - * @return + * @param contextId the context id + * @return if the given context is activated in the active perspective */ private boolean isActivated(String contextId) { IPerspectiveDescriptor activePerspective = getActivePerspective(); @@ -916,8 +926,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Closes all auto-opened views. * - * @param page - * @param perspective + * @param perspective the perspective descriptor */ private void clean(IPerspectiveDescriptor perspective) { Set contexts = (Set) fPerspectiveToActivatedContexts.remove(perspective); @@ -983,7 +992,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Activates all parent contexts of the given context, top down. * - * @param contextId + * @param contextId the identifier of the {@link DebugContextViewBindings} to activate + * @param perspective the perspective description */ private void activateChain(String contextId, IPerspectiveDescriptor perspective) { if (fWindow == null) return; // disposed @@ -1021,8 +1031,8 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi * Sets the active context in the given perspective, or removes * when <code>null</code>. * - * @param perspective - * @param contextId + * @param perspective the perspective descriptor + * @param contextId the context identifier */ private void setActive(IPerspectiveDescriptor perspective, String contextId) { if (contextId == null) { @@ -1042,7 +1052,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi Iterator contexts = disabledContexts.iterator(); while (contexts.hasNext()) { String contextId = (String)contexts.next(); - if (isViewConetxt(contextId)) { + if (isViewContext(contextId)) { if (isActivated(contextId)) { deactivate(contextId, getActivePerspective()); } @@ -1069,7 +1079,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns a set of contexts disabled in the given event, possibly empty. * - * @param event + * @param event the event * @return disabled context id's */ private Set getDisabledContexts(ContextManagerEvent event) { @@ -1084,10 +1094,10 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns whether the given context has view bindings. * - * @param id + * @param id the context id * @return whether the given context has view bindings */ - private boolean isViewConetxt(String id) { + private boolean isViewContext(String id) { return fContextIdsToBindings.containsKey(id); } @@ -1122,7 +1132,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Returns the perspectives in which debugging is enabled. * - * @return + * @return the array of perspective identifiers in which debugging is enabled */ public String[] getEnabledPerspectives() { return (String[]) fEnabledPerspectives.toArray(new String[fEnabledPerspectives.size()]); @@ -1131,7 +1141,7 @@ public class ViewContextService implements IDebugContextListener, IPerspectiveLi /** * Show the view without effecting user preferences * - * @param viewId + * @param viewId the id of the view to show */ public void showViewQuiet(String viewId) { if (fWindow == null) return; // disposed; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointContainer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointContainer.java index 53fd62214..59b22baad 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointContainer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointContainer.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 @@ -267,7 +267,7 @@ public class BreakpointContainer extends ElementContentProvider implements IAdap * * @param breakpoint the breakpoint to added * @param rootDelta the root delta of this container - * @see removeBreakpoint + * @see #removeBreakpoint */ public void addBreakpoint(IBreakpoint breakpoint, ModelDelta rootDelta) { final int bpIndex = insertBreakpoint(breakpoint); @@ -320,8 +320,9 @@ public class BreakpointContainer extends ElementContentProvider implements IAdap * Remove a breakpoint from the container, additional delta will be added to the root delta. * * @param breakpoint the breakpoint to remove - * @param delta the root delta of this container - * @see addBreakpoint + * @param rootDelta the root delta of this container + * @return if the breakpoint was successfully removed + * @see #addBreakpoint */ public boolean removeBreakpoint(IBreakpoint breakpoint, ModelDelta rootDelta) { boolean removed = fBreakpoints.remove(breakpoint); @@ -431,7 +432,6 @@ public class BreakpointContainer extends ElementContentProvider implements IAdap * * @param container the container to append child delta * @param containerDelta the delta of the breakpoint container, additional delta will be added to this delta - * @see BreakpointContainer.addContainer */ static private void appendContainerDelta(BreakpointContainer container, ModelDelta containerDelta) { Object[] children = container.getChildren(); @@ -467,7 +467,7 @@ public class BreakpointContainer extends ElementContentProvider implements IAdap * Remove all child elements including the given container itself. * * @param container the breakpoint container - * @param parentDelta the parent delta + * @param delta the parent delta */ static public void removeAll(BreakpointContainer container, ModelDelta delta) { BreakpointContainer parent = container.getParent(); @@ -575,7 +575,7 @@ public class BreakpointContainer extends ElementContentProvider implements IAdap /** * Returns whether this container contains the given breakpoint. * - * @param breakpoint + * @param breakpoint the breakpoint to check * @return true if this container contains the given breakpoint */ public boolean contains(IBreakpoint breakpoint) { @@ -585,7 +585,7 @@ public class BreakpointContainer extends ElementContentProvider implements IAdap /** * Returns the child containers for the given breakpoint. * - * @param breakpoint + * @param breakpoint the breakpoint to get containers for * @return child containers */ public BreakpointContainer[] getContainers(IBreakpoint breakpoint) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointOrganizerManager.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointOrganizerManager.java index 529cb606c..4d39bf90e 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointOrganizerManager.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointOrganizerManager.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 @@ -49,6 +49,7 @@ public class BreakpointOrganizerManager { /** * Returns the singleton instance of the breakpoint container * factory manager. + * @return the singleton {@link BreakpointOrganizerManager} */ public static BreakpointOrganizerManager getDefault() { if (fgManager == null) { @@ -100,7 +101,7 @@ public class BreakpointOrganizerManager { /** * Validates the given organizer. Checks that certain required attributes * are available. - * @param extension the organizer to validate + * @param organizer the organizer to check * @return whether the given organizer is valid */ protected static boolean validateOrganizer(IBreakpointOrganizer organizer) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointPersistableElementAdapter.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointPersistableElementAdapter.java index d0c83615e..45c10845b 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointPersistableElementAdapter.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointPersistableElementAdapter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 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 @@ -29,7 +29,7 @@ public class BreakpointPersistableElementAdapter implements IPersistableElement /** * Constructs a new persitable element adapter for the given breakpoint. * - * @param breakpoint + * @param breakpoint the backing {@link IBreakpoint} */ public BreakpointPersistableElementAdapter(IBreakpoint breakpoint) { fBreakpoint = breakpoint; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointSetOrganizer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointSetOrganizer.java index abc8af1fe..ddb2bc4b7 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointSetOrganizer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointSetOrganizer.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 @@ -206,7 +206,7 @@ public class BreakpointSetOrganizer extends AbstractBreakpointOrganizerDelegate /** * Adds a breakpoint to a working set - * @param breakpoint the breakpoint to add + * @param breakpoints the breakpoints to add * @param set the set to add it to or <code>null</code> if none * * @since 3.2 @@ -366,9 +366,9 @@ public class BreakpointSetOrganizer extends AbstractBreakpointOrganizerDelegate /** * Gets the working set names from the marker * - * @param marker - * them marker to get the names from - * @return the listing of markers or an empty String array, never null + * @param marker them marker to get the names from + * @param type the type attribute to look up + * @return the listing of markers or an empty String array, never <code>null</code> * * @since 3.2 */ diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointWorkingSetCache.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointWorkingSetCache.java index 85682f4ed..bb8f51073 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointWorkingSetCache.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointWorkingSetCache.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 @@ -36,13 +36,12 @@ public class BreakpointWorkingSetCache { /** * the entire cache * key: marker - * value: vector of workingsets the marker belongs to + * value: vector of working sets the marker belongs to */ HashMap fCache = null; /** * Default constructor - * @param organizer the oprganizer that owns this cache */ public BreakpointWorkingSetCache() { fCache = new HashMap(15); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsComparator.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsComparator.java index 96f5741ef..1b0ca637e 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsComparator.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsComparator.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 @@ -26,8 +26,8 @@ import org.eclipse.jface.viewers.ViewerComparator; * @since 3.3 */ public class BreakpointsComparator extends ViewerComparator { - /** - * @see ViewerSorter#isSorterProperty(Object, String) + /* (non-Javadoc) + * @see org.eclipse.jface.viewers.ViewerComparator#isSorterProperty(java.lang.Object, java.lang.String) */ public boolean isSorterProperty(Object element,String propertyId) { return propertyId.equals(IBasicPropertyConstants.P_TEXT); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsContentProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsContentProvider.java index 21dabc737..a49b1a505 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsContentProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsContentProvider.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 @@ -143,7 +143,7 @@ public class BreakpointsContentProvider implements ITreeContentProvider, IProper * Returns the root containers containing the given breakpoint, or <code>null</code> * if none * - * @param breakpoint + * @param breakpoint the breakpoint to get containers for * @return root containers containing the given breakpoint or <code>null</code> */ public BreakpointContainer[] getRoots(IBreakpoint breakpoint) { @@ -234,7 +234,7 @@ public class BreakpointsContentProvider implements ITreeContentProvider, IProper /** * Returns the existing containers the given breakpoint is contained in, or <code>null</code>. * - * @param breakpoint + * @param breakpoint the breakpoint to get containers for * @return the existing containers the given breakpoint is contained in, or <code>null</code> */ protected BreakpointContainer[] getContainers(IBreakpoint breakpoint) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDragAdapter.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDragAdapter.java index 817e9a730..60093f275 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDragAdapter.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDragAdapter.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 @@ -40,7 +40,7 @@ public class BreakpointsDragAdapter extends DragSourceAdapter implements Transfe /** * Constructor - * @param view the associated view, which acts as the selection provider and therefore <b>must</b> implement <code>ISelectionProvider</code> + * @param viewer the associated viewer, which acts as the selection provider and therefore <b>must</b> implement <code>ISelectionProvider</code> */ public BreakpointsDragAdapter(BreakpointsViewer viewer) { Assert.isNotNull(viewer); @@ -52,8 +52,8 @@ public class BreakpointsDragAdapter extends DragSourceAdapter implements Transfe fView = view; } - /** - * @see TransferDragSourceListener#getTransfer + /* (non-Javadoc) + * @see org.eclipse.jface.util.TransferDragSourceListener#getTransfer() */ public Transfer getTransfer() { return LocalSelectionTransfer.getTransfer(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDropAdapter.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDropAdapter.java index 422cea9c6..2ba3c310a 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDropAdapter.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsDropAdapter.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 @@ -36,7 +36,8 @@ public class BreakpointsDropAdapter extends ViewerDropAdapter { private BreakpointsView fView; /** - * @param viewer + * Constructor + * @param viewer the backing viewer */ protected BreakpointsDropAdapter(TreeViewer viewer) { super(viewer); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsLabelProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsLabelProvider.java index 65ba74cd8..b7e557000 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsLabelProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsLabelProvider.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 @@ -68,7 +68,6 @@ public class BreakpointsLabelProvider extends LabelProvider implements IFontProv /** * Computes and return common adornment flags for the given category. * - * @param element breakpoint category * @return adornment flags defined in CompositeDebugImageDescriptor */ private int computeAdornmentFlags() { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsView.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsView.java index ee1034f73..131a58c7b 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsView.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsView.java @@ -188,7 +188,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Returns the tree model viewer. - * @return + * @return the backin gviewer */ public TreeModelViewer getTreeModelViewer() { return (TreeModelViewer) getViewer(); @@ -376,6 +376,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Initializes the persisted breakpoints organizers. + * @param memento the memento to read */ private void initBreakpointOrganizers(IMemento memento) { if (memento != null) { @@ -405,6 +406,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Initializes drag and drop for the breakpoints viewer + * @param viewer the viewer to add drag and drop support to */ protected void initDragAndDrop(TreeModelViewer viewer) { int ops = DND.DROP_MOVE | DND.DROP_COPY; @@ -490,8 +492,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Sets the breakpoint filter for this view. - * - * @param ss the selection, can be <code>null</code>. + * @param filter the selection to act as a filter */ public void setFilterSelection(boolean filter) { TreeModelViewer viewer = getTreeModelViewer(); @@ -615,7 +616,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Returns the container from within the specified path that is the container the breakpoint can be removed from - * @param breakpoint the breakpoint to get the container for + * @param path the path to get the container from * @return the first found container that includes the breakpoint that allows removal, or <code>null</code> if none found * @since 3.3 */ @@ -642,7 +643,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Returns the addable breakpoint container of the specified tree path - * @param breakpoint the breakpoint to get the container for + * @param path the path to get the container for * @return the first found addable container for the specified tree path or <code>null</code> if none found * @since 3.3 */ @@ -671,12 +672,12 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * This method is used to determine if there is an addable parent container available for the specified drop target. * <p> - * A drop target can be either a <code>IBreakpointContainer</code> or an <code>IBreakpoint</code>. This method always checks the entire heirarchy + * A drop target can be either a <code>IBreakpointContainer</code> or an <code>IBreakpoint</code>. This method always checks the entire hierarchy * of the tree path for the specified target in the event one of the parent element does not support dropping. * </p> - * @param target - * @param breakpoint - * @return + * @param path the path + * @param breakpoint the breakpoint + * @return <code>true</code> if there is a parent container available for the drop target <code>false</code> otherwise */ private boolean checkAddableParentContainers(TreePath path, IBreakpoint breakpoint) { if (path != null) { @@ -703,7 +704,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager * <li>breakpoints can be dragged iff the container they reside in supports the removal of breakpoints</li> * </ul> * </p> - * @param element the element to test if it can be dragged + * @param items the tree paths to check if they can be dragged * @return true if the selected element can be dragged, false otherwise * @since 3.3 */ @@ -724,7 +725,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager /** * Performs the actual removal of breakpoints from their respective (removable) containers on a successful drag operation - * @param selection the selection of breakpoints involved in the drag + * @param paths the tree paths to drag * @since 3.3 */ void performDrag(TreePath[] paths) { @@ -814,7 +815,7 @@ public class BreakpointsView extends VariablesView implements IBreakpointManager * </ul> * </p> * @param target the target for the drop - * @param element the element we want to drop + * @param selection the selection to see if we can drop * @return true if the specified element can be dropped into the specified target, false otherwise * @since 3.3 */ diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsViewer.java index 5445a4787..3635107a6 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointsViewer.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 @@ -43,7 +43,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Constructs a new breakpoints viewer with the given tree. * - * @param tree + * @param tree the backing tree widget */ public BreakpointsViewer(Tree tree) { super(tree); @@ -99,7 +99,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { * Adds expanded breakpoints to the list. Traverses children of the given * tree item if any. * - * @param item + * @param item the item to get breakpoints from * @param list collection of visible breakpoints */ private void collectExpandedBreakpoints(TreeItem item, List list) { @@ -119,7 +119,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Sets the selection to a specific tree item * - * @param item + * @param item the item to set as the current tree selection */ protected void setSelection(TreeItem item) { getTree().setSelection(new TreeItem[]{item}); @@ -128,7 +128,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Returns the container from within the specified path that is the container the breakpoint can be removed from - * @param breakpoint the breakpoint to get the container for + * @param item the item to get the container for * @return the first found container that includes the breakpoint that allows removal, or <code>null</code> if none found * @since 3.3 */ @@ -154,7 +154,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Returns the addable breakpoint container of the specified breakpoint - * @param breakpoint the breakpoint to get the container for + * @param item the item to get the container for * @return the first found addable container for the specified breakpoint or <code>null</code> if none found * @since 3.3 */ @@ -185,7 +185,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { * <li>breakpoints can be dragged iff the container they reside in supports the removal of breakpoints</li> * </ul> * </p> - * @param element the element to test if it can be dragged + * @param items the items to test if they can be dragged * @return true if the selected element can be dragged, false otherwise * @since 3.3 */ @@ -206,7 +206,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Performs the actual removal of breakpoints from their respective (removable) containers on a successful drag operation - * @param selection the selection of breakpoints involved in the drag + * @param items the items involved in the drag * @since 3.3 */ public void performDrag(Item[] items) { @@ -258,7 +258,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { * </ul> * </p> * @param target the target for the drop - * @param element the element we want to drop + * @param selection the selection we want to drop * @return true if the specified element can be dropped into the specified target, false otherwise * @since 3.3 */ @@ -278,12 +278,12 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * This method is used to determine if there is an addable parent container available for the specified drop target. * <p> - * A drop target can be either a <code>BreakpointContainer</code> or an <code>IBreakpoint</code>. This method always checks the entire heirarchy + * A drop target can be either a <code>BreakpointContainer</code> or an <code>IBreakpoint</code>. This method always checks the entire hierarchy * of the tree path for the specified target in the event one of the parent element does not support dropping. * </p> - * @param target - * @param breakpoint - * @return + * @param target the target to check + * @param breakpoint the breakpoint we would like to drop + * @return <code>true</code> if there is a parent container we can drop into */ private boolean checkAddableParentContainers(Item target, IBreakpoint breakpoint) { IBreakpointContainer container = null; @@ -358,7 +358,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Update the checked state up the given element and all of its children. * - * @param element + * @param element the element to update */ public void updateCheckedState(Object element) { Widget[] widgets = searchItems(element); @@ -403,7 +403,7 @@ public class BreakpointsViewer extends CheckboxTreeViewer { /** * Update the checked state up the given element and all of its children. * - * @param element + * @param item the item to update */ public void updateCheckedState(TreeItem item) { Object element = item.getData(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleLineNotifier.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleLineNotifier.java index a51c68d14..b623b26e3 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleLineNotifier.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleLineNotifier.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 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 @@ -98,7 +98,7 @@ public class ConsoleLineNotifier implements IPatternMatchListener, IPropertyChan * Adds the given listener to the list of listeners notified when a line of * text is appended to the console. * - * @param listener + * @param listener the listener to add */ public void addConsoleListener(IConsoleLineTracker listener) { if (!fListeners.contains(listener)) diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleTerminateAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleTerminateAction.java index e562612ce..cdb9707b3 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleTerminateAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/console/ConsoleTerminateAction.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 @@ -38,6 +38,8 @@ public class ConsoleTerminateAction extends Action implements IUpdate { /** * Creates a terminate action for the console + * @param window the window + * @param console the console */ public ConsoleTerminateAction(IWorkbenchWindow window, ProcessConsole console) { super(ConsoleMessages.ConsoleTerminateAction_0); @@ -74,7 +76,7 @@ public class ConsoleTerminateAction extends Action implements IUpdate { /** * Collects targets associated with a process. * - * @param process + * @param process the process to collect {@link IDebugTarget}s for * @return associated targets */ private List collectTargets(IProcess process) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbDropDownAutoExpandAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbDropDownAutoExpandAction.java index 94083c91a..f24b49546 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbDropDownAutoExpandAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbDropDownAutoExpandAction.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 @@ -29,8 +29,6 @@ class BreadcrumbDropDownAutoExpandAction extends Action { * Creates a new action to set the debug view mode. * * @param view Reference to the debug view. - * @param mode The mode to be set by this action. - * @param parent The view's parent control used to calculate view size * in auto mode. */ public BreadcrumbDropDownAutoExpandAction(LaunchView view) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbWorkbenchPart.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbWorkbenchPart.java index ca87e7de3..1b458ec5c 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbWorkbenchPart.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/launch/BreadcrumbWorkbenchPart.java @@ -1,117 +1,117 @@ -/*******************************************************************************
- * Copyright (c) 2000, 2009 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
- * Pawel Piech - Wind River - adapted to use in Debug view
- *******************************************************************************/
-package org.eclipse.debug.internal.ui.views.launch;
-
-import org.eclipse.swt.graphics.Image;
-import org.eclipse.swt.widgets.Composite;
-import org.eclipse.ui.IPropertyListener;
-import org.eclipse.ui.IWorkbenchPart;
-import org.eclipse.ui.IWorkbenchPartSite;
-
-/**
- * Fake part to used to create the breadcrumb page.
- *
- * @since 3.5
- * @see LaunchView#fDefaultPageRec
- */
-class BreadcrumbWorkbenchPart implements IWorkbenchPart {
-
- private IWorkbenchPartSite fSite = null;
-
- /* (non-Javadoc)
- * @see java.lang.Object#equals(java.lang.Object)
- */
- public boolean equals(Object obj) {
- return (obj instanceof BreadcrumbWorkbenchPart);
- }
-
- /* (non-Javadoc)
- * @see java.lang.Object#hashCode()
- */
- public int hashCode() {
- return getClass().hashCode();
- }
-
- /**
- * Constructs a part for the given console that binds to the given
- * site
- */
- public BreadcrumbWorkbenchPart(IWorkbenchPartSite site) {
- fSite = site;
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#addPropertyListener(org.eclipse.ui.IPropertyListener)
- */
- public void addPropertyListener(IPropertyListener listener) {
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)
- */
- public void createPartControl(Composite parent) {
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#dispose()
- */
- public void dispose() {
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#getSite()
- */
- public IWorkbenchPartSite getSite() {
- return fSite;
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#getTitle()
- */
- public String getTitle() {
- return ""; //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#getTitleImage()
- */
- public Image getTitleImage() {
- return null;
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#getTitleToolTip()
- */
- public String getTitleToolTip() {
- return ""; //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#removePropertyListener(org.eclipse.ui.IPropertyListener)
- */
- public void removePropertyListener(IPropertyListener listener) {
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IWorkbenchPart#setFocus()
- */
- public void setFocus() {
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
- */
- public Object getAdapter(Class adapter) {
- return null;
- }
-}
-
+/******************************************************************************* + * 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 + * Pawel Piech - Wind River - adapted to use in Debug view + *******************************************************************************/ +package org.eclipse.debug.internal.ui.views.launch; + +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.ui.IPropertyListener; +import org.eclipse.ui.IWorkbenchPart; +import org.eclipse.ui.IWorkbenchPartSite; + +/** + * Fake part to used to create the breadcrumb page. + * + * @since 3.5 + */ +class BreadcrumbWorkbenchPart implements IWorkbenchPart { + + private IWorkbenchPartSite fSite = null; + + /* (non-Javadoc) + * @see java.lang.Object#equals(java.lang.Object) + */ + public boolean equals(Object obj) { + return (obj instanceof BreadcrumbWorkbenchPart); + } + + /* (non-Javadoc) + * @see java.lang.Object#hashCode() + */ + public int hashCode() { + return getClass().hashCode(); + } + + /** + * Constructs a part for the given console that binds to the given + * site + * @param site the backing site + */ + public BreadcrumbWorkbenchPart(IWorkbenchPartSite site) { + fSite = site; + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#addPropertyListener(org.eclipse.ui.IPropertyListener) + */ + public void addPropertyListener(IPropertyListener listener) { + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite) + */ + public void createPartControl(Composite parent) { + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#dispose() + */ + public void dispose() { + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#getSite() + */ + public IWorkbenchPartSite getSite() { + return fSite; + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#getTitle() + */ + public String getTitle() { + return ""; //$NON-NLS-1$ + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#getTitleImage() + */ + public Image getTitleImage() { + return null; + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#getTitleToolTip() + */ + public String getTitleToolTip() { + return ""; //$NON-NLS-1$ + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#removePropertyListener(org.eclipse.ui.IPropertyListener) + */ + public void removePropertyListener(IPropertyListener listener) { + } + + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchPart#setFocus() + */ + public void setFocus() { + } + + /* (non-Javadoc) + * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class) + */ + public Object getAdapter(Class adapter) { + return null; + } +} + diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AbstractMemoryViewPane.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AbstractMemoryViewPane.java index 791dd71ff..ab2747bb7 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AbstractMemoryViewPane.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AbstractMemoryViewPane.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2010 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 @@ -74,7 +74,9 @@ public abstract class AbstractMemoryViewPane implements IMemoryBlockListener, IS /** * Create the content of the view pane - * @param parent + * @param parent the parent composite + * @param paneId the id of the pane to create + * @param label the label for the new pane * @return the control of the view pane */ public Control createViewPane(Composite parent, String paneId, String label) @@ -342,6 +344,7 @@ public abstract class AbstractMemoryViewPane implements IMemoryBlockListener, IS * Helper method to dispose of a tab folder, * and of any tab items it contains. * Must be called from the UI thread. + * @param tabFolder the {@link CTabFolder} to dispose * */ private void disposeOfFolder(CTabFolder tabFolder) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryBlockAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryBlockAction.java index 0ebcbb4f0..1e6d934d6 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryBlockAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryBlockAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2010 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 @@ -69,6 +69,7 @@ public class AddMemoryBlockAction extends Action implements IDebugContextListene } /** + * @param site the site to add the action to * @param addDefaultRenderings - specify if the action should add * default renderings for the new memory block when it is run */ @@ -79,7 +80,7 @@ public class AddMemoryBlockAction extends Action implements IDebugContextListene } /** - * + * @param site the site to initialize */ private void initialize(IMemoryRenderingSite site) { setText(DebugUIMessages.AddMemoryBlockAction_title); @@ -94,7 +95,7 @@ public class AddMemoryBlockAction extends Action implements IDebugContextListene } /** - * + * @param site the site to initialize */ private void doInitialization(IMemoryRenderingSite site) { fSite = site; @@ -182,12 +183,12 @@ public class AddMemoryBlockAction extends Action implements IDebugContextListene } /** - * @param exit - * @param elem - * @param standardMemRetrieval - * @param dialog - * @param expressionsArray - * @return + * @param exit the exit value + * @param elem the element context + * @param standardMemRetrieval the {@link IMemoryBlockRetrieval} + * @param dialog the dialog to use + * @param expressionsArray the array of memory expressions + * @return if we should exit */ private boolean addMemoryBlocks(boolean exit, Object elem, IMemoryBlockRetrieval standardMemRetrieval, MonitorMemoryBlockDialog dialog, final String[] expressionsArray) { for (int i=0; i<expressionsArray.length; i++) @@ -388,9 +389,10 @@ public class AddMemoryBlockAction extends Action implements IDebugContextListene } /** - * @param memoryBlock - * @param primaryType - * @throws CoreException + * @param memoryBlock the memory block to create a rendering for + * @param primaryType the type of the desired rendering + * @param paneId the id of the pane + * @throws CoreException if an exception occurs */ private void createRenderingInContainer(IMemoryBlock memoryBlock, IMemoryRenderingType primaryType, String paneId) throws CoreException { IMemoryRendering rendering = primaryType.createRendering(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingContextAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingContextAction.java index 77393eb3f..b339883c1 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingContextAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingContextAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 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 @@ -52,8 +52,8 @@ public class AddMemoryRenderingContextAction implements IViewActionDelegate { } /** - * @param action - * @return + * @param action the action to find the view pane for + * @return the first container that has the given action in it */ private IMemoryRenderingContainer getRenderingContainer(IAction action) { IMemoryRenderingContainer[] viewPanes = fMemoryView.getMemoryRenderingContainers(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingDialog.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingDialog.java index 9e57d147b..618a68b0d 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingDialog.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/AddMemoryRenderingDialog.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2010 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 @@ -525,7 +525,7 @@ public class AddMemoryRenderingDialog extends SelectionDialog { } /** - * @param currentBlock + * @param currentBlock the current memory block context */ private void populateDialog(IMemoryBlock currentBlock) { final IMemoryBlock selectMB = currentBlock; diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingCellModifier.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingCellModifier.java index 28a2f9e07..b893ef4a8 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingCellModifier.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingCellModifier.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2007 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 @@ -107,7 +107,7 @@ public class AsyncTableRenderingCellModifier implements ICellModifier { } /** - * @return + * @return the rendering addressable size */ private int getAddressableSize() { int addressableSize = fRendering.getAddressableSize(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingUpdatePolicy.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingUpdatePolicy.java index f59b9a76c..e27c07344 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingUpdatePolicy.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingUpdatePolicy.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2010 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 @@ -86,7 +86,7 @@ public class AsyncTableRenderingUpdatePolicy extends TableUpdatePolicy } /** - * @param computer + * @param computer the change computer to clear the cache for */ protected void clearCache(IContentChangeComputer computer) { if (computer != null) diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingViewer.java index 8e96efc33..a2b11f2d3 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncTableRenderingViewer.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 @@ -380,7 +380,7 @@ public class AsyncTableRenderingViewer extends AsyncVirtualContentTableViewer { /** * - * @param key + * @param key the element * @return the coordinates of the key * Element[0] is the row index * Element[1] is the column index @@ -628,9 +628,9 @@ public class AsyncTableRenderingViewer extends AsyncVirtualContentTableViewer { } /** - * Activate cell editor and prefill it with initial value. + * Activate cell editor and pre-fill it with initial value. * If initialValue is null, use cell content as initial value - * @param initialValue + * @param initialValue the initial value for the cell editor */ private void activateCellEditor(String initialValue) { @@ -729,7 +729,7 @@ public class AsyncTableRenderingViewer extends AsyncVirtualContentTableViewer { } /** - * @param event + * @param event the key event */ private void handleKeyEventInEditor(KeyEvent event) { @@ -837,7 +837,7 @@ public class AsyncTableRenderingViewer extends AsyncVirtualContentTableViewer { } /** - * @param control + * @param control the control to remove the default key listener from */ private void removeListeners(Control control) { @@ -846,10 +846,10 @@ public class AsyncTableRenderingViewer extends AsyncVirtualContentTableViewer { /** * Modify value and send new value to debug adapter - * @param row - * @param col - * @param newValue - * @throws NumberFormatException + * @param row the row + * @param col the column + * @param newValue the new value + * @throws NumberFormatException if trying to set a number value fails */ private void modifyValue(int row, int col, Object newValue) throws NumberFormatException { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncVirtualContentTableViewer.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncVirtualContentTableViewer.java index cb000c906..928d4b44e 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncVirtualContentTableViewer.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/AsyncVirtualContentTableViewer.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2007 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 @@ -154,8 +154,6 @@ abstract public class AsyncVirtualContentTableViewer extends AsynchronousTableVi /** * Attempts to update any pending setTopIndex - * - * @param reveal whether to reveal the selection */ protected synchronized void attemptSetTopIndex() { if (fPendingTopIndexKey != null) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/BasicDebugViewContentProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/BasicDebugViewContentProvider.java index e1b72a8a3..86ef0dbb5 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/BasicDebugViewContentProvider.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/memory/renderings/BasicDebugViewContentProvider.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 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 @@ -37,6 +37,7 @@ public abstract class BasicDebugViewContentProvider implements IStructuredConten /** * Returns whether this content provider has already * been disposed. + * @return if the provider is disposed */ protected boolean isDisposed() { return fDisposed; @@ -78,6 +79,7 @@ public abstract class BasicDebugViewContentProvider implements IStructuredConten /** * Refresh the given element in the viewer - must be called in UI thread. + * @param element the element to refresh in the viewer */ protected void refresh(Object element) { if (fViewer != null) { @@ -87,7 +89,7 @@ public abstract class BasicDebugViewContentProvider implements IStructuredConten /** * Handle debug events on the main thread. - * @param event + * @param event the debug event */ public void handleDebugEvent(final DebugEvent event) { if (fViewer == null) { @@ -118,6 +120,7 @@ public abstract class BasicDebugViewContentProvider implements IStructuredConten /** * Performs an update based on the event + * @param event the debug event */ protected abstract void doHandleDebugEvent(DebugEvent event); } diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractDebugView.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractDebugView.java index ab8e727f5..4a0e03cbd 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractDebugView.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractDebugView.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 @@ -368,6 +368,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi * contribute to. Subclasses must override this method. * * @param parent the parent control + * @return the new {@link Viewer} */ protected abstract Viewer createViewer(Composite parent); @@ -441,7 +442,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi * Generate a String that can be used as a key into a preference store based * on the specified action. The resulting String will be unique across * views. - * + * @param action the action to generate a key for * @return a String suitable for use as a preference store key for the given * action * @since 2.1 @@ -709,6 +710,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi * <ol> * <li><code>REMOVE_ACTION</code> when the delete * key is pressed</li> + * @param event the {@link KeyEvent} */ protected void handleKeyPressed(KeyEvent event) { if (event.character == SWT.DEL && event.stateMask == 0) { @@ -735,6 +737,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi /** * Registers the given runnable with the display * associated with this view's control, if any. + * @param r the {@link Runnable} to run * * @see org.eclipse.swt.widgets.Display#asyncExec(java.lang.Runnable) */ @@ -757,6 +760,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi /** * Registers the given runnable with the display * associated with this view's control, if any. + * @param r the {@link Runnable} to run * * @see org.eclipse.swt.widgets.Display#syncExec(java.lang.Runnable) */ @@ -769,6 +773,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi /** * Returns the memento that contains the persisted state of * the view. May be <code>null</code>. + * @return the current {@link IMemento} */ protected IMemento getMemento() { return fMemento; @@ -777,6 +782,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi /** * Sets the memento that contains the persisted state of the * view. + * @param memento the new {@link IMemento} */ protected void setMemento(IMemento memento) { fMemento = memento; @@ -981,7 +987,7 @@ public abstract class AbstractDebugView extends PageBookView implements IDebugVi /** * Returns a map of the current attribute settings in the model * presentation in this view associated with the given debug model. - * + * @param modelId the debug model identifier * @return a map of the current attribute settings in the model * presentation in this view associated with the given debug model * @since 3.0 diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java index e75331ade..c9f05cd20 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTab.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 @@ -143,7 +143,10 @@ public abstract class AbstractLaunchConfigurationTab implements ILaunchConfigura * By default, do nothing. * * @see ILaunchConfigurationTab#launched(ILaunch) - * @deprecated + * @deprecated As of R3.0, this method is no longer called by the launch + * framework. Since tabs do not exist when launching is performed elsewhere + * than the launch dialog, this method cannot be relied upon for launching + * functionality. */ public void launched(ILaunch launch) { } diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTabGroup.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTabGroup.java index defae2d5a..d1e873e1d 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTabGroup.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/AbstractLaunchConfigurationTabGroup.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 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 @@ -103,7 +103,10 @@ public abstract class AbstractLaunchConfigurationTabGroup implements ILaunchConf * By default, delegate to all of the tabs in this group. * * @see ILaunchConfigurationTabGroup#launched(ILaunch) - * @deprecated + * @deprecated As of R3.0, this method is no longer called by the launch + * framework. Since tabs do not exist when launching is performed elsewhere + * than the launch dialog, this method cannot be relied upon for launching + * functionality. */ public void launched(ILaunch launch) { ILaunchConfigurationTab[] tabs = getTabs(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/CommonTab.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/CommonTab.java index d4eadad7f..a74e76b11 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/CommonTab.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/CommonTab.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 @@ -172,6 +172,9 @@ public class CommonTab extends AbstractLaunchConfigurationTab { } /** + * Returns the {@link IDialogSettings} for the given id + * + * @param id the id of the dialog settings to get * @return the {@link IDialogSettings} to pass into the {@link ContainerSelectionDialog} * @since 3.6 */ @@ -349,7 +352,7 @@ public class CommonTab extends AbstractLaunchConfigurationTab { /** * Returns the default encoding for the specified config - * @param config + * @param config the configuration to get the encoding for * @return the default encoding * * @since 3.4 @@ -699,6 +702,7 @@ public class CommonTab extends AbstractLaunchConfigurationTab { /** * Convenience accessor + * @return the singleton {@link LaunchConfigurationManager} */ protected LaunchConfigurationManager getLaunchConfigurationManager() { return DebugUIPlugin.getDefault().getLaunchConfigurationManager(); @@ -710,6 +714,7 @@ public class CommonTab extends AbstractLaunchConfigurationTab { * NOTE: set to <code>null</code> instead of <code>false</code> for backwards compatibility * when comparing if content is equal, since 'false' is default * and will be missing for older configurations. + * @param config the configuration to update */ private void updateConfigFromFavorites(ILaunchConfigurationWorkingCopy config) { try { @@ -760,6 +765,7 @@ public class CommonTab extends AbstractLaunchConfigurationTab { /** * Convenience method for getting the workspace root. + * @return the singleton {@link IWorkspaceRoot} */ private IWorkspaceRoot getWorkspaceRoot() { return ResourcesPlugin.getWorkspace().getRoot(); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchHistoryAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchHistoryAction.java index b3b82d712..ae21582b3 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchHistoryAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchHistoryAction.java @@ -158,6 +158,7 @@ public abstract class AbstractLaunchHistoryAction implements IActionDelegate2, I * Initialize this action so that it can dynamically set its tool-tip. Also set the enabled state * of the underlying action based on whether there are any registered launch configuration types that * understand how to launch in the mode of this action. + * @param action the {@link IAction} to initialize */ private void initialize(IAction action) { getLaunchConfigurationManager().addLaunchHistoryListener(this); @@ -283,8 +284,8 @@ public abstract class AbstractLaunchHistoryAction implements IActionDelegate2, I return fMenu; } - /** - * @see org.eclipse.jface.action.IMenuCreator#getMenu(org.eclipse.swt.widgets.Menu) + /* (non-Javadoc) + * @see org.eclipse.ui.IWorkbenchWindowPulldownDelegate2#getMenu(org.eclipse.swt.widgets.Menu) */ public Menu getMenu(Menu parent) { setMenu(new Menu(parent)); @@ -368,7 +369,7 @@ public abstract class AbstractLaunchHistoryAction implements IActionDelegate2, I /** * Adds a separator to the given menu * - * @param menu + * @param menu the menu to add the separator to */ protected void addSeparator(Menu menu) { new MenuItem(menu, SWT.SEPARATOR); @@ -462,7 +463,7 @@ public abstract class AbstractLaunchHistoryAction implements IActionDelegate2, I /** * Creates an {@link ILaunchConfiguration} from the given set of {@link ILaunchConfigurationType}s - * @param types + * @param types the set of {@link String} {@link ILaunchConfigurationType} identifiers * @return a new {@link ILaunchConfiguration} * @since 3.6 */ diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchToolbarAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchToolbarAction.java index 574c6644a..78a5a0508 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchToolbarAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AbstractLaunchToolbarAction.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 @@ -62,6 +62,7 @@ public class AbstractLaunchToolbarAction extends AbstractLaunchHistoryAction { /** * Returns an action to open the launch dialog + * @return the new {@link OpenLaunchDialogAction} * @since 3.1 */ protected IAction getOpenDialogAction() { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AddMemoryRenderingActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AddMemoryRenderingActionDelegate.java index 8cf24758d..dc09c3ec7 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AddMemoryRenderingActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/AddMemoryRenderingActionDelegate.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2010 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 @@ -226,6 +226,7 @@ public class AddMemoryRenderingActionDelegate extends Action implements IViewAct /** * @param action - the action to bind with the menu and to update enablement, must not be null + * @param selection the current selection */ private void updateAction(IAction action, ISelection selection) { diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/ContextualLaunchAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/ContextualLaunchAction.java index 3a412cdc6..6c43e42fc 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/ContextualLaunchAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/ContextualLaunchAction.java @@ -279,7 +279,10 @@ public abstract class ContextualLaunchAction implements IObjectActionDelegate, I * Evaluate the enablement logic in the contextualLaunch * element description. A true result means that we should * include this shortcut in the context menu. + * @param ext the shortcut extension to get the enablement expression from + * @param context the evaluation context to use * @return true iff shortcut should appear in context menu + * @throws CoreException if an exception occurs */ private boolean isApplicable(LaunchShortcutExtension ext, IEvaluationContext context) throws CoreException { Expression expr = ext.getContextualLaunchEnablementExpression(); @@ -288,6 +291,10 @@ public abstract class ContextualLaunchAction implements IObjectActionDelegate, I /** * Add the shortcut to the context menu's launch sub-menu. + * @param mode the id of the mode + * @param ext the extension to get label and help info from + * @param menu the menu to add to + * @param accelerator the accelerator to use with the new menu item */ private void populateMenuItem(String mode, LaunchShortcutExtension ext, Menu menu, int accelerator) { LaunchShortcutAction action = new LaunchShortcutAction(mode, ext); diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandAction.java index 8ffe1c3fe..e69e1829d 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandAction.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2010 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 @@ -111,8 +111,8 @@ public abstract class DebugCommandAction extends Action implements IDebugContext /** * Executes this action on the given target object - * - * @param target the target to perform the action on + * @param targets the targets to perform the action on + * @return if the command stays enabled while the command executes */ private boolean execute(final Object[] targets) { return fUpdateService.executeCommand( diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandHandler.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandHandler.java index 5ec94d494..c209730f9 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandHandler.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/actions/DebugCommandHandler.java @@ -1,279 +1,280 @@ -/*******************************************************************************
- * Copyright (c) 2006, 2009 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:
- * Wind River Systems - initial API and implementation
- *******************************************************************************/
-
-package org.eclipse.debug.ui.actions;
-
-import java.util.Iterator;
-import java.util.Map;
-import java.util.WeakHashMap;
-
-import org.eclipse.core.commands.AbstractHandler;
-import org.eclipse.core.commands.ExecutionEvent;
-import org.eclipse.core.commands.ExecutionException;
-import org.eclipse.core.commands.HandlerEvent;
-import org.eclipse.core.expressions.IEvaluationContext;
-import org.eclipse.debug.core.IRequest;
-import org.eclipse.debug.internal.ui.commands.actions.DebugCommandService;
-import org.eclipse.debug.internal.ui.commands.actions.ICommandParticipant;
-import org.eclipse.debug.internal.ui.commands.actions.IEnabledTarget;
-import org.eclipse.debug.ui.DebugUITools;
-import org.eclipse.debug.ui.contexts.DebugContextEvent;
-import org.eclipse.debug.ui.contexts.IDebugContextListener;
-import org.eclipse.debug.ui.contexts.IDebugContextService;
-import org.eclipse.jface.viewers.ISelection;
-import org.eclipse.jface.viewers.IStructuredSelection;
-import org.eclipse.ui.ISources;
-import org.eclipse.ui.IWindowListener;
-import org.eclipse.ui.IWorkbenchWindow;
-import org.eclipse.ui.PlatformUI;
-import org.eclipse.ui.handlers.HandlerUtil;
-
-/**
- * Abstract base class for re-targeting command framework handlers, which
- * delegate execution to {@link org.eclipse.debug.core.commands.IDebugCommandHandler}
- * handlers. The specific type of <code>IDebugCommandHandler</code> is
- * determined by the abstract {@link #getCommandType()} method.
- *
- * <p> Note: This class is not an implementation of the <code>IDebugCommandHandler</code>
- * interface, which was somewhat unfortunately named. <code>IDebugCommandHandler</code>
- * is an interface that used only by the debugger plug-ins. This class implements
- * {@link org.eclipse.core.commands.IHandler} interface and is to be used with the
- * platform commands framework. </p>
- *
- * <p>
- * Clients may subclass this class.
- * </p>
- * @see org.eclipse.debug.core.commands.IDebugCommandHandler
- * @see org.eclipse.core.commands.IHandler
- *
- * @since 3.6
- */
-public abstract class DebugCommandHandler extends AbstractHandler {
-
- /**
- * The DebugCommandService is able to evaluate the command handler
- * enablement in each workbench window separately, however the workbench
- * command framework uses only a single handler instance for all windows.
- * This IEnabledTarget implementation tracks enablement of the command
- * for a given window. When the handler enablement is tested, the
- * currently active window is used to determine which enabled target
- * to use.
- */
- private class EnabledTarget implements IEnabledTarget, IDebugContextListener {
- boolean fEnabled = getInitialEnablement();
- IWorkbenchWindow fWindow;
-
- EnabledTarget(IWorkbenchWindow window) {
- fWindow = window;
- DebugCommandService.getService(fWindow).updateCommand(getCommandType(), this);
- getContextService(fWindow).addDebugContextListener(this);
- }
-
- public void setEnabled(boolean enabled) {
- boolean oldEnabled = fEnabled;
- fEnabled = enabled;
- if (fEnabled != oldEnabled && fCurrentEnabledTarget == this) {
- fireHandlerChanged(new HandlerEvent(DebugCommandHandler.this, true, false));
- }
- }
-
- public void debugContextChanged(DebugContextEvent event) {
- DebugCommandService.getService(fWindow).postUpdateCommand(getCommandType(), this);
- }
-
- void dispose() {
- if (isDisposed()) {
- return;
- }
- getContextService(fWindow).removeDebugContextListener(this);
- fWindow = null;
- }
-
- boolean isDisposed() {
- return fWindow == null;
- }
- }
-
- /**
- * Window listener is used to make sure that the handler enablement
- * is updated when the active workbench window is changed.
- */
- private IWindowListener fWindowListener = new IWindowListener() {
-
- public void windowOpened(IWorkbenchWindow w) {
- }
-
- public void windowDeactivated(IWorkbenchWindow w) {
- }
-
- public void windowClosed(IWorkbenchWindow w) {
- EnabledTarget enabledTarget = (EnabledTarget)fEnabledTargetsMap.get(w);
- if (enabledTarget != null) {
- enabledTarget.dispose();
- }
- }
-
- public void windowActivated(IWorkbenchWindow w) {
- fCurrentEnabledTarget = (EnabledTarget)fEnabledTargetsMap.get(w);
- fireHandlerChanged(new HandlerEvent(DebugCommandHandler.this, true, false));
- }
- };
-
- /**
- * Map of enabled targets keyed by workbench window.
- */
- private Map fEnabledTargetsMap = new WeakHashMap();
-
- /**
- * The current enabled target, based on the active
- * workbench window.
- */
- private EnabledTarget fCurrentEnabledTarget = null;
-
- /**
- * The constructor adds the handler as the
- */
- public DebugCommandHandler() {
- super();
- PlatformUI.getWorkbench().addWindowListener(fWindowListener);
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.core.commands.AbstractHandler#setEnabled(java.lang.Object)
- */
- public void setEnabled(Object evaluationContext) {
- // This method is called with the current evaluation context
- // just prior to the isEnabled() being called. Check the active
- // window and update the current enabled target based on it
- fCurrentEnabledTarget = null;
-
- if (!(evaluationContext instanceof IEvaluationContext)) {
- return;
- }
- IEvaluationContext context = (IEvaluationContext) evaluationContext;
- Object _window = context.getVariable(ISources.ACTIVE_WORKBENCH_WINDOW_NAME);
- if (_window instanceof IWorkbenchWindow) {
- IWorkbenchWindow window = (IWorkbenchWindow)_window;
- fCurrentEnabledTarget = getEnabledTarget(window);
- }
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.core.commands.AbstractHandler#isEnabled()
- */
- public boolean isEnabled() {
- if (fCurrentEnabledTarget == null) {
- return false;
- }
- return fCurrentEnabledTarget.fEnabled;
- }
-
- private EnabledTarget getEnabledTarget(IWorkbenchWindow window) {
- EnabledTarget target = (EnabledTarget)fEnabledTargetsMap.get(window);
- if (target == null) {
- target = new EnabledTarget(window);
- fEnabledTargetsMap.put(window, target);
- }
- return target;
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent)
- */
- public Object execute(ExecutionEvent event) throws ExecutionException {
- IWorkbenchWindow window = HandlerUtil.getActiveWorkbenchWindow(event);
- if (window == null) {
- throw new ExecutionException("No active workbench window."); //$NON-NLS-1$
- }
- fCurrentEnabledTarget = getEnabledTarget(window);
-
- ISelection selection = getContextService(window).getActiveContext();
- if (selection instanceof IStructuredSelection && isEnabled()) {
- IStructuredSelection ss = (IStructuredSelection) selection;
- boolean enabledAfterExecute = execute(window, ss.toArray());
-
- // enable/disable the action according to the command
- fCurrentEnabledTarget.setEnabled(enabledAfterExecute);
- }
-
- return null;
- }
-
- private IDebugContextService getContextService(IWorkbenchWindow window) {
- return DebugUITools.getDebugContextManager().getContextService(window);
- }
-
- /**
- * Executes this action on the given target object
- *
- * @param target the target to perform the action on
- */
- private boolean execute(IWorkbenchWindow window, final Object[] targets) {
- DebugCommandService service = DebugCommandService.getService(window);
- return service.executeCommand(
- getCommandType(), targets,
- new ICommandParticipant() {
- public void requestDone(org.eclipse.debug.core.IRequest request) {
- DebugCommandHandler.this.postExecute(request, targets);
- }
- });
- }
-
- /**
- * This method is called after the completion of the execution of this
- * command. Extending classes may override this method to perform additional
- * operation after command execution.
- *
- * @param request The completed request object which was given the the
- * debug command handler.
- * @param targets Objects which were the targets of this action
- */
- protected void postExecute(IRequest request, Object[] targets) {
- // do nothing by default
- }
-
- /**
- * Returns the {@link org.eclipse.debug.core.commands.IDebugCommandHandler}
- * command handler that type this action executes.
- *
- * @return command class.
- *
- * @see org.eclipse.debug.core.commands.IDebugCommandHandler
- */
- abstract protected Class getCommandType();
-
-
- /**
- * Returns whether this action should be enabled when initialized
- * and there is no active debug context.
- *
- * @return false, by default
- */
- protected boolean getInitialEnablement() {
- return false;
- }
-
-
- /**
- * Clean up when removing
- */
- public void dispose() {
- PlatformUI.getWorkbench().removeWindowListener(fWindowListener);
- for (Iterator itr = fEnabledTargetsMap.values().iterator(); itr.hasNext();) {
- EnabledTarget target = (EnabledTarget)itr.next();
- if (!target.isDisposed()) {
- target.dispose();
- }
- }
- fEnabledTargetsMap.clear();
- fCurrentEnabledTarget = null;
- }
-}
+/******************************************************************************* + * 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 + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Wind River Systems - initial API and implementation + *******************************************************************************/ + +package org.eclipse.debug.ui.actions; + +import java.util.Iterator; +import java.util.Map; +import java.util.WeakHashMap; + +import org.eclipse.core.commands.AbstractHandler; +import org.eclipse.core.commands.ExecutionEvent; +import org.eclipse.core.commands.ExecutionException; +import org.eclipse.core.commands.HandlerEvent; +import org.eclipse.core.expressions.IEvaluationContext; +import org.eclipse.debug.core.IRequest; +import org.eclipse.debug.internal.ui.commands.actions.DebugCommandService; +import org.eclipse.debug.internal.ui.commands.actions.ICommandParticipant; +import org.eclipse.debug.internal.ui.commands.actions.IEnabledTarget; +import org.eclipse.debug.ui.DebugUITools; +import org.eclipse.debug.ui.contexts.DebugContextEvent; +import org.eclipse.debug.ui.contexts.IDebugContextListener; +import org.eclipse.debug.ui.contexts.IDebugContextService; +import org.eclipse.jface.viewers.ISelection; +import org.eclipse.jface.viewers.IStructuredSelection; +import org.eclipse.ui.ISources; +import org.eclipse.ui.IWindowListener; +import org.eclipse.ui.IWorkbenchWindow; +import org.eclipse.ui.PlatformUI; +import org.eclipse.ui.handlers.HandlerUtil; + +/** + * Abstract base class for re-targeting command framework handlers, which + * delegate execution to {@link org.eclipse.debug.core.commands.IDebugCommandHandler} + * handlers. The specific type of <code>IDebugCommandHandler</code> is + * determined by the abstract {@link #getCommandType()} method. + * + * <p> Note: This class is not an implementation of the <code>IDebugCommandHandler</code> + * interface, which was somewhat unfortunately named. <code>IDebugCommandHandler</code> + * is an interface that used only by the debugger plug-ins. This class implements + * {@link org.eclipse.core.commands.IHandler} interface and is to be used with the + * platform commands framework. </p> + * + * <p> + * Clients may subclass this class. + * </p> + * @see org.eclipse.debug.core.commands.IDebugCommandHandler + * @see org.eclipse.core.commands.IHandler + * + * @since 3.6 + */ +public abstract class DebugCommandHandler extends AbstractHandler { + + /** + * The DebugCommandService is able to evaluate the command handler + * enablement in each workbench window separately, however the workbench + * command framework uses only a single handler instance for all windows. + * This IEnabledTarget implementation tracks enablement of the command + * for a given window. When the handler enablement is tested, the + * currently active window is used to determine which enabled target + * to use. + */ + private class EnabledTarget implements IEnabledTarget, IDebugContextListener { + boolean fEnabled = getInitialEnablement(); + IWorkbenchWindow fWindow; + + EnabledTarget(IWorkbenchWindow window) { + fWindow = window; + DebugCommandService.getService(fWindow).updateCommand(getCommandType(), this); + getContextService(fWindow).addDebugContextListener(this); + } + + public void setEnabled(boolean enabled) { + boolean oldEnabled = fEnabled; + fEnabled = enabled; + if (fEnabled != oldEnabled && fCurrentEnabledTarget == this) { + fireHandlerChanged(new HandlerEvent(DebugCommandHandler.this, true, false)); + } + } + + public void debugContextChanged(DebugContextEvent event) { + DebugCommandService.getService(fWindow).postUpdateCommand(getCommandType(), this); + } + + void dispose() { + if (isDisposed()) { + return; + } + getContextService(fWindow).removeDebugContextListener(this); + fWindow = null; + } + + boolean isDisposed() { + return fWindow == null; + } + } + + /** + * Window listener is used to make sure that the handler enablement + * is updated when the active workbench window is changed. + */ + private IWindowListener fWindowListener = new IWindowListener() { + + public void windowOpened(IWorkbenchWindow w) { + } + + public void windowDeactivated(IWorkbenchWindow w) { + } + + public void windowClosed(IWorkbenchWindow w) { + EnabledTarget enabledTarget = (EnabledTarget)fEnabledTargetsMap.get(w); + if (enabledTarget != null) { + enabledTarget.dispose(); + } + } + + public void windowActivated(IWorkbenchWindow w) { + fCurrentEnabledTarget = (EnabledTarget)fEnabledTargetsMap.get(w); + fireHandlerChanged(new HandlerEvent(DebugCommandHandler.this, true, false)); + } + }; + + /** + * Map of enabled targets keyed by workbench window. + */ + private Map fEnabledTargetsMap = new WeakHashMap(); + + /** + * The current enabled target, based on the active + * workbench window. + */ + private EnabledTarget fCurrentEnabledTarget = null; + + /** + * The constructor adds the handler as the + */ + public DebugCommandHandler() { + super(); + PlatformUI.getWorkbench().addWindowListener(fWindowListener); + } + + /* (non-Javadoc) + * @see org.eclipse.core.commands.AbstractHandler#setEnabled(java.lang.Object) + */ + public void setEnabled(Object evaluationContext) { + // This method is called with the current evaluation context + // just prior to the isEnabled() being called. Check the active + // window and update the current enabled target based on it + fCurrentEnabledTarget = null; + + if (!(evaluationContext instanceof IEvaluationContext)) { + return; + } + IEvaluationContext context = (IEvaluationContext) evaluationContext; + Object _window = context.getVariable(ISources.ACTIVE_WORKBENCH_WINDOW_NAME); + if (_window instanceof IWorkbenchWindow) { + IWorkbenchWindow window = (IWorkbenchWindow)_window; + fCurrentEnabledTarget = getEnabledTarget(window); + } + } + + /* (non-Javadoc) + * @see org.eclipse.core.commands.AbstractHandler#isEnabled() + */ + public boolean isEnabled() { + if (fCurrentEnabledTarget == null) { + return false; + } + return fCurrentEnabledTarget.fEnabled; + } + + private EnabledTarget getEnabledTarget(IWorkbenchWindow window) { + EnabledTarget target = (EnabledTarget)fEnabledTargetsMap.get(window); + if (target == null) { + target = new EnabledTarget(window); + fEnabledTargetsMap.put(window, target); + } + return target; + } + + /* (non-Javadoc) + * @see org.eclipse.core.commands.AbstractHandler#execute(org.eclipse.core.commands.ExecutionEvent) + */ + public Object execute(ExecutionEvent event) throws ExecutionException { + IWorkbenchWindow window = HandlerUtil.getActiveWorkbenchWindow(event); + if (window == null) { + throw new ExecutionException("No active workbench window."); //$NON-NLS-1$ + } + fCurrentEnabledTarget = getEnabledTarget(window); + + ISelection selection = getContextService(window).getActiveContext(); + if (selection instanceof IStructuredSelection && isEnabled()) { + IStructuredSelection ss = (IStructuredSelection) selection; + boolean enabledAfterExecute = execute(window, ss.toArray()); + + // enable/disable the action according to the command + fCurrentEnabledTarget.setEnabled(enabledAfterExecute); + } + + return null; + } + + private IDebugContextService getContextService(IWorkbenchWindow window) { + return DebugUITools.getDebugContextManager().getContextService(window); + } + + /** + * Executes this action on the given target objects + * @param window the window + * @param targets the targets to execute this action on + * @return if the command stays enabled while the command executes + */ + private boolean execute(IWorkbenchWindow window, final Object[] targets) { + DebugCommandService service = DebugCommandService.getService(window); + return service.executeCommand( + getCommandType(), targets, + new ICommandParticipant() { + public void requestDone(org.eclipse.debug.core.IRequest request) { + DebugCommandHandler.this.postExecute(request, targets); + } + }); + } + + /** + * This method is called after the completion of the execution of this + * command. Extending classes may override this method to perform additional + * operation after command execution. + * + * @param request The completed request object which was given the the + * debug command handler. + * @param targets Objects which were the targets of this action + */ + protected void postExecute(IRequest request, Object[] targets) { + // do nothing by default + } + + /** + * Returns the {@link org.eclipse.debug.core.commands.IDebugCommandHandler} + * command handler that type this action executes. + * + * @return command class. + * + * @see org.eclipse.debug.core.commands.IDebugCommandHandler + */ + abstract protected Class getCommandType(); + + + /** + * Returns whether this action should be enabled when initialized + * and there is no active debug context. + * + * @return false, by default + */ + protected boolean getInitialEnablement() { + return false; + } + + + /** + * Clean up when removing + */ + public void dispose() { + PlatformUI.getWorkbench().removeWindowListener(fWindowListener); + for (Iterator itr = fEnabledTargetsMap.values().iterator(); itr.hasNext();) { + EnabledTarget target = (EnabledTarget)itr.next(); + if (!target.isDisposed()) { + target.dispose(); + } + } + fEnabledTargetsMap.clear(); + fCurrentEnabledTarget = null; + } +} diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/memory/AbstractTableRendering.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/memory/AbstractTableRendering.java index 8d7399f63..b46a29be9 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/memory/AbstractTableRendering.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/memory/AbstractTableRendering.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2010 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 @@ -487,7 +487,8 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Handle top visible address change event from synchronizer - * @param address + * @param address the address + * @param force if the notification should be forced */ private void topVisibleAddressChanged(final BigInteger address, boolean force) { @@ -510,7 +511,6 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering updateSyncTopAddress(); if (getMemoryBlock() instanceof IMemoryBlockExtension) { - handleTopAddressChangedforExtended(address); } else @@ -521,7 +521,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param address + * @param address the address */ private void handleTopAddressChangedForSimple(final BigInteger address) { // IMemoryBlock support @@ -540,7 +540,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param address + * @param address the address */ private void handleTopAddressChangedforExtended(final BigInteger address) { @@ -605,7 +605,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param value + * @param value the new value */ private void selectedAddressChanged(BigInteger value) { @@ -1284,7 +1284,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Calculate selected address based on cursor's current position - * @param cursor + * @param cursor the cursor * @return the selected address */ private BigInteger getSelectedAddressFromCursor(TableCursor cursor) @@ -1321,7 +1321,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Sets the cursor at the specified address - * @param address + * @param address the address * @return true if successful, false otherwise */ private boolean setCursorAtAddress(BigInteger address) @@ -1537,7 +1537,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering * Create the error page for this rendering. * The error page is used to report any error resulted from * getting memory from a memory block. - * @param parent + * @param parent the parent composite */ private void createErrorPage(Composite parent) { @@ -1647,9 +1647,9 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param table - * @param height - * @return + * @param table the table + * @param height the current height of the table + * @return the number of visible lines in the table */ private int doGetNumberOfVisibleLines(Table table, int height) { // height of border @@ -2265,6 +2265,8 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Returns this rendering's table viewer. + * + * @return the {@link TableViewer} */ public TableViewer getTableViewer() { @@ -2449,7 +2451,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Check if address provided is out of buffered range - * @param address + * @param address the address * @return if address is out of buffered range */ private boolean isAddressOutOfRange(BigInteger address) @@ -2459,7 +2461,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Check if address is visible - * @param address + * @param address the address * @return if the given address is visible */ private boolean isAddressVisible(BigInteger address) @@ -2505,7 +2507,6 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Handle scrolling and reload table if necessary - * @param event */ private synchronized void handleScrollBarSelection() { @@ -2701,7 +2702,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Handle column size changed event from synchronizer - * @param newColumnSize + * @param newColumnSize the new column size */ private void columnSizeChanged(final int newColumnSize) { // ignore event if view tab is disabled @@ -2750,7 +2751,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Activate cell editor and pre-fill it with initial value. * If initialValue is null, use cell content as initial value - * @param initialValue + * @param initialValue the initial value to edit */ private void activateCellEditor(String initialValue) { @@ -2839,7 +2840,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param text + * @param text the {@link Text} widget to add the listeners to */ private void addListeners(Text text) { fEditorFocusListener = new FocusAdapter() { @@ -2860,7 +2861,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param text + * @param text the {@link Text} widget to remove the listeners from */ private void removeListeners(Text text) { @@ -2906,7 +2907,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param event + * @param event the {@link KeyEvent} */ private void handleKeyEventInEditor(KeyEvent event) { final KeyEvent e = event; @@ -3058,10 +3059,10 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Modify value and send new value to debug adapter - * @param row - * @param col - * @param newValue - * @throws NumberFormatException + * @param row the row + * @param col the column + * @param newValue the new value + * @throws NumberFormatException if the {@link ICellModifier} cannot convert the new value to a string - in cases where it needs to do so */ private void modifyValue(int row, int col, String newValue) throws NumberFormatException { @@ -3151,7 +3152,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering * The cursor will be moved to the base address of the memory block. * The table will be positioned to have the base address * at the top. - * @throws DebugException + * @throws DebugException is an exception occurs */ private void resetToBaseAddress() throws DebugException { @@ -3586,7 +3587,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering * table item if SWT.FULL_SELECTION is not on when the table is created. * Created the following function to work around the problem. * We can remove this method when the bug is fixed. - * @param point + * @param point the {@link Point} to get the {@link TableItem} from * @return the table item where the point is located, return null if the item cannot be located. */ private TableItem getItem(Point point) @@ -3606,7 +3607,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering /** * Method for figuring out which column the point is located. - * @param point + * @param point the {@link Point} to et the column number for * @return the column index where the point is located, return -1 if column is not found. */ private int getColumn(Point point) { @@ -3730,7 +3731,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param modelId + * @param modelId the debug model identifier * @return default number of addressable units per line for the model */ private int getDefaultRowSizeByModel(String modelId) @@ -3747,7 +3748,7 @@ public abstract class AbstractTableRendering extends AbstractBaseTableRendering } /** - * @param modelId + * @param modelId the debug model identifier * @return default number of addressable units per column for the model */ private int getDefaultColumnSizeByModel(String modelId) |