Jump to: navigation, search

Difference between revisions of "Mylyn/Porting Guide"

(Changes in 3.2)
Line 1: Line 1:
 
[[Category:Mylyn]]  
 
[[Category:Mylyn]]  
 +
 +
= General =
 +
 +
Mylyn follows the Eclipse conventions for [[Version_Numbering]] and guarantees [[Evolving_Java-based_APIs|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.
  
 
= Porting from 1.0 to 2.0 =
 
= Porting from 1.0 to 2.0 =
Line 9: Line 15:
 
See the <b>[[Mylyn/Porting Guide/3.0]]</b>
 
See the <b>[[Mylyn/Porting Guide/3.0]]</b>
  
= Changes in 3.1 =
+
= Notable API changes in 3.1 =
  
 
* <code>AbstractRepositoryConnectorUi.getAddExistingTaskWizard()</code> now returns null
 
* <code>AbstractRepositoryConnectorUi.getAddExistingTaskWizard()</code> now returns null
Line 18: Line 24:
 
* <code>IUserAttentionListener.userAttentionGained()</code> only fired once {{bug|250072}}
 
* <code>IUserAttentionListener.userAttentionGained()</code> only fired once {{bug|250072}}
 
* <code>AbstractTaskEditorPage.getEditor()</code>'s signature has changed.
 
* <code>AbstractTaskEditorPage.getEditor()</code>'s signature has changed.
 +
* Closing of idle HttpClient connections
  
 
== Breaking changes ==
 
== Breaking changes ==
Line 24: Line 31:
  
  
= Changes in 3.2 =
+
= Notable API changes in 3.2 =
 
* <code>AbstractContextListener</code> uses a single <code>contextChanged(ContextChangeEvent)</code> method instead of separate methods for each event type.  Old methods deprecated.
 
* <code>AbstractContextListener</code> uses a single <code>contextChanged(ContextChangeEvent)</code> method instead of separate methods for each event type.  Old methods deprecated.
  
Line 39: Line 46:
 
** <code>org.eclipse.mylyn.wikitext.tasks.ui.editor.MarkupTaskEditorExtension.TaskMarkupViewerConfiguration.createAnnotationHyperlinkDetector()</code>
 
** <code>org.eclipse.mylyn.wikitext.tasks.ui.editor.MarkupTaskEditorExtension.TaskMarkupViewerConfiguration.createAnnotationHyperlinkDetector()</code>
  
= Pending changes for 3.x =
+
= Pending changes for 3.3 =
  
* Closing of idle HttpClient connections
+
None.

Revision as of 01:12, 22 June 2009


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.

Porting from 1.0 to 2.0

See the Mylyn Porting Guide 2.0

Porting from 2.0 to 3.0

See the Mylyn/Porting Guide/3.0

Notable API changes in 3.1

  • AbstractRepositoryConnectorUi.getAddExistingTaskWizard() now returns null
  • New hyperlink detection bug 167941
  • AttributeEditorFactory now requires an IContextService to enable the WikiText task editor extensions
  • AbstractTaskRepositoryLinkProvider.setTaskRepository() may have repository set to null if association is cleared
  • AbstractRepositorySettingsPage is now extensible
  • IUserAttentionListener.userAttentionGained() only fired once bug 250072
  • AbstractTaskEditorPage.getEditor()'s signature has changed.
  • Closing of idle HttpClient connections

Breaking changes

  • Constants in AbstractRepositorySettingsPage have changed


Notable API changes in 3.2

  • AbstractContextListener uses a single contextChanged(ContextChangeEvent) method instead of separate methods for each event type. Old methods deprecated.

WikiText 1.1

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 @since 1.1. 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.

The following changes should be noted when porting, as they may cause warnings in your projects:

  • Several methods in WikiText have been marked as @noreference. These methods were previously marked as Not API 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
    • org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewer.getStylesheet()
    • org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewer.setStylesheet(Stylesheet)
    • org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewerConfiguration.createAnnotationHyperlinkDetector()
    • org.eclipse.mylyn.wikitext.tasks.ui.editor.MarkupTaskEditorExtension.TaskMarkupViewerConfiguration.createAnnotationHyperlinkDetector()

Pending changes for 3.3

None.