From 4bd04cbdfc82cbb3b2625e76f075d35df3a1dfd6 Mon Sep 17 00:00:00 2001 From: Andrew Gvozdev Date: Tue, 1 Nov 2011 23:15:46 -0400 Subject: [PATCH] Some cleanup --- .../LanguageSettingsListenersTests.java | 2 -- .../providers/LanguageSettingsManagerTests.java | 2 +- .../providers/LanguageSettingsSerializable.java | 17 ++++------------- .../ILanguageSettingsChangeListener.java | 8 ++++++-- .../LanguageSettingsProvidersSerializer.java | 4 ++++ .../model/CConfigurationSpecSettings.java | 2 +- .../pdom/LanguageSettingsChangeListener.java | 6 ++---- .../cdt/internal/core/pdom/PDOMManager.java | 1 - 8 files changed, 18 insertions(+), 24 deletions(-) diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java index d5d73f56cb3..3add223b0b4 100644 --- a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java @@ -1041,7 +1041,5 @@ public class LanguageSettingsListenersTests extends TestCase { assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); } } - } - diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java index 243252ea99c..9f9e45b0bac 100644 --- a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java @@ -41,7 +41,7 @@ import org.eclipse.core.runtime.Path; * Test cases testing LanguageSettingsProvider functionality */ public class LanguageSettingsManagerTests extends TestCase { - // Should match id of extension point defined in plugin.xml + // Those should match ids of plugin extensions defined in plugin.xml private static final String EXTENSION_BASE_PROVIDER_ID = "org.eclipse.cdt.core.tests.language.settings.base.provider"; private static final String EXTENSION_EDITABLE_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.editable.language.settings.provider"; private static final String EXTENSION_EDITABLE_PROVIDER_NAME = "Test Plugin Mock Editable Language Settings Provider"; diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java index 5c5a31b25b6..3437ccd30c7 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java @@ -13,14 +13,9 @@ package org.eclipse.cdt.core.language.settings.providers; import java.util.ArrayList; import java.util.List; -import java.util.Map; -import java.util.Map.Entry; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; -import org.eclipse.cdt.core.settings.model.ICSettingEntry; -import org.eclipse.cdt.core.settings.model.util.CDataUtil; -import org.eclipse.cdt.core.settings.model.util.LanguageSettingEntriesSerializer; import org.eclipse.cdt.internal.core.XmlUtil; import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsStorage; import org.eclipse.core.resources.IResource; @@ -166,19 +161,15 @@ public class LanguageSettingsSerializable extends LanguageSettingsBaseProvider { public void setSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId, List entries) { String rcProjectPath = rc!=null ? rc.getProjectRelativePath().toString() : null; fStorage.setSettingEntries(rcProjectPath, languageId, entries); - -// // TODO - not sure what is more efficient, to do that or not to do that? -// if (fStorage.equals(lastPersistedState)) { -// lastPersistedState = null; -// } } /** * {@inheritDoc} - *
Note that this list is unmodifiable. To modify the list copy it, change and use + *
+ * Note that this list is unmodifiable. To modify the list copy it, change and use * {@link #setSettingEntries(ICConfigurationDescription, IResource, String, List)}. - * - *
Note also that you can compare these lists with simple equality operator ==, + *
+ * Note also that you can compare these lists with simple equality operator ==, * as lists themselves are backed by WeakHashSet> where * identical copies (deep comparison is used) are replaced with the same one instance. */ diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java index 9b54debd6ef..3e0ae4d1a3b 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java @@ -11,12 +11,16 @@ package org.eclipse.cdt.internal.core.language.settings.providers; /** - * Listens to changes in language settings. + * An interface for listeners to changes in language settings. + * + * @see LanguageSettingsProvidersSerializer#registerLanguageSettingsChangeListener(ILanguageSettingsChangeListener) + * @see LanguageSettingsProvidersSerializer#unregisterLanguageSettingsChangeListener(ILanguageSettingsChangeListener) */ public interface ILanguageSettingsChangeListener { /** * Indicates that language settings have been changed. - * @param event + * + * @param event - details of the event. */ public void handleEvent(ILanguageSettingsChangeEvent event); } \ No newline at end of file diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java index 61465c6d0c7..fc227899852 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java @@ -174,6 +174,10 @@ public class LanguageSettingsProvidersSerializer { } } + /** + * Language Settings Change Event implementation. + * + */ private static class LanguageSettingsChangeEvent implements ILanguageSettingsChangeEvent { private String projectName = null; private Map deltaMap = new HashMap(); diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java index 8c5e1968f3f..8fb4729a924 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java @@ -1023,7 +1023,7 @@ public class CConfigurationSpecSettings implements ICSettingsStorage{ } /** - * Returns delta and atomically updates last persisted state to the new state. + * Returns delta and updates last persisted state to the new state. * That implies that the delta needs to be used to fire an event of it will * be lost. */ diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java index a3496768e61..67ccc3f082f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java @@ -20,10 +20,9 @@ import org.eclipse.core.resources.IWorkspaceRoot; import org.eclipse.core.resources.ResourcesPlugin; /** - * This class handles changes in language settings for the PDOM by reindexing the appropriate resources. + * This class handles changes in language settings for the PDOM. */ public class LanguageSettingsChangeListener implements ILanguageSettingsChangeListener { - private PDOMManager fManager; public LanguageSettingsChangeListener(PDOMManager manager) { @@ -31,9 +30,8 @@ public class LanguageSettingsChangeListener implements ILanguageSettingsChangeLi } public void handleEvent(ILanguageSettingsChangeEvent event) { - String projectName = event.getProjectName(); IWorkspaceRoot wspRoot = ResourcesPlugin.getWorkspace().getRoot(); - IProject project = wspRoot.getProject(projectName); + IProject project = wspRoot.getProject(event.getProjectName()); if (project != null) { ICProjectDescription prjDescription = CCorePlugin.getDefault().getProjectDescription(project); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java index ee646d5b969..12dd4253ad5 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java @@ -60,7 +60,6 @@ import org.eclipse.cdt.core.model.ITranslationUnit; import org.eclipse.cdt.core.model.LanguageManager; import org.eclipse.cdt.core.settings.model.CProjectDescriptionEvent; import org.eclipse.cdt.core.settings.model.ICProjectDescriptionListener; -import org.eclipse.cdt.core.settings.model.util.LanguageSettingEntriesSerializer; import org.eclipse.cdt.internal.core.CCoreInternals; import org.eclipse.cdt.internal.core.index.IIndexFragment; import org.eclipse.cdt.internal.core.index.IWritableIndex;