Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 315463

Summary:	API package name cleanup
Product:	[Eclipse Project] e4	Reporter:	John Arthorne <john.arthorne>
Component:	UI	Assignee:	Project Inbox <e4.ui-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	gheorghe, ob1.eclipse
Version:	1.0
Target Milestone:	1.0 RC0
Hardware:	PC
OS:	Windows XP
Whiteboard:

Description John Arthorne

2010-06-02 15:27:10 EDT

I intend to use this bug to track cleanup of API package names. We won't have any real API in this release, but our package names should reflect anticipated final package names to avoid unnecessary churn for early adopters who use the provisional API in 1.0.

Comment 1 John Arthorne

2010-06-02 15:39:29 EDT

The first candidates are the bundles in the org.eclipse.e4.ui.workbench.* bundles. Current packages:

org.eclipse.e4.ui.internal.workbench.handlers
org.eclipse.e4.workbench.modeling
org.eclipse.e4.workbench.ui
org.eclipse.e4.workbench.ui.behaviors
org.eclipse.e4.workbench.ui.internal
org.eclipse.e4.ui.workbench.addons
org.eclipse.e4.workbench
org.eclipse.e4.workbench.ui.renderers.swt
org.eclipse.e4.ui.internal.workbench.swt.handlers
org.eclipse.e4.ui.workbench.swt
org.eclipse.e4.ui.workbench.swt.factories
org.eclipse.e4.ui.workbench.swt.internal
org.eclipse.e4.ui.workbench.swt.internal.parts
org.eclipse.e4.ui.workbench.swt.modeling
org.eclipse.e4.ui.workbench.swt.util

Proposed package names:

org.eclipse.e4.ui.internal.workbench
org.eclipse.e4.ui.internal.workbench.handlers
org.eclipse.e4.ui.internal.workbench.swt
org.eclipse.e4.ui.internal.workbench.swt.handlers
org.eclipse.e4.ui.internal.workbench.swt.parts
org.eclipse.e4.ui.workbench
org.eclipse.e4.ui.workbench.addons
org.eclipse.e4.ui.workbench.behaviors
org.eclipse.e4.ui.workbench.modeling
org.eclipse.e4.ui.workbench.swt
org.eclipse.e4.ui.workbench.swt.renderers
org.eclipse.e4.ui.workbench.swt.factories
org.eclipse.e4.ui.workbench.swt.modeling
org.eclipse.e4.ui.workbench.swt.util

Comment 2 John Arthorne

2010-06-02 15:42:49 EDT

Actually the org.eclipse.e4.ui.workbench.addons.* packages should just be internal. Currently these packages aren't even exported and most of their classes/methods are not public. We can migrate some of these into public packages in the future, but the current code in these packages doesn't look anything like an API.

Comment 3 John Arthorne

2010-06-02 15:45:47 EDT

Bogdan, in the bundle org.eclipse.e4.ui.css.core, it is safe to assume that packages with "impl" in the name are not intended to be API?

Comment 4 Oleg Besedin

2010-06-02 15:46:23 EDT

> org.eclipse.e4.ui.workbench.modeling

Is it a model for UI Workbench or e4 UI model in general? I'd suggest
"org.eclipse.e4.ui.model".

Comment 5 John Arthorne

2010-06-02 16:00:19 EDT

(In reply to comment #4)
> Is it a model for UI Workbench or e4 UI model in general? I'd suggest
> "org.eclipse.e4.ui.model".

Note this is a package in bundle org.eclipse.e4.ui.workbench. My interpretation is that this package is not a model, but rather model-related services used by the workbench.  There is also bundle org.eclipse.e4.ui.model.workbench which contains the actual model. I haven't looked over that bundle in detail yet.

Comment 6 Oleg Besedin

2010-06-02 16:07:51 EDT

(In reply to comment #5)
> Note this is a package in bundle org.eclipse.e4.ui.workbench.

Ah, sorry, I got confused if we were speaking about bundle names or package names. Please ignore that.

Comment 7 John Arthorne

2010-06-04 16:28:13 EDT

I have done the package renaming mentioned above. I will open separate bugs for remaining smaller issues.