Mylyn/Porting Guide

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 Mylar 1.0 to 2.0

Pending Changes

The following changes are planned but not yet implemented. Email mylar-dev if any of these pose a problem.

• TaskRepository:
  • rename getKind() to getConnectorKind()
  • Make class final

• AbstractRepositoryConnector:
  • rename createTaskFromExistingKey(..) to addExistingTask(..)
  • rename getRepositoryType() to getConnectorKind()

• AbstractRepositoryTask
  • rename getRepositoryKind() to getConnectorKind()

• Task
  • rename getRepositoryKind() to getConnectorKind()
  • rename getDescription() to getSummary()

• IRepositoryConstants
  • rename PROPERTY_KIND to PROPERTY_CONNECTOR_KIND

General

• Library dependencies have moved to org.eclipse.mylar

• MylarStatusHandler and IStatusHandler
  • moved from org.eclipse.mylar.context.core to org.eclipse.mylar.core

• MylarStatus (place holder, will improve as we solidify this)
  • MylarStatusHandler.displayStatus(dialog title, IStatus status) - call to display error and information dialogs
  • When returning CoreException pass in a MylarStatus with appropriate code (see IMylarStatusConstants).
  • If IMylarStatusConstants.INTERNAL_ERROR is sent to MylarStatusHandler.displayStatus an error dialog will appear and the error will be logged.
  • IMylarStatusConstants.REPOSITORY_COLLISION used for mid-air collision. Pass repository url and appropriate dialog will be displayed.

• WebClientUtil
  • moved from ..mylar.tasks.core to ..mylar.core.net

Tasks API

Sorting is alphabetical.

