Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Mylyn/Porting Guide"

(→‎Removed Tasks API)
(70 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Category:Mylyn]]  
 
[[Category:Mylyn]]  
−
This document will have Mylar 2.0 specific API changes added to it as we make them.  If interested in keeping up with these changes we '''suggest setting a watch''' for this page.  Note that changes involving classes moving packages are not listed, use ''Organize Imports'' to resolve.
 
  
−
= Porting from 1.0 to 2.0 =
+
= General =
  
−
See the <b>[[Mylyn Porting Guide 2.0]]</b>
+
Mylyn follows the Eclipse conventions for [[Version_Numbering|version numbering]] and guarantees [[Evolving_Java-based_APIs|binary backwards compatibility]] for minor releases. Internals are binary backwards compatible between service releases.
  
−
= Porting from 2.0 to 3.0 =
+
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.
  
−
There is currently no need to port Mylyn from the 2.0 APIs since current Mylyn releases are backwards compatible.  Throughout the 2.x release cycle we will be using this wiki to gather changes and suggestions for improving the APIs for 3.0.
+
= Pending Changes in 3.12 =
  
 +
* The SOAP transport was removed ({{bug|421379}}).
  
−
== Pending Changes for Mylyn 3.0 ==
+
= Changes in 3.11 =
−
Also see all tags of "API-3.0"
+
−
* Refactor <code>TaskActivationHistory</code> into a <code>TaskActivityManager</code> that encapsulates both activity monitoring and activation history
+
−
* Merge ITaskActivityListener and ITaskActivityListner2
+
−
* Refactor ITaskActivityListener into ITaskActivationListener
+
−
* Move timing related methods to ITaskTimingListener
+
−
* <code>AbstractTaskListPresentation</code>: make API, remove coupling to <code>TaskListView</code>
+
−
* <code>TaskGroup</code> and <code>TaskCategory</code>: consider for API, refactor or combine
+
−
* consider merging <code>TaskList.removeFromCategory()</code> and <code>TaskList.removeFromQuery()</code>
+
−
* Move <code>TasksUiPlugin.getIncomingNotification(..)</code> and related private classes
+
−
* <s><code>AbstractTask.setCompleted()</code> needs changing, it has the problematic side effect of setting the completion date to the current time.  {{bug|203875}}</s>
+
−
* Remove <code>AbstractInterestManipulationAction.isRemove()</code>: deprecated
+
−
* Make <code>IMonitoredWindow</code> API and put alongside <code>IContextAwareEditor</code>
+
−
* Make API: <code>InteractionContextScaling</code>
+
−
* Rename <code>AbstractTask.RepositoryTaskSyncState</code> to <code>AbstractTask.SyncState</code> ("sync" is used commonly enough that we should be able to standardize on it in the API, replacing "synchronization/synchronize" where applicable).
+
−
* Add <code>InteractionContextScaling</code> parameter to <code>IInteractionContextReader.readContext(..)</code>
+
−
* Make a subset of <code>InteractionContextManager</code> API.
+
−
* Make <code>TaskRepository.getUserName()</code>, <code>getHttpUser</code> and <code>getProxyUsername</code> consistent
+
−
* Move highlighters stuff out of <code>ContextUiPlugin</code>
+
−
* Move to using the new public URLTransfer {{bug|100095}}
+
−
* Merge <code>IInteractionContextListener</code> and <code>IInteractionContextListener2</code>
+
−
* Move <code>NewTaskFromErrorAction</code> to be available to more EPP distros
+
−
* Delete <code>UiUtil</code>
+
−
* Move <code>JavaStackTraceHyperlinkDetector</code> out of java.ui See {{bug|217656}}
+
  
−
== New Tasks API ==  
+
= Changes in 3.10 =
  
−
* <code>AbstractRenderingEngine</code> has been added for converting Wiki syntax to HTML
+
None.
  
−
* <code>AbstractRepositoryQueryPage</code>
+
= Porting from 3.8 to 3.9 =
−
** <code>setControlsEnabled(...)</code>: added - override to perform finer grain enablements if necessary
+
  
−
* <code>AbstractRepositoryTaskEditor</code> has been extended to provide HTML preview capabilities for repositories that support Wiki syntax in ticket descriptions and comments
+
== Mylyn Reviews ==
  
−
== Removed Tasks API ==
+
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.
  
−
* <code>AbstractAttachmentHandler</code>
+
= Porting from 3.7 to 3.8 =
−
** <code>MESSAGE_ATTACHMENTS_NOT_SUPPORTED</code> has been removed
+
−
** <code>MYLAR_CONTEXT_DESCRIPTION</code> has been removed
+
−
** <code>MYLAR_CONTEXT_DESCRIPTION_LEGACY</code> has been removed
+
−
** <code>MYLAR_CONTEXT_FILENAME</code> has been removed
+
−
** <code>attachContextAttachments()</code> has been moved to the internal class <code>AttachmentUtil</code>
+
−
** <code>getContextAttachments()</code> has been moved to the internal class <code>AttachmentUtil</code>
+
−
** <code>hasRepositoryContext()</code> has been moved to the internal class <code>AttachmentUtil</code>
+
−
** <code>retrieveContext()</code> has been moved to the internal class <code>AttachmentUtil</code>
+
  
−
* <code>AbstractRepositoryConnectorUi</code>
+
No API changes that affect integrators.
−
** <code>getNewTaskWizard(TaskRepository taskRepository)</code> has been removed
+
  
−
* <code>AbstractTask</code>
+
= Porting from 3.6 to 3.7 =
−
** <code>setCompleted()</code> has been removed, a non-null completion date indicates a task is complete
+
  
