[gmf-dev] [GMF - API Change] Bugzilla 120387 XtoolsPlugin and XtoolsUIPl

[Anthony Hunter <anthonyh@xxxxxxxxxx>]

Description:
Deprecated redundant classes defined in GMF that have equivalents in Core
Eclipse.
XtoolsPlugin:
 *
@deprecated extend
{@link org.eclipse.core.runtime.Plugin}
directly.

 *
This
class
was
deprecated
December
12,
2005
for
https://bugs.eclipse.org/bugs/show_bug.cgi?id=120387
 *
This
class
will
be
removed
January
17,
2005
before
declaration
of
the
M5
milestone.
XtoolsUIPlugin:
 *
@deprecated extend
{@link org.eclipse.ui.plugin.AbstractUIPlugin}
directly

 *
This
class
was
deprecated
December
12,
2005
for
https://bugs.eclipse.org/bugs/show_bug.cgi?id=120387
 *
This
class
will
be
removed
January
17,
2005
before
declaration
of
the
M5
milestone.

Mapping:         
org.eclipse.gmf.runtime.common.core.plugin.XToolsPlugin ==> extend org.eclipse.core.runtime.Plugin
directly
org.eclipse.gmf.runtime.common.ui.plugin.XToolsUIPlugin
==> extend org.eclipse.ui.plugin.AbstractUIPlugin directly

The following lists how to migrate methods
from XtoolsPlugin or XtoolsUIPlugin :

protected XToolsPlugin(IPluginDescriptor
descriptor)

Replace with constructor with no parameters
since the Eclipse IPluginDescriptor is deprecated

public AbstractResourceManager getResourceManager()

ResourceManager is to be replaced with
a class that extends org.eclipse.osgi.util.NLS.
See Bug 109445

protected void doStartup()

Replace replace with start(BundleContext
context). Note that care should be taken not to start unneeded services
in the plug-in startup. See Bug 110489

protected void doShutdown()

Replace with stop(BundleContext context)

public final String getSymbolicName()

Replace with getBundle().getSymbolicName()

public final String getPluginName()

Replace with getBundle().getSymbolicName()

Methods from the implementation of ISaveParticipant
in XtoolsUIPlugin:
public IWorkbench getWorkbench()
public void removeSaveParticipant(ISaveParticipant
participant)
public void prepareToSave(ISaveContext
context)
public void rollback(ISaveContext context)
public void saving(ISaveContext context)
public List getListOfSaveParticipants()

Plug-ins that require ISaveParticipant
can implement directly.  

Plug-in tracing support in XToolsPlugin
and XtoolsUIPlugin are obsolete and developers should use org.eclipse.osgi
tracing (or better still use XRay)

New API Availability: 
- now in gmf-head

Old API Removal: 
January 17th / 2006

Tracking:                  
      
bugzilla 120387

Clients Taken Care of:         
GMF plug-ins owned by Anthony's team

Other Clients' Action: 
replace deprecated usage with recommend classes.

Cheers...
Anthony
--
Anthony Hunter mailto:anthonyh@xxxxxxxxxx
Manager - Software Developer, 
IBM Rational Software: Aurora Core Common / Modeling Tools
Phone: 613-591-7037