Move `ScopedPreferenceStore` to `org.eclipse.jface` #4262 by ptziegler · Pull Request #4270 · eclipse-platform/eclipse.platform.ui

ptziegler · 2026-08-21T17:40:08Z

The IPreferenceStore interface has two public implementations; A JFace PreferenceStore based on *.properties files and an Eclipse 3.x ScopedPreferenceStore based on *.prefs files. Consumers who want to use scoped preferences therefore always carry a direct dependency to the 3.x framework, rendering this interface unusable in a pure 4.x application.

Consumers currently have to fall back to the IEclipsePreferences interface, which is not a drop-in replacement, however, due to a different behavior when it comes to e.g. default values.

Because the ScopedPreferenceStore doesn't depend on any 3.x-specific functionality, it can be easily moved to the JFace component. The dependency to the Eclipse Runtime bundle can be reduced to the Equinox Preferences bundle by inlining the call to IPreferenceService.get.

Note that this change has to be split up into two commits; One where the ScopedPreferenceStore is moved and one where a dummy implementation is added to the Eclipse Workbench bundle. Otherwise Git is unable to detect the class as being moved to the JFace component and thus doesn't carry over the file history.

Contributes to #4262

…4262 The `IPreferenceStore` interface has two public implementations; A JFace `PreferenceStore` based on _*.properties_ files and an Eclipse 3.x `ScopedPreferenceStore` based on _*.prefs_ files. Consumers who want to use scoped preferences therefore always carry a direct dependency to the 3.x framework, rendering this interface unusable in a pure 4.x application. Consumers currently have to fall back to the `IEclipsePreferences` interface, which is not a drop-in replacement, however, due to a different behavior when it comes to e.g. default values. Because the `ScopedPreferenceStore` doesn't depend on any 3.x-specific functionality, it can be easily moved to the JFace component. The dependency to the Eclipse Runtime bundle can be reduced to the Equinox Preferences bundle by inlining the call to `IPreferenceService.get`. Note that this change has to be split up into two commits; One where the `ScopedPreferenceStore` is moved and one where a dummy implementation is added to the Eclipse Workbench bundle. Otherwise Git is unable to detect the class as being moved to the JFace component and thus doesn't carry over the file history. Contributes to eclipse-platform#4262

…ipse-platform#4262 This adds the `ScopedPreferenceStore` back to the Platform Workbench bundle to restore backwards compatibility. Note that this is done in a separate commit, to make sure that the history of this class now resides with the preference store that has been moved to the JFace component. Closes eclipse-platform#4262

ptziegler · 2026-08-21T17:40:20Z

@vogella

eclipse-platform-bot · 2026-08-21T17:45:25Z

This pull request changes some projects for the first time in this development cycle.
Therefore the following files need a version increment:

bundles/org.eclipse.ui.genericeditor/META-INF/MANIFEST.MF

An additional commit containing all the necessary changes was pushed to the top of this PR's branch. To obtain these changes (for example if you want to push more changes) either fetch from your fork or apply the git patch.

Git patch

From 56d1009c3ae5418002fd4c7340a15bc7c960a8fa Mon Sep 17 00:00:00 2001
From: Eclipse Platform Bot <platform-bot@eclipse.org>
Date: Fri, 21 Aug 2026 17:45:04 +0000
Subject: [PATCH] Version bump(s) for 4.41 stream


diff --git a/bundles/org.eclipse.ui.genericeditor/META-INF/MANIFEST.MF b/bundles/org.eclipse.ui.genericeditor/META-INF/MANIFEST.MF
index cf09678b4e..f28fe7c793 100644
--- a/bundles/org.eclipse.ui.genericeditor/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.ui.genericeditor/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-SymbolicName: org.eclipse.ui.genericeditor;singleton:=true
-Bundle-Version: 1.4.100.qualifier
+Bundle-Version: 1.4.200.qualifier
 Bundle-Vendor: %Bundle-Vendor
 Bundle-RequiredExecutionEnvironment: JavaSE-21
 Require-Bundle: org.eclipse.ui.workbench.texteditor;bundle-version="3.10.0",
-- 
2.55.0

Further information are available in Common Build Issues - Missing version increments.

Copilot

Pull request overview

Moves scoped preference storage into JFace, reducing reliance on the Eclipse 3.x workbench.

Changes:

