Bug 92518 - [Dialogs] Removing sections from DialogSettings

Add the ability to remove the section by name.

2 files changed, 47 insertions, 6 deletions

diff --git a/bundles/org.eclipse.jface/src/org/eclipse/jface/dialogs/DialogSettings.java b/bundles/org.eclipse.jface/src/org/eclipse/jface/dialogs/DialogSettings.java
index da55f28153e..381ab94165a 100644
--- a/bundles/org.eclipse.jface/src/org/eclipse/jface/dialogs/DialogSettings.java
+++ b/bundles/org.eclipse.jface/src/org/eclipse/jface/dialogs/DialogSettings.java
@@ -129,14 +129,30 @@ public class DialogSettings implements IDialogSettings {
     }
 
     /**
-	 * Remove a section in the receiver. If the given section does not exist, nothing is done.  
+	 * Remove a section in the receiver. If the given section does not exist,
+	 * nothing is done.
 	 * 
 	 * @param section
-	 *            the section to be removed
-     * @since 3.9
+	 *            the section to be removed. Must not be <code>null</code>.
+	 * @since 3.9
 	 */
 	public void removeSection(IDialogSettings section) {
-		sections.remove(section.getName());
+		if (sections.get(section.getName()) == section) {
+			sections.remove(section.getName());
+		}
+	}
+
+    /**
+	 * Remove a section by name in the receiver. If the given section does not
+	 * exist, nothing is done.
+	 * 
+	 * @param sectionName
+	 *            the name of the section to be removed.  Must not be <code>null</code>.
+     * @return The dialog section removed, or <code>null</code> if it wasn't there.
+	 * @since 3.9
+	 */
+	public IDialogSettings removeSection(String sectionName) {
+		return (IDialogSettings) sections.remove(sectionName);
 	}
 
 	/* (non-Javadoc)
diff --git a/tests/org.eclipse.ui.tests/Eclipse JFace Tests/org/eclipse/jface/tests/dialogs/DialogSettingsTest.java b/tests/org.eclipse.ui.tests/Eclipse JFace Tests/org/eclipse/jface/tests/dialogs/DialogSettingsTest.java
index 2f893e5da32..da0a04d0425 100644
--- a/tests/org.eclipse.ui.tests/Eclipse JFace Tests/org/eclipse/jface/tests/dialogs/DialogSettingsTest.java
+++ b/tests/org.eclipse.ui.tests/Eclipse JFace Tests/org/eclipse/jface/tests/dialogs/DialogSettingsTest.java
@@ -155,26 +155,51 @@ public class DialogSettingsTest extends TestCase {
 	public void testRemoveSection() {
 		DialogSettings dialogSettings = new DialogSettings(null);
 		IDialogSettings section = dialogSettings.addNewSection("new-section");
+		assertEquals(1, dialogSettings.getSections().length);
 
 		dialogSettings.removeSection(section);
 
 		assertEquals(0, dialogSettings.getSections().length);
 	}
 
+	public void testRemoveSectionByName() {
+		DialogSettings dialogSettings = new DialogSettings(null);
+		IDialogSettings section = dialogSettings.addNewSection("new-section");
+		assertEquals(1, dialogSettings.getSections().length);
+
+		final IDialogSettings removedSection = dialogSettings.removeSection("new-section");
+
+		assertEquals(0, dialogSettings.getSections().length);
+		assertEquals(section, removedSection);
+	}
+
 	public void testRemoveNonExistingSection() {
 		DialogSettings dialogSettings = new DialogSettings(null);
+		dialogSettings.addNewSection("new-section");
+		assertEquals(1, dialogSettings.getSections().length);
 		IDialogSettings otherSection = new DialogSettings(null);
 
 		dialogSettings.removeSection(otherSection);
 
-		assertEquals(0, dialogSettings.getSections().length);
+		assertEquals(1, dialogSettings.getSections().length);
+	}
+	
+	public void testRemoveOtherSection() {
+		DialogSettings dialogSettings = new DialogSettings(null);
+		dialogSettings.addNewSection("new-section");
+		assertEquals(1, dialogSettings.getSections().length);
+		IDialogSettings otherSection = new DialogSettings("new-section");
+
+		dialogSettings.removeSection(otherSection);
+
+		assertEquals(1, dialogSettings.getSections().length);
 	}
 	
 	public void testRemoveSectionWithNullArgument() {
 		DialogSettings dialogSettings = new DialogSettings(null);
 
 		try {
-			dialogSettings.removeSection(null);
+			dialogSettings.removeSection((IDialogSettings)null);
 		} catch (NullPointerException expected) {
 		}
 	}