• AbstractRepositoryConnector
  • getLastSyncTimestamp(TaskRepository repository, Set<AbstractRepositoryTask> changedTasks): added (may change as part of bug#176934)
  • getSupportedVersions() has been removed (#1768159)

• AbstractRepositoryConnectorUi
  • openRemoteTask(String repositoryUrl, String id): removed, this method no longer needs to be implemented by the connector. Instead classes can rely on the new openRepositoryTask(..) method, and override it if necessary.
  • getRepositoryUrl and all ID/URL methods: now final, change via setters
  • + findHyperlinks(...) override to detect hyperlinks in editors

• AbstractRepositorySettingsPage validation changes.
  • setNeedsValidation(boolean needsValidation) if true validate button will be visible
  • getValidator(TaskRepository repository) return an instance of Validator.

• AbstractRepositoryTask .....updates in progress
  • constructor now requires taskId (now immutable)
  • getIdentifyingLabel() -> getTaskKey()
  • getLastRefreshTimeInMinutes(Date) removed
  • no more static methods (use RepositoryTaskHandleUtil)
  • Replace this idiom:

   String handleIdentifier = AbstractRepositoryTask.getHandle(repository.getUrl(), taskId);
   ITask task = TasksUiPlugin.getTaskListManager().getTaskList().getTask(handle);

• • with:

   ITask task = TasksUiPlugin.getTaskListManager().getTaskList().getTask(repository.getUrl(), taskId);

• AbstractRepositoryTaskEditor
  • attributeChanged() Anything that needs to be saved must be in attribute form and passed to this method. Most if this is all done for you but if you override AbstractRepositoryTaskEditor.createCustomAttributeLayout() then you will want to ensure that attributeChanged is called upon editing. Utility method createTextField() handles this call.
  • createLabel() Utility method added. It will put an '*' at the front of the label if the attribute has been modified. Eventually this will be applied upon editing but currently only happens after re-freshing or re-opening the editor.
  • SECTION_NAME is an enum that holds default titles for the default sections. To override these default titles, set the appropriate (SECTION_NAME, new name) in alternateSectionLabels on AbstractRepositoryTaskEditor.
  • updateEditor() refreshes editor with new input in-place.

• AbstractRepositoryQuery
  • Constrctor no longer takes number of hits. Connectors can use QueryHitCollector.MAX_HITS (currently 5000) when setting max number of hits to return.

• AbstractQueryHit
  • setDescription(..) renamed to setSummary(..)

• AttributeContainer
  • getAttributeFactory() new method

• DateRangeContainer
  • getChildren() now returns set of underlying task objects (not DateRangeActivityDelegates which will be deprecated)
  • getDateRangeDelegates() returns the delegate formerly returned by getChildren()

• ITaskListElement: now extends java.lang.Comparable, so Collections support of sorting can be used, since task list elements have a natural ordering. Default implementations are provided for tasks and containers. (bug 171590)

• ITaskDataHandler
  • getChangedSinceLastSync() method moved to AbstractRepositoryConnector
  • New comment now held in an attribute: RepositoryTaskAttribute.COMMENT_NEW will need to update handler and factory to produce connector specific attribute
  • initializeTaskData(TaskRepository repository, RepositoryTaskData data, IProgressMonitor monitor) called by NewTaskWizard to initialize new taskData objects (currently only in use by Trac but will adopt).
  • getAttributeFactory(String repositoryUrl, String repositoryKind, String taskKind) signature changed
  • getDateForAttributeType(...) moved to AbstractAttributeFactory

• ITaskListExternalizer
  • readTask(..) renamed to createTask(..), no longer needs to set taskId, label, or repositoryUrl
• DelegatingTaskExternalizer
  • readTaskInfo(..) and readQueryHitInfo(..) are now called automatically and are private. Use your createTask(..) or createQueryHit(..) methods to customize reading additional attributes.

• TaskRepository
  • TaskRepository.isAnonymous()
  • TaskRepository.setAnonymous(boolean)
  • (-) TaskRepository.getDefaultProxy() (Renamed and moved to WebClientUtil.getPlatformProxy())

• RepositorySynchronizationManager
  • updateOfflineState is now saveIncoming and saveOutgoing.
  • discardOutgoing discards any pending outgoing changes

• RepositoryTaskAttribute
  • getID() -> getId()

• RepositoryTaskData
  • constructor now requires a task kind (string) (i.e. Task.DEFAULT_TASK_KIND)
  • getTaskKind return the task kind
  • setNew(boolean) signifies that this is unsubmitted task data. Used by editor factory to determine if existing or new editor to be opened.

• Task
  • getTooltipText(): deleted, not used
  • Due dates are now supported getDueDate(), setDueDate()
  • handleIdentifier: now private
  • get/setUrl are now get/setTaskUrl (to disambiguate with get/setRepositoryUrl())
  • getElapsedTime(): removed, not used
  • setElapsedTime(): removed, not used

• TaskEditor
  • protected void pageChange(intNewPageIndex) method removed (only called super)

• TaskList
  • getChangeListeners(): returns a Set instead of List

• TaskListImages
  • renamed to TasksUiImages (still an internal class, should move to API)

• TaskListManager
  • setDueDate() used to set due date on a task and cause notification of local info changed.
  • isDue(ITask) true if task's due date isn't null and date has past

• TasksUiUtil
  • openUrl(String url): moved to openBrowser(String url)

• QueryHitCollector
  • MAX_HITS constant can be used as standard default number of hits handled per query. User notified when >= hits returned.

Context API

• AbstractContextStore
  • notifyContextStoreMoved(): change to contextStoreMoved()
• AbstractContextStructureBridge
  • getDegreesOfSeparation(): moved to AbstractRelationProvider
  • getRelationshipProviders(): moved to extensions point, e.g.:

 <extension point="org.eclipse.mylar.context.core.bridges">
    <relationProvider
          class="org.eclipse.mylar.internal.java.search.JavaImplementorsProvider"
          contentType="java"/>
 </extension>

Monitor API

• MylarMonitorUiPlugin
  • (-) setInactivityTimeout(...)

• org.eclipse.mylar.monitor: split into monitor.core and monitor.ui, organize imports and update extension point IDs
• HandleObfuscator
  • moved to InteractionEventObfuscator

• org.eclipse.mylar.monitor.usage.core and org.eclipse.mylar.monitor.usage.ui
  • moved to ..mylar.monitor.core, ..mylar.monitor.usage and ..mylar.monitor.usage.internal