Adds the JFace ScopedPreferenceStore and Equinox Preferences dependency.
Retains a compatibility wrapper and migrates internal consumers.
Moves and modernizes the associated tests.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`PreferencesTestSuite.java`	Removes relocated test.
`ScopedPreferenceStoreTest.java`	Moves test to JFace and JUnit 5.
`AllPrefsTests.java`	Registers relocated test.
Workbench `ScopedPreferenceStore.java`	Adds compatibility wrapper.
`AbstractUIPlugin.java`	Uses JFace implementation.
`PlatformUI.java`	Uses JFace implementation.
`WorkbenchMessages.java`	Removes migrated message field.
Workbench `messages.properties`	Removes migrated message.
`ViewsPreferencePage.java`	Migrates preference-store import.
`WorkbenchChainedTextFontFieldEditor.java`	Migrates preference-store import.
`IDEWorkspacePreferencePage.java`	Migrates preference-store import.
`ChooseWorkspaceData.java`	Migrates preference-store import.
`IDEApplication.java`	Migrates preference-store import.
`GenericEditorPreferencePage.java`	Migrates preference-store type checks.
Generic Editor `MANIFEST.MF`	Increments bundle version.
`TextEditorPreferencePage.java`	Migrates preference-store import.
JFace `ScopedPreferenceStore.java`	Adds scoped preference implementation.
JFace `messages.properties`	Adds validation message.
JFace `MANIFEST.MF`	Adds Equinox Preferences dependency.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+ * @see org.eclipse.core.runtime.preferences
+ * @since 3.40
+ */
+public class ScopedPreferenceStore extends EventManager implements IPersistentPreferenceStore {


+	 * @param includeDefault <code>true</code> if the default context should be
+	 *                       included and <code>false</code> otherwise
+	 * @return IEclipsePreferences[]
+	 * @since 3.4 public, was added in 3.1 as private method


+	 *                       and {@code true} otherwise
+	 * @return String or <code>null</code> if the value does not exist.
+	 */
+	private String internalGet(String key, boolean includeDefault) {


github-actions · 2026-08-21T18:23:22Z

Test Results

858 files ±0 858 suites ±0 53m 18s ⏱️ + 2m 45s
8 172 tests ±0 7 929 ✅ +1 243 💤 ±0 0 ❌ ±0
20 421 runs +3 19 765 ✅ +4 656 💤 ±0 0 ❌ ±0

Results for commit f52f4de. ± Comparison against base commit 5b3e6dd.

This pull request removes 2 and adds 2 tests. Note that renamed tests count towards both.

org.eclipse.ui.tests.preferences.ScopedPreferenceStoreTestCase ‑ testNeedsSaving
org.eclipse.ui.tests.preferences.ScopedPreferenceStoreTestCase ‑ testRestoreDefaults

org.eclipse.jface.tests.preferences.ScopedPreferenceStoreTest ‑ testNeedsSaving
org.eclipse.jface.tests.preferences.ScopedPreferenceStoreTest ‑ testRestoreDefaults

vogella · 2026-08-22T05:01:00Z

Thanks, @ptziegler

I would leave 'AbstractUIPlugin.getPreferenceStore()' and 'PlatformUI.getPreferenceStore()' returning the old type for now to avoid class cast exceptions in client code which are casting to it.

I also suggest to Deprecate the old type and mark it for deletion. After the deprecation has been around for at least a milestone we could IMHO change 'AbstractUIPlugin.getPreferenceStore()' and 'PlatformUI.getPreferenceStore()' but I would not do this immediately without warning to consumer.

laeubi

I would fetching the IPreferencesService through org.eclipse.core.internal.preferences.PreferencesService.getDefault() - this is actually internal API but I think in this case acceptable (and we already have other references in platform) and we likely never will change this anyways and would prevent us to duplicate the implementation. Alternatively we could add a method IPreferencesService.get() at Equinox side.

As a nit-pick, the IPreferenceStore javadoc should be updated as it currently mentions only PreferenceStore as the only implementation.

laeubi · 2026-08-22T05:40:30Z

 import org.eclipse.jface.dialogs.IDialogSettings;
 import org.eclipse.jface.dialogs.IDialogSettingsProvider;
 import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.preference.ScopedPreferenceStore;


I would also retain the old implementation here.

Instead we should add a static method ScopedPreferenceStore#instance(String id) that return new ScopedPreferenceStore(InstanceScope.INSTANCE, id); and mention it in the javadoc of getPreferenceStore as an alternative for consumer not wanting to use an activator.

To make it even more convenient we could additionally add ScopedPreferenceStore#instance(Class<?> context) and use FrameworkUtil#getBundle to a story from the bundle ID itself (the most common case).

laeubi · 2026-08-22T05:45:18Z

 org.eclipse.equinox.common;bundle-version="[3.18.0,4.0.0)",
- org.eclipse.equinox.bidi;bundle-version="[0.10.0,2.0.0)";resolution:=optional
+ org.eclipse.equinox.bidi;bundle-version="[0.10.0,2.0.0)";resolution:=optional,
+ org.eclipse.equinox.preferences;bundle-version="[3.12.100,4.0.0)"


As ScopedPreferenceStore is the only consumer we can make this optional, even though I generally try to avoid this, it would not introduce any new dependency.

If preferences does not contain a split package, an import-package might be more suitable here.

ptziegler added 2 commits August 21, 2026 19:39

ptziegler added the Planned for 4.42 label Aug 21, 2026

Version bump(s) for 4.41 stream

f52f4de

iloveeclipse requested a balanced review from Copilot August 21, 2026 17:50

Copilot started reviewing on behalf of iloveeclipse August 21, 2026 17:50 View session

Copilot AI reviewed Aug 21, 2026

View reviewed changes

laeubi approved these changes Aug 22, 2026

View reviewed changes

Navigation Menu

Uh oh!

Move `ScopedPreferenceStore` to `org.eclipse.jface` #4262 - #4270

Move `ScopedPreferenceStore` to `org.eclipse.jface` #4262#4270
ptziegler wants to merge 3 commits into
eclipse-platform:masterfrom
ptziegler:issue4262

ptziegler commented Aug 21, 2026

Uh oh!

ptziegler commented Aug 21, 2026

Uh oh!

eclipse-platform-bot commented Aug 21, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Aug 21, 2026

Uh oh!

vogella commented Aug 22, 2026

Uh oh!

laeubi left a comment

Uh oh!

laeubi Aug 22, 2026

Uh oh!

laeubi Aug 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

ptziegler commented Aug 21, 2026

Uh oh!

ptziegler commented Aug 21, 2026

Uh oh!

eclipse-platform-bot commented Aug 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions Bot commented Aug 21, 2026

Test Results

Uh oh!

vogella commented Aug 22, 2026

Uh oh!

laeubi left a comment

Choose a reason for hiding this comment

Uh oh!

laeubi Aug 22, 2026

Choose a reason for hiding this comment

Uh oh!

laeubi Aug 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants