Skip to main content
Jump to: navigation, search

Difference between revisions of "Mylyn/Porting Guide"

(Notable API changes in 3.2)
(Changes in 3.20)
 
(17 intermediate revisions by 3 users not shown)
Line 7: Line 7:
 
API enhancements can be tracked by searching the source code for the corresponding @since JavaDoc tags or by querying for bugs that have [api] in their summary.
 
API enhancements can be tracked by searching the source code for the corresponding @since JavaDoc tags or by querying for bugs that have [api] in their summary.
  
= Porting from 1.0 to 2.0 =
+
= Changes in 3.22 =
  
See the <b>[[Mylyn Porting Guide 2.0]]</b>
+
* Connectors that do not provide a task key no longer have their task ID automatically used as the key. Connectors that rely on this behaviour should explicitly set the task key to the ID. This change actually occurred in Mylyn 3.21 but was not added to this page until the 3.22 release.
  
= Porting from 2.0 to 3.0 =
+
= Changes in 3.20 =
  
See the <b>[[Mylyn/Porting Guide/3.0]]</b>
+
* <code>AbstractTaskListMigrator</code> and its related extension point have been deprecated. Contributed migrators will no longer be applied when loading the Task List ({{bug|493037}}).
  
= Notable API changes in 3.1 =
+
= Changes in 3.12 =
  
* <code>AbstractRepositoryConnectorUi.getAddExistingTaskWizard()</code> now returns null
+
* The SOAP transport was removed ({{bug|421379}}).
* New hyperlink detection {{bug|167941}}
+
* <code>AttributeEditorFactory</code> now requires an <code>IContextService</code> to enable the WikiText task editor extensions
+
* <code>AbstractTaskRepositoryLinkProvider.setTaskRepository()</code> may have repository set to <code>null</code> if association is cleared
+
* <code>AbstractRepositorySettingsPage</code> is now extensible
+
* <code>IUserAttentionListener.userAttentionGained()</code> only fired once {{bug|250072}}
+
* <code>AbstractTaskEditorPage.getEditor()</code>'s signature has changed.
+
* Closing of idle HttpClient connections
+
  
== Breaking changes ==
+
= Changes in 3.11 =
  
* Constants in <code>AbstractRepositorySettingsPage</code> have changed
+
* The SOAP transport was deprecated ({{bug|423964}}).
  
 +
= Changes in 3.10 =
  
= Notable API changes in 3.2 =
+
None.
  
[https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=%5Bapi%5D&product=Mylyn&target_milestone=3.2&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=|All API enhancements in 3.2]
+
= Porting from 3.8 to 3.9 =
  
'''Context Framework'''
+
== Mylyn Reviews ==
* {{bug|274904}} <code>AbstractContextListener</code> uses a single <code>contextChanged(ContextChangeEvent)</code> method instead of separate methods for each event type. The old notification methods have been deprecated.
+
  
'''Tasks Framework'''
+
The Reviews framework has had a major update which resulted in changes to the core model and API. In consequence, the version was updated to 2.0.
* {{bug|269407}} <code>TaskDataModel.getChangedOldAttributes()</code> has been implemented and the list of changed attributes is now passed to <code>AbstractTaskDataHandler.postTaskData()</code> to support incremental updates to tasks.
+
* {{bug|278298}} To make use of the private section in the editor <code>setNeedsPrivateSection(true)</code> needs to be invoked in the constructor of classes extending <code>AbstractTaskEditorPage</code>. To suppress the planning page <code>AbstractTaskEditorPageFactory.getConflictingIds()</code> needs to return <code>new String[] { ITasksUiConstants.ID_PAGE_PLANNING }</code>.
+
* {{bug|274790}} To enable the submit button in the header toolbar of the Task Editor <code>setNeedsSubmitButton(true)</code> needs to be invoked in the constructor of classes extending <code>AbstractTaskEditorPage</code>.
+
* {{bug|278708}} Classes extending <code>AbstractTaskEditorPage</code> that do not support submission are encouraged to invoke <code>setNeedsSubmit(false)</code> in their constructor. This flag may be used in the future to hide submit button contributions and to disable key-bindings for submitting.
+
* {{bug|276651}} Severity and version have been added to the common task schema. Connectors are encouraged to map <code>TaskAttribute.SEVERITY</code> and <code>TaskAttribute.VERSION</code> in <code>TaskAttributeMapper.mapToRepositoryKey()</code>.
+
  
''Integrated Support''
+
= Porting from 3.7 to 3.8 =
* {{bug|150278}} The org.eclipse.mylyn.tasks.bugs plug-in specifies an extension point for contributing a mapping from plug-in ids to task repositories or custom support handlers.
+
  
 +