−
* <code>GzipGetMethod</code> has been moved to an internal package
+
== Mylyn Commons ==
  
−
* <code>GzipPostMethod</code> has been moved to an internal package
+
* {{bug|305782}} Restructuring of Mylyn Commons features
  
−
* <code>SslProtocolSocketFactory</code> has been moved to an internal package
+
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>TaskActivityManager</code>
+
The following bundles were renamed:
−
** <code>getInstance()</code> has been removed, use <code>TasksUiPlugin.getTaskActivityManager()</code> instead
+
−
** <code>init()</code> has been replaced by a public constructor
+
  
−
* <code>TaskFormPage</code>
+
org.eclipse.mylyn.commons.identity      -> org.eclipse.mylyn.commons.identity.core
−
** <code>actionContributor</code> has been removed
+
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
  
−
* <code>TrustAllTrustManager</code> has been moved to an internal package
+
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].
  
−
* <code>TaskListManager</code> does not implements <code>IPropertyChangeListener</code> anymore
+
The following packages were renamed:
−
** <code>ESTIMATE_TIMES</code> has been removed
+
−
** <code>getActivityFuture()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getActivityNextWeek()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getActivityPast()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getActivityPrevious()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getActivityThisWeek()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getActivityWeekDays()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getDateRanges()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getElapsedTime(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getScheduledForThisWeek()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>getStartHour()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isActiveThisWeek(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isCompletedToday(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isOverdue(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isOwnedByUser(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isScheduledAfterThisWeek(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isScheduledForLater(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isScheduledForThisWeek(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isScheduledForToday(AbstractTask task)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>isWeekDay(ScheduledTaskContainer dateRangeTaskContainer)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>parseFutureReminders()</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>propertyChange(PropertyChangeEvent)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>scheduleNewTask(AbstractTask newTask)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>setDueDate(AbstractTask task, Date dueDate)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>setScheduledEndOfDay(Calendar calendar)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>setScheduledFor(AbstractTask task, Date reminderDate)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>setScheduledNextWeek(Calendar calendar)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>setSecheduledIn(Calendar calendar, int days)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToEndOfDay(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToEndOfHour(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToEndOfWeek(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToEndOfWeek(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToNextDay(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToStartOfDay(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToStartOfHour(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
−
** <code>snapToStartOfWeek(Calendar cal)</code> has been removed (see <code>TaskActivityManager</code>)
+
  
−
* <code>TaskRepositoryManager</code> has been moved to an internal package and replaced by <code>ITaskRepositoryManager</code>
+
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
  
−
* <code>TaskEditor</code>
+
The following provisional packages were promoted to API (see {{bug|360301}}):
−
** <code>getContributor()</code> has been removed
+
  
−
* <code>TasksUiProxyChangeListener</code> has been removed
+
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
  
−
* <code>TasksUiUtil</code>
+
In some cases provisional packages do not map directly to API packages but classes were distributed among several packages.
−
** <code>openEditor(TaskCategory)</code> has been removed
+
  
−
* <code>WebCorePlugin</code> has been moved to an internal package
+
The following extension points have moved:
  
−
== New Context API ==
+
org.eclipse.mylyn.commons.team.newWizards -> org.eclipse.mylyn.commons.repositories.ui.newWizards
  
−
* <code>AbstractFocusViewAction.updateEnablementWithContextActivation()</code>: override to return false for focus actions that are not related to context activations (e.g. the Task List).
+
The following extension IDs have changed:
  
−
* <code>AbstractFocusViewAction.setLinkingActionEnabled(boolean)</code>: should be overridden if view provides linking
+
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
  
−
== Removed Context API ==
+
= Porting from 3.0 to 3.6 =
  
−
* <code>BrowseFilteredAction</code> has been moved to an internal package
+
See the <b>[[Mylyn/Porting Guide/3.x]]</b>
−
* <code>ContextCorePlugin</code> has been moved to an internal package and replaced by <code>ContextCore</code>
+
−
* <code>ContextUiPlugin</code> has been moved to an internal package and replaced by <code>ContextUi</code>
+
−
* <code>InteractionContextReader</code> has been moved to an internal package
+
−
* <code>InteractionContextWriter</code> has been moved to an internal package
+
−
* <code>MonitorUiPlugin</code> has been moved to an internal package and replaced by <code>MonitorUi</code>
+
−
* <code>ResourcesUiPlugin</code> has been moved to an internal package and replaced by <code>ResourcesUi</code>
+
  
−
== New Monitor API ==
+
= Porting from 2.0 to 3.0 =
  
−
* <code>MonitorUiPlugin.getMonitoredWindows()</code>: use insteand of <code>PlatformUI.getWorkbench().getWorkbenchWindows()</code>
+
See the <b>[[Mylyn/Porting Guide/3.0]]</b>
−
* <code>MonitorUiPlugin.getLaunchingWorkbenchWindow()</code>: use to get the first active window when the monitor started.
+
  
−
== Removed Monitor API ==
 
  
−
* <code>IMylarMonitorLifecycleListener</code> has been renamed to <code>IMonitorLifecycleListener</code>
+
= Porting from 1.0 to 2.0 =
−
* <code>ReportGenerator</code> has been moved to an internal package
+
 
 +
See the <b>[[Mylyn Porting Guide 2.0]]</b>

Revision as of 16:26, 21 March 2014


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.

Pending 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

Retrieved from "https://wiki.eclipse.org/index.php?title=Mylyn/Porting_Guide&oldid=358661"

Back to the top