Bugzilla – Full Text Bug Listing
| Summary: | Mark our public interfaces as not meant to be implemented | ||
|---|---|---|---|
| Product: | [Modeling] GMF-Runtime | Reporter: | Cherie Revells <crevells> |
| Component: | General | Assignee: | Cherie Revells <crevells> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | major | ||
| Priority: | P1 | Keywords: | api |
| Version: | 1.0 | ||
| Target Milestone: | 1.0 | ||
| Hardware: | PC | ||
| OS: | Windows 2000 | ||
| Whiteboard: | |||
We should also check for class that we don't want people to extend and mark them final. i.e. Services... moving to M6 Move to RC Marked the following interfaces as "not meant to be implemented": oegr.diagram.core.providers.IViewProvider -- Subclass AbstractViewProvider instead. oegr.diagram.ui.actions.ActionIds -- Defines constants only. oegr.diagram.ui.editpolicies.EditPolicyRoles -- Defines constants only. oegr.diagram.ui.figures.DiagramColorConstants -- Defines constants only. oegr.diagram.ui.preferences.IPreferenceConstants -- Defines constants only. oegr.diagram.ui.requests.RequestConstants -- Defines constants only. oegr.diagram.ui.services.decorator.IDecoratorKeys -- Defines constants only. oegr.diagram.ui.services.decorator.IDecoratorTarget -- The service creates and uses the implementor internally. No need to implement. oegr.diagram.ui.services.editpart.IEditPartOperation -- No reason for clients to subclass. Used by the editpart service only. oegr.diagram.ui.services.palette.PaletteFactory -- Subclass the empty adapter class provided instead. oegr.diagram.ui.render.ui.render.actions.ActionIds -- Defines constants only. It is too late to mark classes as final. [target cleanup] 1.0 RC was the original target milestone for this bug [GMF Restructure] Bug 319140 : product GMF and component Runtime Diagram was the original product and component for this bug |
If a client is implementing an interface in our public API, it is not possible to add a method to that interface without breaking the client code. We should look through our interfaces and indicate in the javadoc that they are not meant to be implemented. For example, the EditPolicy interface in GEF says the following: * IMPORTANT: This interface is <EM>not</EM> intended to be implemented by clients. * Clients should inherit from {@link org.eclipse.gef.editpolicies.AbstractEditPolicy}. * New methods may be added in the future. Examples in our code: IDecoratorProvider -- we should create an AbstractDecoratorProvider and clients should subclass this instead. I'm not sure if there are more cases in our code. Maybe we should do a search.