No API changes that affect integrators.
  
== WikiText 1.1 ==
+
= Porting from 3.6 to 3.7 =
  
WikiText 1.1 was released as part of Mylyn 3.2.  WikiText 1.1 has several new API additions which can be found in the source by searching for <tt>@since 1.1</tt>.  All API additions are non-breaking changes unless your project subclasses WikiText classes.  When porting to WikiText 1.1 care should be taken to review these additions where subclassing is used.
+
== Mylyn Commons ==
  
The following changes should be noted when porting, as they may cause warnings in your projects:
+
* {{bug|305782}} Restructuring of Mylyn Commons features
  
* Several methods in WikiText have been marked as @noreference. These methods were previously marked as <em>Not API</em> in the javadoc, however @noreference is more explicit and works well with the PDT API tools.  More information about these changes can be found on {{bug|280614}}
+
The Mylyn Commons components were restructured and provisional packages were promoted to API. Several bundle IDs, package names and extension IDs were changed in the process. Classes in provisional packages were kept but marked as deprecated and will be removed in a future release. None of the changes break API backwards compatibility but integrations that consumed internal packages or extensions points may need to be adapted.
** <code>org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewer.getStylesheet()</code>
+
** <code>org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewer.setStylesheet(Stylesheet)</code>
+
** <code>org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewerConfiguration.createAnnotationHyperlinkDetector()</code>
+
** <code>org.eclipse.mylyn.wikitext.tasks.ui.editor.MarkupTaskEditorExtension.TaskMarkupViewerConfiguration.createAnnotationHyperlinkDetector()</code>
+
  
= Pending changes for 3.3 =
+
The following bundles were renamed:
  
None.
+
org.eclipse.mylyn.commons.identity      -> org.eclipse.mylyn.commons.identity.core
 +
org.eclipse.mylyn.commons.notifications -> org.eclipse.mylyn.commons.notifications.ui
 +
org.eclipse.mylyn.commons.repositories  -> org.eclipse.mylyn.commons.repositories.core
 +
org.eclipse.mylyn.commons.team          -> org.eclipse.mylyn.commons.repositories.ui
 +
 
 +
