Revision as of 21:02, 10 April 2008

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

See the Mylyn Porting Guide 2.0

Porting from 2.0 to 3.0

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 for Mylyn 3.0

Also see all tags of "API-3.0"

• Refactor TaskActivationHistory into a TaskActivityManager that encapsulates both activity monitoring and activation history
• Merge ITaskActivityListener and ITaskActivityListner2
• Refactor ITaskActivityListener into ITaskActivationListener
• Move timing related methods to ITaskTimingListener
• AbstractTaskListPresentation: make API, remove coupling to TaskListView
• TaskGroup and TaskCategory: consider for API, refactor or combine
• consider merging TaskList.removeFromCategory() and TaskList.removeFromQuery()
• Move TasksUiPlugin.getIncomingNotification(..) and related private classes
• AbstractTask.setCompleted() needs changing, it has the problematic side effect of setting the completion date to the current time. bug 203875
• Remove AbstractInterestManipulationAction.isRemove(): deprecated
• Make IMonitoredWindow API and put alongside IContextAwareEditor
• Make API: InteractionContextScaling
• Rename AbstractTask.RepositoryTaskSyncState to AbstractTask.SyncState ("sync" is used commonly enough that we should be able to standardize on it in the API, replacing "synchronization/synchronize" where applicable).
• Add InteractionContextScaling parameter to IInteractionContextReader.readContext(..)
• Make a subset of InteractionContextManager API.
• Make TaskRepository.getUserName(), getHttpUser and getProxyUsername consistent
• Move highlighters stuff out of ContextUiPlugin
• Move to using the new public URLTransfer bug 100095
• Merge IInteractionContextListener and IInteractionContextListener2
• Move NewTaskFromErrorAction to be available to more EPP distros
• Delete UiUtil
• Move JavaStackTraceHyperlinkDetector out of java.ui See bug 217656

New Tasks API

• AbstractRenderingEngine has been added for converting Wiki syntax to HTML

• AbstractRepositoryQueryPage
  • setControlsEnabled(...): added - override to perform finer grain enablements if necessary

• AbstractRepositoryTaskEditor has been extended to provide HTML preview capabilities for repositories that support Wiki syntax in ticket descriptions and comments

Removed Tasks API

• AbstractAttachmentHandler
  • MESSAGE_ATTACHMENTS_NOT_SUPPORTED has been removed
  • MYLAR_CONTEXT_DESCRIPTION has been removed
  • MYLAR_CONTEXT_DESCRIPTION_LEGACY has been removed
  • MYLAR_CONTEXT_FILENAME has been removed
  • attachContextAttachments() has been moved to the internal class AttachmentUtil
  • getContextAttachments() has been moved to the internal class AttachmentUtil
  • hasRepositoryContext() has been moved to the internal class AttachmentUtil
  • retrieveContext() has been moved to the internal class AttachmentUtil

• AbstractRepositoryConnectorUi
  • getNewTaskWizard(TaskRepository taskRepository) has been removed

• AbstractTask
  • setCompleted() has been removed, a non-null completion date indicates a task is complete

• GzipGetMethod has been moved to an internal package

• GzipPostMethod has been moved to an internal package

• SslProtocolSocketFactory has been moved to an internal package

• TaskActivityManager
  • getInstance() has been removed, use TasksUiPlugin.getTaskActivityManager() instead
  • init() has been replaced by a public constructor

• TaskFormPage
  • actionContributor has been removed

• TrustAllTrustManager has been moved to an internal package

