Bug 311514 - Announcing API-Removal for org.eclipse.draw2d.geometry.Ray
Summary: Announcing API-Removal for org.eclipse.draw2d.geometry.Ray
Status: RESOLVED WONTFIX
Alias: None
Product: GEF
Classification: Tools
Component: GEF-Legacy Draw2d (show other bugs)
Version: 3.6   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: gef-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 310723
Blocks:
  Show dependency tree
 
Reported: 2010-05-04 07:32 EDT by Alexander Nyßen CLA
Modified: 2014-07-12 11:31 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alexander Nyßen CLA 2010-05-04 07:32:04 EDT
As soon as all routers are migrated to use Vector instead of Ray, API removal of Ray class should be promoted, so it can be safely removed.
Comment 1 Randy Hudson CLA 2010-05-04 10:28:28 EDT
This should make for some good entertainment!  Are you actually going to remove a public class that has been around for 10 years in a release candidate?
Comment 2 Randy Hudson CLA 2010-05-04 10:32:54 EDT
OK, maybe you're talking about tagging it for removal somehow using the API tooling.  However, no one actually uses API tooling outside of the eclipse "train", since it doesn't scale for real-world development.
Comment 3 Anthony Hunter CLA 2010-05-04 11:06:25 EDT
We cannot remove public API from a minor release of GEF, in this case GEF 3.6. The API provided by Ray in GEF 3.5 still works 100% in GEF 3.6, it is just deprecated.

We have not even considered adopting the platforms API removal policy.

We have made Ray deprecated, this is sufficient for the time being.

Please confirm Alexander and we can resolve this as wontfix for GEF 3.6.
Comment 4 Alexander Nyßen CLA 2010-05-04 12:46:28 EDT
OK, let me clarify this, as I admit it could be very well misunderstood. My intention was of course not to remove Ray as part of 3.6RC1! 

Actually I wasn't sure whether the API retention policies (http://wiki.eclipse.org/Eclipse/API_Central/Deprecation_Policy#Announcing_API_Removal) would have to be applied to GEF or not. As such I raised this one so that - in case they would do - we would not forget to announce the removal now (by means of a statement within the deprecation comment), so that according to the retention policy it would then be possible to remove the class after the next but two major releases, that is as part of GEF 3.9 (or whatever version we would be releasing then).

If we are not bound to API retention policies we may close this as wontfix. I am fine with that.
Comment 5 Randy Hudson CLA 2010-05-04 14:35:15 EDT
I'm don't know of any API ever being removed from GEF (since it was open sourced, R2.1), but I'm also not aware of any official policy ever in place at any given time, either.

Obviously bug 310723 would be another breakage of binary and source compatibility late in the game.

This was a nice read back when I read it:
http://wiki.eclipse.org/Evolving_Java-based_APIs
I need to go back and re-read it now that it discusses Java 5 concerns, etc.
Comment 6 Anthony Hunter CLA 2010-05-17 09:29:33 EDT
Ray is used roughly 40 times in the GMF Runtime project. This change has introduced 40 new deprecation warnings to Helios. Not necessarily bad I suppose, just documenting this fact.
Comment 7 Alexander Nyßen CLA 2014-07-12 11:31:23 EDT
As GEF4 will provide an alternative to Draw2d anyway (JavaFX + GEF4 FX), there is no urgent need to break existing Draw2d users. We may thus leave Ray in place (while it should remain deprecated). Resolving as WONTFIX though.