A complete list of renamed and added bundles can be found on bug 305782 on [https://bugs.eclipse.org/bugs/show_bug.cgi?id=305782#c13 comment 13].
 +
 
 +
The following packages were renamed:
 +
 
 +
org.eclipse.mylyn.commons.identity    -> org.eclipse.mylyn.commons.identity.core
 +
org.eclipse.mylyn.commons.repositories -> org.eclipse.mylyn.commons.repositories.core
 +
org.eclipse.mylyn.commons.ui.team      -> org.eclipse.mylyn.commons.repositories.ui
 +
 
 +
The following provisional packages were promoted to API (see {{bug|360301}}):
 +
 
 +
org.eclipse.mylyn.internal.provisional.commons.core        -> org.eclipse.mylyn.commons.core
 +
org.eclipse.mylyn.internal.provisional.commons.ui          -> org.eclipse.mylyn.commons.ui
 +
                                                            -> org.eclipse.mylyn.commons.workbench
 +
                                                            -> org.eclipse.mylyn.commons.workbench.browser
 +
                                                            -> org.eclipse.mylyn.commons.workbench.editors
 +
                                                            -> org.eclipse.mylyn.commons.workbench.forms
 +
                                                            -> org.eclipse.mylyn.commons.workbench.search
 +
org.eclipse.mylyn.internal.provisional.commons.ui.actions  -> org.eclipse.mylyn.commons.ui
 +
org.eclipse.mylyn.internal.provisional.commons.ui.commands -> org.eclipse.mylyn.commons.workbench.texteditor
 +
org.eclipse.mylyn.internal.provisional.commons.ui.dialogs  -> org.eclipse.mylyn.commons.ui.dialogs
 +
org.eclipse.mylyn.internal.provisional.commons.ui.editor  -> org.eclipse.mylyn.commons.workbench
 +
 
 +
In some cases provisional packages do not map directly to API packages but classes were distributed among several packages.
 +
 
 +
The following extension points have moved:
 +
 
 +
org.eclipse.mylyn.commons.team.newWizards -> org.eclipse.mylyn.commons.repositories.ui.newWizards
 +
 
 +
The following extension IDs have changed:
 +
 
 +
org.eclipse.mylyn.commons.team.navigator.Repositories -> org.eclipse.mylyn.commons.repositories.ui.navigator.Repositories
 +
org.eclipse.mylyn.commons.team.category              -> org.eclipse.mylyn.commons.repositories.ui.category.Team
 +
 
 +
= Porting from 3.0 to 3.6 =
 +
 
 +
See the <b>[[Mylyn/Porting Guide/3.x]]</b>
 +
 
 +
= Porting from 2.0 to 3.0 =
 +
 
 +
See the <b>[[Mylyn/Porting Guide/3.0]]</b>
 +
 
 +
 
 +
= Porting from 1.0 to 2.0 =
 +
 
 +
See the <b>[[Mylyn Porting Guide 2.0]]</b>

Latest revision as of 14:59, 7 February 2017


General

Mylyn follows the Eclipse conventions for version numbering and guarantees binary backwards compatibility for minor releases. Internals are binary backwards compatible between service releases.

API enhancements can be tracked by searching the source code for the corresponding @since JavaDoc tags or by querying for bugs that have [api] in their summary.

Changes in 3.22

  • Connectors that do not provide a task key no longer have their task ID automatically used as the key. Connectors that rely on this behaviour should explicitly set the task key to the ID. This change actually occurred in Mylyn 3.21 but was not added to this page until the 3.22 release.

Changes in 3.20

  • AbstractTaskListMigrator and its related extension point have been deprecated. Contributed migrators will no longer be applied when loading the Task List (bug 493037).

Changes in 3.12

Changes in 3.11

Changes in 3.10

None.

Porting from 3.8 to 3.9

Mylyn Reviews

The Reviews framework has had a major update which resulted in changes to the core model and API. In consequence, the version was updated to 2.0.

Porting from 3.7 to 3.8

No API changes that affect integrators.

Porting from 3.6 to 3.7

Mylyn Commons

  • bug 305782 Restructuring of Mylyn Commons features

The Mylyn Commons components were restructured and provisional packages were promoted to API. Several bundle IDs, package names and extension IDs were changed in the process. Classes in provisional packages were kept but marked as deprecated and will be removed in a future release. None of the changes break API backwards compatibility but integrations that consumed internal packages or extensions points may need to be adapted.

The following bundles were renamed:

org.eclipse.mylyn.commons.identity      -> org.eclipse.mylyn.commons.identity.core
org.eclipse.mylyn.commons.notifications -> org.eclipse.mylyn.commons.notifications.ui
org.eclipse.mylyn.commons.repositories  -> org.eclipse.mylyn.commons.repositories.core
org.eclipse.mylyn.commons.team          -> org.eclipse.mylyn.commons.repositories.ui

A complete list of renamed and added bundles can be found on bug 305782 on comment 13.

The following packages were renamed:

org.eclipse.mylyn.commons.identity     -> org.eclipse.mylyn.commons.identity.core
org.eclipse.mylyn.commons.repositories -> org.eclipse.mylyn.commons.repositories.core
org.eclipse.mylyn.commons.ui.team      -> org.eclipse.mylyn.commons.repositories.ui

The following provisional packages were promoted to API (see bug 360301):

org.eclipse.mylyn.internal.provisional.commons.core        -> org.eclipse.mylyn.commons.core
org.eclipse.mylyn.internal.provisional.commons.ui          -> org.eclipse.mylyn.commons.ui
                                                           -> org.eclipse.mylyn.commons.workbench
                                                           -> org.eclipse.mylyn.commons.workbench.browser
                                                           -> org.eclipse.mylyn.commons.workbench.editors
                                                           -> org.eclipse.mylyn.commons.workbench.forms
                                                           -> org.eclipse.mylyn.commons.workbench.search
org.eclipse.mylyn.internal.provisional.commons.ui.actions  -> org.eclipse.mylyn.commons.ui
org.eclipse.mylyn.internal.provisional.commons.ui.commands -> org.eclipse.mylyn.commons.workbench.texteditor
org.eclipse.mylyn.internal.provisional.commons.ui.dialogs  -> org.eclipse.mylyn.commons.ui.dialogs
org.eclipse.mylyn.internal.provisional.commons.ui.editor   -> org.eclipse.mylyn.commons.workbench

In some cases provisional packages do not map directly to API packages but classes were distributed among several packages.

The following extension points have moved:

org.eclipse.mylyn.commons.team.newWizards -> org.eclipse.mylyn.commons.repositories.ui.newWizards

The following extension IDs have changed:

org.eclipse.mylyn.commons.team.navigator.Repositories -> org.eclipse.mylyn.commons.repositories.ui.navigator.Repositories
org.eclipse.mylyn.commons.team.category               -> org.eclipse.mylyn.commons.repositories.ui.category.Team

Porting from 3.0 to 3.6

See the Mylyn/Porting Guide/3.x

Porting from 2.0 to 3.0

See the Mylyn/Porting Guide/3.0


Porting from 1.0 to 2.0

See the Mylyn Porting Guide 2.0

Back to the top