• TaskListManager does not implements IPropertyChangeListener anymore
  • ESTIMATE_TIMES has been removed
  • getActivityFuture() has been removed (see TaskActivityManager)
  • getActivityNextWeek() has been removed (see TaskActivityManager)
  • getActivityPast() has been removed (see TaskActivityManager)
  • getActivityPrevious() has been removed (see TaskActivityManager)
  • getActivityThisWeek() has been removed (see TaskActivityManager)
  • getActivityWeekDays() has been removed (see TaskActivityManager)
  • getDateRanges() has been removed (see TaskActivityManager)
  • getElapsedTime(AbstractTask task) has been removed (see TaskActivityManager)
  • getScheduledForThisWeek() has been removed (see TaskActivityManager)
  • getStartHour() has been removed (see TaskActivityManager)
  • isActiveThisWeek(AbstractTask task) has been removed (see TaskActivityManager)
  • isCompletedToday(AbstractTask task) has been removed (see TaskActivityManager)
  • isOverdue(AbstractTask task) has been removed (see TaskActivityManager)
  • isOwnedByUser(AbstractTask task) has been removed (see TaskActivityManager)
  • isScheduledAfterThisWeek(AbstractTask task) has been removed (see TaskActivityManager)
  • isScheduledForLater(AbstractTask task) has been removed (see TaskActivityManager)
  • isScheduledForThisWeek(AbstractTask task) has been removed (see TaskActivityManager)
  • isScheduledForToday(AbstractTask task) has been removed (see TaskActivityManager)
  • isWeekDay(ScheduledTaskContainer dateRangeTaskContainer) has been removed (see TaskActivityManager)
  • parseFutureReminders() has been removed (see TaskActivityManager)
  • propertyChange(PropertyChangeEvent) has been removed (see TaskActivityManager)
  • scheduleNewTask(AbstractTask newTask) has been removed (see TaskActivityManager)
  • setDueDate(AbstractTask task, Date dueDate) has been removed (see TaskActivityManager)
  • setScheduledEndOfDay(Calendar calendar) has been removed (see TaskActivityManager)
  • setScheduledFor(AbstractTask task, Date reminderDate) has been removed (see TaskActivityManager)
  • setScheduledNextWeek(Calendar calendar) has been removed (see TaskActivityManager)
  • setSecheduledIn(Calendar calendar, int days) has been removed (see TaskActivityManager)
  • snapToEndOfDay(Calendar cal) has been removed (see TaskActivityManager)
  • snapToEndOfHour(Calendar cal) has been removed (see TaskActivityManager)
  • snapToEndOfWeek(Calendar cal) has been removed (see TaskActivityManager)
  • snapToEndOfWeek(Calendar cal) has been removed (see TaskActivityManager)
  • snapToNextDay(Calendar cal) has been removed (see TaskActivityManager)
  • snapToStartOfDay(Calendar cal) has been removed (see TaskActivityManager)
  • snapToStartOfHour(Calendar cal) has been removed (see TaskActivityManager)
  • snapToStartOfWeek(Calendar cal) has been removed (see TaskActivityManager)

• TaskEditor
  • getContributor() has been removed

• TasksUiUtil
  • openEditor(TaskCategory) has been removed

• WebCorePlugin has been moved to an internal package

New Context API

• AbstractFocusViewAction.updateEnablementWithContextActivation(): override to return false for focus actions that are not related to context activations (e.g. the Task List).

• AbstractFocusViewAction.setLinkingActionEnabled(boolean): should be overridden if view provides linking

Removed Context API

• BrowseFilteredAction has been moved to an internal package
• ContextCorePlugin has been moved to an internal package and replaced by ContextCore
• ContextUiPlugin has been moved to an internal package and replaced by ContextUi
• InteractionContextReader has been moved to an internal package
• InteractionContextWriter has been moved to an internal package
• ResourcesUiPlugin has been moved to an internal package and replaced by ResourcesUi

New Monitor API

• MonitorUiPlugin.getMonitoredWindows(): use insteand of PlatformUI.getWorkbench().getWorkbenchWindows()
• MonitorUiPlugin.getLaunchingWorkbenchWindow(): use to get the first active window when the monitor started.

Removed Monitor API

• IMylarMonitorLifecycleListener has been renamed to IMonitorLifecycleListener