diff options
author | mkersten | 2007-06-23 00:37:57 +0000 |
---|---|---|
committer | mkersten | 2007-06-23 00:37:57 +0000 |
commit | 8104b39adcbc0fa7cc24c841fa897b73f430d0a3 (patch) | |
tree | 8acfc44e1e22393e55a16081cfab75062545aa32 /org.eclipse.mylyn.tasks.core/src | |
parent | 09f0db667d81f101a06d6ad664d47d3271371b17 (diff) | |
download | org.eclipse.mylyn.tasks-8104b39adcbc0fa7cc24c841fa897b73f430d0a3.tar.gz org.eclipse.mylyn.tasks-8104b39adcbc0fa7cc24c841fa897b73f430d0a3.tar.xz org.eclipse.mylyn.tasks-8104b39adcbc0fa7cc24c841fa897b73f430d0a3.zip |
NEW - bug 193842: [api] review Mylyn 2.0 APIs
https://bugs.eclipse.org/bugs/show_bug.cgi?id=193842
Diffstat (limited to 'org.eclipse.mylyn.tasks.core/src')
30 files changed, 96 insertions, 128 deletions
diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/LocalAttachment.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/LocalAttachment.java index b45f1584b..d8ed3448e 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/LocalAttachment.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/LocalAttachment.java @@ -9,7 +9,7 @@ * University Of British Columbia - initial API and implementation *******************************************************************************/ -package org.eclipse.mylyn.tasks.core; +package org.eclipse.mylyn.internal.tasks.core; import java.io.ByteArrayInputStream; import java.io.File; @@ -18,10 +18,14 @@ import java.io.IOException; import java.io.InputStream; import java.io.Serializable; +import org.eclipse.mylyn.tasks.core.ITaskAttachment; +import org.eclipse.mylyn.tasks.core.RepositoryTaskData; + /** * A class representing a local attachment. * * @author Jeff Pound + * @since 2.0 */ public class LocalAttachment implements Serializable, ITaskAttachment { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/ScheduledTaskDelegate.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/ScheduledTaskDelegate.java index f77be2d42..23b0132d8 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/ScheduledTaskDelegate.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/ScheduledTaskDelegate.java @@ -146,8 +146,8 @@ public class ScheduledTaskDelegate extends AbstractTask { return task.getScheduledForDate(); } - public String getTaskUrl() { - return task.getTaskUrl(); + public String getUrl() { + return task.getUrl(); } public boolean isReminded() { @@ -224,8 +224,8 @@ public class ScheduledTaskDelegate extends AbstractTask { task.setScheduledForDate(date); } - public void setTaskUrl(String url) { - task.setTaskUrl(url); + public void setUrl(String url) { + task.setUrl(url); } public int compareTo(AbstractTaskContainer taskListElement) { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskCategory.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/TaskCategory.java index 656e498b1..eeedb78ca 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskCategory.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/TaskCategory.java @@ -11,7 +11,9 @@ /* * Created on Dec 26, 2004 */ -package org.eclipse.mylyn.tasks.core; +package org.eclipse.mylyn.internal.tasks.core; + +import org.eclipse.mylyn.tasks.core.AbstractTaskCategory; /** diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryConnector.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryConnector.java index 9b3ad09de..5931a3e15 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryConnector.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryConnector.java @@ -244,8 +244,8 @@ public abstract class AbstractRepositoryConnector { existingTask.setPriority(queryHit.getPriority()); changed = true; } - if (hasTaskPropertyChanged(existingTask.getTaskUrl(), queryHit.getTaskUrl())) { - existingTask.setTaskUrl(queryHit.getTaskUrl()); + if (hasTaskPropertyChanged(existingTask.getUrl(), queryHit.getUrl())) { + existingTask.setUrl(queryHit.getUrl()); changed = true; } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryQuery.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryQuery.java index 2a4913b56..e4c925532 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryQuery.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractRepositoryQuery.java @@ -14,7 +14,7 @@ import org.eclipse.core.runtime.IStatus; import org.eclipse.mylyn.tasks.core.AbstractTask.PriorityLevel; /** - * Extend to provide a repository query that can be used in the Task List. + * A container that stores tasks from a specific repository. * * @author Mik Kersten * @author Eugene Kuleshov diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTask.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTask.java index 813f00bcc..1dc12c49d 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTask.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTask.java @@ -52,8 +52,6 @@ public abstract class AbstractTask extends AbstractTaskContainer { private boolean reminded = false; - private String taskUrl = ""; - private Set<AbstractTaskContainer> containers = new HashSet<AbstractTaskContainer>(); // ************ Synch **************** @@ -308,18 +306,7 @@ public abstract class AbstractTask extends AbstractTaskContainer { public void setPriority(String priority) { this.priority = priority; } - - /** - * TODO: consider removing - */ - public void setTaskUrl(String url) { - this.taskUrl = url; - } - - public String getTaskUrl() { - return taskUrl; - } - + public String getNotes() { // TODO: removed check for null once xml updated. if (notes == null) { @@ -412,7 +399,7 @@ public abstract class AbstractTask extends AbstractTaskContainer { } public boolean hasValidUrl() { - String taskUrl = getTaskUrl(); + String taskUrl = getUrl(); if (taskUrl != null && !taskUrl.equals("") && !taskUrl.equals("http://") && !taskUrl.equals("https://")) { try { new URL(taskUrl); diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskCategory.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskCategory.java index 3ebd3324d..074c7a992 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskCategory.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskCategory.java @@ -12,7 +12,10 @@ package org.eclipse.mylyn.tasks.core; /** + * A container that stores tasks from any repository. + * * @author Mik Kersten + * @since 2.0 */ public abstract class AbstractTaskCategory extends AbstractTaskContainer { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskContainer.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskContainer.java index d2c41e21a..a6342484f 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskContainer.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskContainer.java @@ -18,10 +18,11 @@ import org.eclipse.core.runtime.PlatformObject; import org.eclipse.mylyn.tasks.core.AbstractTask.PriorityLevel; /** - * Manipulate containers via TaskListManager + * Top-level Task List element that can contain other Task List elements. * * @author Mik Kersten - */ + * @since 2.0 + */ public abstract class AbstractTaskContainer extends PlatformObject implements Comparable<AbstractTaskContainer> { private String handle = ""; @@ -29,8 +30,7 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co private Set<AbstractTask> children = new CopyOnWriteArraySet<AbstractTask>(); /** - * Optional URL corresponding to the web resource associated with this - * container. + * Optional URL corresponding to the web resource associated with this container. */ protected String url = null; @@ -38,7 +38,7 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co assert handle != null; this.handle = handleAndDescription; } - + /** * Use {@link TaskList} methods instead. */ @@ -61,7 +61,7 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co public void clear() { children.clear(); } - + public Set<AbstractTask> getChildren() { return Collections.unmodifiableSet(children); } @@ -79,9 +79,6 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co return handle; } - /** - * @since 2.0 - */ public boolean isEmpty() { return children.isEmpty(); } @@ -90,10 +87,6 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co return handle; } - public void setDescription(String description) { - this.handle = description; - } - public void setHandleIdentifier(String handle) { this.handle = handle; } @@ -108,7 +101,7 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co } /** - * @return can be null + * @return can be null */ public String getUrl() { return url; @@ -130,7 +123,7 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co public String toString() { return "container: " + handle; } - + public String getPriority() { String highestPriority = PriorityLevel.P5.toString(); Set<AbstractTask> tasks = getChildren(); @@ -144,10 +137,9 @@ public abstract class AbstractTaskContainer extends PlatformObject implements Co } return highestPriority; } - + /** - * The handle for most containers is their summary. Override to specify a - * different natural ordering. + * The handle for most containers is their summary. Override to specify a different natural ordering. */ public int compareTo(AbstractTaskContainer taskListElement) { return getHandleIdentifier().compareTo(((AbstractTaskContainer) taskListElement).getHandleIdentifier()); diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskDataHandler.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskDataHandler.java index 7688ea517..02a3e3c69 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskDataHandler.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskDataHandler.java @@ -17,8 +17,11 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; /** + * Responsible for retrieving and posting task data to a repository. + * * @author Mik Kersten * @author Rob Elves + * @since 2.0 */ public abstract class AbstractTaskDataHandler { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskElement.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskElement.java deleted file mode 100644 index e69de29bb..000000000 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskElement.java +++ /dev/null diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskListFactory.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskListFactory.java index be1e8707c..ac0957ba8 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskListFactory.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AbstractTaskListFactory.java @@ -17,13 +17,14 @@ import java.util.Set; import org.w3c.dom.Element; /** - * When overriding these methods be sure not to perform network access since the Task List is read and written - * frequently. + * Responsible for storing and creating task list elements. + * + * When overriding these methods be sure not to perform network access since the Task List is + * read and written frequently. * * @author Mik Kersten * @author Ken Sueda - * - * TODO: consider merging tasks and categories + * @since 2.0 */ public abstract class AbstractTaskListFactory { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AttributeContainer.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AttributeContainer.java index 33f0ade10..c54a2c40b 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AttributeContainer.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/AttributeContainer.java @@ -20,7 +20,10 @@ import java.util.List; import org.eclipse.mylyn.internal.monitor.core.util.StatusManager; /** + * Encapsulates attributes for task data. + * * @author Rob Elves + * @since 2.0 */ public class AttributeContainer implements Serializable { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/FileAttachment.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/FileAttachment.java index a89a3139c..8228720b1 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/FileAttachment.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/FileAttachment.java @@ -17,7 +17,10 @@ import java.io.IOException; import java.io.InputStream; /** + * Proxy for a file attachment. + * * @author Steffen Pingel + * @since 2.0 */ public class FileAttachment implements ITaskAttachment { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ILinkedTaskInfo.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ILinkedTaskInfo.java index 8d911b020..635378796 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ILinkedTaskInfo.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ILinkedTaskInfo.java @@ -12,15 +12,16 @@ package org.eclipse.mylyn.tasks.core; /** - * Task information linked to artifacts from version control integration + * Task information linking tasks to resources. * * @author Eugene Kuleshov + * @since 2.0 */ public interface ILinkedTaskInfo { public abstract String getTaskId(); - public abstract String getTaskFullUrl(); + public abstract String getTaskUrl(); public abstract String getRepositoryUrl(); diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryConstants.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryConstants.java index 71a1b73ae..abfa9d132 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryConstants.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryConstants.java @@ -10,6 +10,7 @@ package org.eclipse.mylyn.tasks.core; /** * @author Mik Kersten + * @since 2.0 */ public interface IRepositoryConstants { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskActivityListener.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskActivityListener.java index aec96dfbc..06dad72d1 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskActivityListener.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskActivityListener.java @@ -13,10 +13,12 @@ package org.eclipse.mylyn.tasks.core; import org.eclipse.mylyn.internal.tasks.core.ScheduledTaskContainer; - /** + * Notified of task activity changes. + * * @author Mik Kersten * @author Rob Elves + * @since 2.0 */ public interface ITaskActivityListener { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskAttachment.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskAttachment.java index 507ef9a31..2c23bb304 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskAttachment.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskAttachment.java @@ -15,7 +15,10 @@ import java.io.IOException; import java.io.InputStream; /** + * Encapsualtes resources that can be attached to a task. + * * @author Steffen Pingel + * @since 2.0 */ public interface ITaskAttachment { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskCollector.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskCollector.java index a950c22b7..586cc8c71 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskCollector.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskCollector.java @@ -16,13 +16,16 @@ import java.util.Set; import org.eclipse.core.runtime.CoreException; /** + * Abstraction used for collecting tasks, e.g. when performing queries on the repository. + * * @author Rob Elves + * @since 2.0 */ public interface ITaskCollector { - void accept(AbstractTask task); + public void accept(AbstractTask task); - void accept(RepositoryTaskData taskData) throws CoreException; + public void accept(RepositoryTaskData taskData) throws CoreException; - public Set<AbstractTask> getTaskHits(); + public Set<AbstractTask> getTasks(); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskFactory.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskFactory.java index 68583a7ad..baa6e06f5 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskFactory.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskFactory.java @@ -13,7 +13,10 @@ import org.eclipse.core.runtime.IProgressMonitor; /** + * Used for creating tasks from repository task data. + * * @author Rob Elves + * @since 2.0 */ public interface ITaskFactory { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListChangeListener.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListChangeListener.java index b12af7eeb..9be1beb1d 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListChangeListener.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListChangeListener.java @@ -18,6 +18,7 @@ import java.util.Set; * Listener for task list modifications and task content modifications. * * @author Mik Kersten + * @since 2.0 */ public interface ITaskListChangeListener { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListExternalizer.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListExternalizer.java deleted file mode 100644 index febdc5cd2..000000000 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskListExternalizer.java +++ /dev/null @@ -1,63 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2004 - 2006 University Of British Columbia and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * University Of British Columbia - initial API and implementation - *******************************************************************************/ - -package org.eclipse.mylyn.tasks.core; - -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; - -/** - * Used to externalize things like tasks and bug reports along with the task - * list so that information about them can be persisted across invocations. - * - * @author Mik Kersten - * @author Ken Sueda - * - * TODO: consider merging tasks and categories - */ -public interface ITaskListExternalizer { - - public abstract String getCategoryTagName(); - - public abstract String getTaskTagName(); - - public abstract String getQueryTagNameForElement(AbstractRepositoryQuery query); - - /** - * @return the element that was created, null if failed - */ - public abstract Element createCategoryElement(AbstractTaskContainer category, Document doc, Element parent); - - public abstract boolean canCreateElementFor(AbstractTask task); - - /** - * @return the element that was created, null if failed - */ - public abstract Element createTaskElement(AbstractTask task, Document doc, Element parent); - - public abstract boolean canReadCategory(Node node); - - public abstract void readCategory(Node node, TaskList taskList) throws TaskExternalizationException; - - public abstract boolean canReadTask(Node node); - - public abstract AbstractTask createTask(String repositoryUrl, String taskId, String summary, Element element, - TaskList tlist, AbstractTaskContainer category, AbstractTask parent) throws TaskExternalizationException; - - public abstract boolean canCreateElementFor(AbstractRepositoryQuery category); - - public abstract Element createQueryElement(AbstractRepositoryQuery query, Document doc, Element parent); - - public abstract boolean canReadQuery(Node node); - - public abstract AbstractRepositoryQuery readQuery(Node node, TaskList tlist) throws TaskExternalizationException; -} diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskRepositoryListener.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskRepositoryListener.java index fccb69c9b..9880e59b3 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskRepositoryListener.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskRepositoryListener.java @@ -13,7 +13,10 @@ package org.eclipse.mylyn.tasks.core; /** + * Notified of change to task repositories. + * * @author Mik Kersten + * @since 2.0 */ public interface ITaskRepositoryListener { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/QueryHitCollector.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/QueryHitCollector.java index b22fba5e1..844c9503a 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/QueryHitCollector.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/QueryHitCollector.java @@ -17,11 +17,12 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.NullProgressMonitor; /** - * Collects QueryHits resulting from repository search + * Collects QueryHits resulting from repository search. * * @author Shawn Minto * @author Rob Elves (generalized from bugzilla) * @author Steffen Pingel + * @since 2.0 */ public class QueryHitCollector implements ITaskCollector { @@ -57,7 +58,7 @@ public class QueryHitCollector implements ITaskCollector { } } - public Set<AbstractTask> getTaskHits() { + public Set<AbstractTask> getTasks() { return taskResults; } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryAttachment.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryAttachment.java index 5a46347a6..e25cf83e3 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryAttachment.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryAttachment.java @@ -14,8 +14,11 @@ package org.eclipse.mylyn.tasks.core; import java.io.Serializable; /** + * Encapsulates a file or other resource attached to a task. + * * @author Rob Elves * @author Mik Kersten + * @since 2.0 */ public class RepositoryAttachment extends AttributeContainer implements Serializable { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryOperation.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryOperation.java index c09cb20d8..f51f00da8 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryOperation.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryOperation.java @@ -21,7 +21,10 @@ import java.util.Map; * A representation of an operation that can be done to the bug when it is * submitted * + * NOTE: likely to change for 3.0 + * * @author Shawn Minto + * @since 2.0 */ public class RepositoryOperation implements Serializable { /** @@ -214,5 +217,4 @@ public class RepositoryOperation implements Serializable { public void setInputValue(String inputValue) { this.inputValue = inputValue; } - } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryStatus.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryStatus.java index 4f512f2d6..a4f668ba5 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryStatus.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryStatus.java @@ -16,8 +16,11 @@ import org.eclipse.core.runtime.Status; import org.eclipse.osgi.util.NLS; /** + * Utility for working and capturing status specific to repository connections. + * * @author Rob Elves * @author Steffen Pingel + * @since 2.0 */ public class RepositoryStatus extends Status { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskAttribute.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskAttribute.java index c7e8fea36..e4163766f 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskAttribute.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskAttribute.java @@ -19,10 +19,10 @@ import java.util.List; import java.util.Map; /** - * Class representing a report attribute + * Encapsulates common task attributes. * * @author Rob Elves - * + * @since 2.0 */ public class RepositoryTaskAttribute implements Serializable { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskData.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskData.java index b2af155e5..4fcda62d3 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskData.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTaskData.java @@ -25,6 +25,7 @@ import org.eclipse.mylyn.internal.tasks.core.RepositoryTaskHandleUtil; * * @author Mik Kersten * @author Rob Elves + * @since 2.0 */ public final class RepositoryTaskData extends AttributeContainer implements Serializable { @@ -204,11 +205,11 @@ public final class RepositoryTaskData extends AttributeContainer implements Seri repositoryOperations.add(o); } - public List<String> getCC() { + public List<String> getCc() { return getAttributeValues(RepositoryTaskAttribute.USER_CC); } - public void removeCC(String email) { + public void removeCc(String email) { removeAttributeValue(RepositoryTaskAttribute.USER_CC, email); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTemplate.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTemplate.java index e3f537925..2e0c64560 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTemplate.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryTemplate.java @@ -15,8 +15,11 @@ import java.util.LinkedHashMap; import java.util.Map; /** + * Specifies attributes for a task repository. + * * @author Eugene Kuleshov * @author Steffen Pingel + * @since 2.0 */ public class RepositoryTemplate { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskList.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskList.java index 0b29b1242..686ff3e62 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskList.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskList.java @@ -26,6 +26,7 @@ import org.eclipse.mylyn.internal.monitor.core.util.StatusManager; import org.eclipse.mylyn.internal.tasks.core.LocalTask; import org.eclipse.mylyn.internal.tasks.core.RepositoryTaskHandleUtil; import org.eclipse.mylyn.internal.tasks.core.TaskArchive; +import org.eclipse.mylyn.internal.tasks.core.TaskCategory; import org.eclipse.mylyn.internal.tasks.core.UnfiledCategory; /** @@ -178,9 +179,9 @@ public class TaskList { repositoryTask.setRepositoryUrl(newRepositoryUrl); tasks.put(repositoryTask.getHandleIdentifier(), repositoryTask); - String taskUrl = repositoryTask.getTaskUrl(); + String taskUrl = repositoryTask.getUrl(); if (taskUrl.startsWith(oldRepositoryUrl)) { - repositoryTask.setTaskUrl(newRepositoryUrl + taskUrl.substring(oldRepositoryUrl.length())); + repositoryTask.setUrl(newRepositoryUrl + taskUrl.substring(oldRepositoryUrl.length())); } } } @@ -235,12 +236,14 @@ public class TaskList { return; } else if (!(container instanceof TaskArchive) && !(container instanceof UnfiledCategory)) { if (queries.remove(container.getHandleIdentifier()) != null) { - container.setDescription(newDescription); - if (container instanceof AbstractRepositoryQuery) { + if (container instanceof AbstractTaskCategory) { + ((AbstractTaskCategory)container).setHandleIdentifier(newDescription); + } else if (container instanceof AbstractRepositoryQuery) { + ((AbstractRepositoryQuery)container).setHandleIdentifier(newDescription); this.addQuery((AbstractRepositoryQuery) container); } } else if (container instanceof TaskCategory && categories.remove(container.getHandleIdentifier()) != null) { - container.setDescription(newDescription); + ((TaskCategory)container).setHandleIdentifier(newDescription); this.addCategory((TaskCategory) container); } } @@ -494,7 +497,7 @@ public class TaskList { public AbstractTask getRepositoryTask(String taskUrl) { for (AbstractTask currTask : tasks.values()) { if (currTask instanceof AbstractTask) { - String currUrl = ((AbstractTask) currTask).getTaskUrl(); + String currUrl = ((AbstractTask) currTask).getUrl(); if (currUrl != null && !currUrl.equals("") && currUrl.equals(taskUrl)) { return (AbstractTask) currTask; } |