diff options
author | spingel | 2008-06-18 22:14:48 +0000 |
---|---|---|
committer | spingel | 2008-06-18 22:14:48 +0000 |
commit | 922e24c0451fda04be290a6c3757e77e02ac4e77 (patch) | |
tree | cfbc9dceedcea465b81ec286bb704c7a07f8925f | |
parent | 2d016a8e121a21c5c70205a7d13075875dd7d528 (diff) | |
download | org.eclipse.mylyn.tasks-922e24c0451fda04be290a6c3757e77e02ac4e77.tar.gz org.eclipse.mylyn.tasks-922e24c0451fda04be290a6c3757e77e02ac4e77.tar.xz org.eclipse.mylyn.tasks-922e24c0451fda04be290a6c3757e77e02ac4e77.zip |
NEW - bug 235062: [api] add API tooling tags to JavaDoc
https://bugs.eclipse.org/bugs/show_bug.cgi?id=235062
37 files changed, 415 insertions, 10 deletions
diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryListener.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryListener.java index 0ae937ce1..5b6f70013 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryListener.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryListener.java @@ -9,7 +9,7 @@ package org.eclipse.mylyn.tasks.core; /** - * Notified of change to the lifecycle of task repositories. + * Notified of change to the life-cycle of task repositories. * * @author Mik Kersten * @since 3.0 diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryManager.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryManager.java index 67c6e4934..a87fd1b80 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryManager.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryManager.java @@ -15,6 +15,7 @@ import java.util.Set; /** * @author Steffen Pingel * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IRepositoryManager { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryModel.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryModel.java index 703797c80..e6560163c 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryModel.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryModel.java @@ -15,12 +15,24 @@ package org.eclipse.mylyn.tasks.core; */ public interface IRepositoryModel { + /** + * @since 3.0 + */ public abstract IRepositoryQuery createRepositoryQuery(TaskRepository taskRepository); + /** + * @since 3.0 + */ public abstract ITask createTask(TaskRepository taskRepository, String taskId); + /** + * @since 3.0 + */ public abstract ITask getTask(TaskRepository taskRepository, String taskId); + /** + * @since 3.0 + */ public abstract ITask getTask(String handle); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryPerson.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryPerson.java index 58ea2391f..d0751fd24 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryPerson.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryPerson.java @@ -11,19 +11,38 @@ package org.eclipse.mylyn.tasks.core; /** * @author Steffen Pingel * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IRepositoryPerson { + /** + * @since 3.0 + */ public abstract String getConnectorKind(); + /** + * @since 3.0 + */ public abstract String getName(); + /** + * @since 3.0 + */ public abstract String getPersonId(); + /** + * @since 3.0 + */ public abstract String getRepositoryUrl(); + /** + * @since 3.0 + */ public abstract TaskRepository getTaskRepository(); + /** + * @since 3.0 + */ public abstract void setName(String name); }
\ No newline at end of file diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryQuery.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryQuery.java index e3bb5b66a..44568551f 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryQuery.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/IRepositoryQuery.java @@ -10,6 +10,7 @@ package org.eclipse.mylyn.tasks.core; /** * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IRepositoryQuery extends IAttributeContainer { @@ -18,14 +19,29 @@ public interface IRepositoryQuery extends IAttributeContainer { */ public abstract String getConnectorKind(); + /** + * @since 3.0 + */ public abstract String getRepositoryUrl(); + /** + * @since 3.0 + */ public abstract String getUrl(); + /** + * @since 3.0 + */ public abstract void setUrl(String url); + /** + * @since 3.0 + */ public abstract String getSummary(); + /** + * @since 3.0 + */ public abstract void setSummary(String summary); }
\ No newline at end of file diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITask.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITask.java index 0077c0dd5..26852aae9 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITask.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITask.java @@ -14,6 +14,7 @@ import java.util.Date; * @author Mik Kersten * @author Steffen Pingel * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface ITask extends IRepositoryElement, IAttributeContainer { 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 cabf4d0a4..b998021d9 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,6 +15,7 @@ import org.eclipse.mylyn.tasks.core.data.TaskAttribute; /** * @author Steffen Pingel * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface ITaskAttachment { @@ -88,6 +89,9 @@ public interface ITaskAttachment { */ public abstract boolean isDeprecated(); + /** + * @since 3.0 + */ public abstract boolean isPatch(); /** diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskComment.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskComment.java index 554c144cc..11694f741 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskComment.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/ITaskComment.java @@ -13,39 +13,87 @@ import java.util.Date; import org.eclipse.mylyn.tasks.core.data.TaskAttribute; /** + * A comment posted by a user on a task. + * * @author Steffen Pingel * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface ITaskComment { + /** + * @since 3.0 + */ public abstract IRepositoryPerson getAuthor(); + /** + * @since 3.0 + */ public abstract String getConnectorKind(); + /** + * @since 3.0 + */ public abstract Date getCreationDate(); + /** + * @since 3.0 + */ public abstract int getNumber(); + /** + * @since 3.0 + */ public abstract String getRepositoryUrl(); + /** + * @since 3.0 + */ public abstract ITask getTask(); + /** + * @since 3.0 + */ public abstract TaskAttribute getTaskAttribute(); + /** + * @since 3.0 + */ public abstract TaskRepository getTaskRepository(); + /** + * @since 3.0 + */ public abstract String getText(); + /** + * @since 3.0 + */ public abstract String getUrl(); + /** + * @since 3.0 + */ public abstract void setAuthor(IRepositoryPerson author); + /** + * @since 3.0 + */ public abstract void setCreationDate(Date creationDate); + /** + * @since 3.0 + */ public abstract void setNumber(int number); + /** + * @since 3.0 + */ public abstract void setText(String text); + /** + * @since 3.0 + */ public abstract void setUrl(String url); }
\ No newline at end of file diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryResponse.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryResponse.java index 46ac789d0..78a0e7f49 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryResponse.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/RepositoryResponse.java @@ -9,6 +9,8 @@ package org.eclipse.mylyn.tasks.core; /** + * Clients may subclass. + * * @author Steffen Pingel * @since 3.0 */ diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskMapping.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskMapping.java index a158c7298..5b8feaec3 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskMapping.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskMapping.java @@ -15,115 +15,183 @@ import org.eclipse.mylyn.tasks.core.ITask.PriorityLevel; import org.eclipse.mylyn.tasks.core.data.TaskData; /** + * Clients may subclass. + * * @author Steffen Pingel * @since 3.0 */ public class TaskMapping implements ITaskMapping { + /** + * @since 3.0 + */ public void merge(ITaskMapping source) { // ignore } + /** + * @since 3.0 + */ public Date getCompletionDate() { // ignore return null; } + /** + * @since 3.0 + */ public String getComponent() { // ignore return null; } + /** + * @since 3.0 + */ public Date getCreationDate() { // ignore return null; } + /** + * @since 3.0 + */ public String getDescription() { // ignore return null; } + /** + * @since 3.0 + */ public Date getDueDate() { // ignore return null; } + /** + * @since 3.0 + */ public Date getModificationDate() { // ignore return null; } + /** + * @since 3.0 + */ public String getOwner() { // ignore return null; } + /** + * @since 3.0 + */ public PriorityLevel getPriorityLevel() { // ignore return null; } + /** + * @since 3.0 + */ public String getProduct() { // ignore return null; } + /** + * @since 3.0 + */ public String getSummary() { // ignore return null; } + /** + * @since 3.0 + */ public TaskData getTaskData() { // ignore return null; } + /** + * @since 3.0 + */ public String getTaskKey() { // ignore return null; } + /** + * @since 3.0 + */ public String getTaskKind() { // ignore return null; } + /** + * @since 3.0 + */ public String getTaskUrl() { // ignore return null; } + /** + * @since 3.0 + */ public List<String> getCc() { // ignore return null; } + /** + * @since 3.0 + */ public List<String> getKeywords() { // ignore return null; } + /** + * @since 3.0 + */ public String getReporter() { // ignore return null; } + /** + * @since 3.0 + */ public String getResolution() { // ignore return null; } + /** + * @since 3.0 + */ public String getTaskStatus() { // ignore return null; } + /** + * @since 3.0 + */ public String getStatus() { // ignore return null; } + /** + * @since 3.0 + */ public String getPriority() { // ignore return null; diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskRepository.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskRepository.java index db94a6f12..fe1ae3140 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskRepository.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/TaskRepository.java @@ -50,6 +50,7 @@ import org.eclipse.mylyn.internal.tasks.core.RepositoryPerson; * @author Eugene Kuleshov * @author Steffen Pingel * @since 2.0 + * @noextend This class is not intended to be subclassed by clients. */ @SuppressWarnings("deprecation") public final class TaskRepository extends PlatformObject { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentHandler.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentHandler.java index b48bdb871..67cc4c1b7 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentHandler.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentHandler.java @@ -16,7 +16,7 @@ import org.eclipse.mylyn.tasks.core.ITask; import org.eclipse.mylyn.tasks.core.TaskRepository; /** - * Extend to provide facility for uploading and downloading files from task repositories. + * Subclass to provide facility for uploading and downloading files from task repositories. * * @author Steffen Pingel * @since 3.0 @@ -27,8 +27,8 @@ public abstract class AbstractTaskAttachmentHandler { public abstract boolean canPostContent(TaskRepository repository, ITask task); - public abstract InputStream getContent(TaskRepository repository, ITask task, - TaskAttribute attachmentAttribute, IProgressMonitor monitor) throws CoreException; + public abstract InputStream getContent(TaskRepository repository, ITask task, TaskAttribute attachmentAttribute, + IProgressMonitor monitor) throws CoreException; public abstract void postContent(TaskRepository repository, ITask task, AbstractTaskAttachmentSource source, String comment, TaskAttribute attachmentAttribute, IProgressMonitor monitor) throws CoreException; diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentSource.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentSource.java index 42e891bee..c915fc767 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentSource.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskAttachmentSource.java @@ -14,6 +14,8 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; /** + * Clients may subclass. + * * @author Steffen Pingel * @since 3.0 */ diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskDataHandler.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskDataHandler.java index 32780c583..77de3fc21 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskDataHandler.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/AbstractTaskDataHandler.java @@ -18,7 +18,7 @@ import org.eclipse.mylyn.tasks.core.RepositoryResponse; import org.eclipse.mylyn.tasks.core.TaskRepository; /** - * Responsible for retrieving and posting task data to a repository. + * Responsible for retrieving and posting task data to a repository. Clients may subclass. * * @author Mik Kersten * @author Rob Elves diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataManager.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataManager.java index 326dc7d3e..1342675b2 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataManager.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataManager.java @@ -15,20 +15,38 @@ import org.eclipse.mylyn.tasks.core.TaskRepository; /** * @author Steffen Pingel * @since 3.0 - * @noimplement + * @noimplement This interface is not intended to be implemented by clients. */ public interface ITaskDataManager { + /** + * @since 3.0 + */ public ITaskDataWorkingCopy createWorkingCopy(ITask task, TaskData taskData); + /** + * @since 3.0 + */ public abstract ITaskDataWorkingCopy getWorkingCopy(ITask task) throws CoreException; + /** + * @since 3.0 + */ public abstract void discardEdits(ITask task) throws CoreException; + /** + * @since 3.0 + */ public abstract TaskData getTaskData(ITask task) throws CoreException; + /** + * @since 3.0 + */ public abstract TaskData getTaskData(TaskRepository task, String taskId) throws CoreException; + /** + * @since 3.0 + */ public abstract boolean hasTaskData(ITask task); }
\ No newline at end of file diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataWorkingCopy.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataWorkingCopy.java index cd2b88a38..c9c587c3f 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataWorkingCopy.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataWorkingCopy.java @@ -16,29 +16,63 @@ import org.eclipse.core.runtime.IProgressMonitor; /** * @author Steffen Pingel * @since 3.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface ITaskDataWorkingCopy { + /** + * @since 3.0 + */ public abstract TaskData getEditsData(); + /** + * @since 3.0 + */ public abstract TaskData getLastReadData(); + /** + * @since 3.0 + */ public abstract TaskData getLocalData(); + /** + * @since 3.0 + */ public abstract TaskData getRepositoryData(); + /** + * @since 3.0 + */ public abstract boolean isSaved(); + /** + * @since 3.0 + */ public abstract void revert(); + /** + * @since 3.0 + */ public abstract void refresh(IProgressMonitor monitor) throws CoreException; + /** + * @since 3.0 + */ public abstract void save(Set<TaskAttribute> edits, IProgressMonitor monitor) throws CoreException; + /** + * @since 3.0 + */ public abstract String getConnectorKind(); + /** + * @since 3.0 + */ public abstract String getRepositoryUrl(); + /** + * @since 3.0 + */ public abstract String getTaskId(); }
\ No newline at end of file diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttribute.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttribute.java index dd5ea63a0..139a596e9 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttribute.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttribute.java @@ -22,6 +22,7 @@ import org.eclipse.core.runtime.Assert; * @author Rob Elves * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public final class TaskAttribute { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttributeMetaData.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttributeMetaData.java index 77f67b6cf..01480f0aa 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttributeMetaData.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskAttributeMetaData.java @@ -13,6 +13,7 @@ import java.util.Map; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public class TaskAttributeMetaData { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskCommentMapper.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskCommentMapper.java index 4c8d8ef15..cdf003166 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskCommentMapper.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskCommentMapper.java @@ -15,8 +15,6 @@ import org.eclipse.mylyn.tasks.core.IRepositoryPerson; import org.eclipse.mylyn.tasks.core.ITaskComment; /** - * A comment posted by a user on a task. - * * @author Rob Elves * @author Steffen Pingel * @since 3.0 diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskData.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskData.java index e1e8b88ab..a59ff2d22 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskData.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskData.java @@ -13,6 +13,7 @@ import org.eclipse.core.runtime.Assert; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public final class TaskData { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModel.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModel.java index af33ead29..df6d1a652 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModel.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModel.java @@ -29,6 +29,7 @@ import org.eclipse.mylyn.tasks.core.data.TaskDataModelEvent.EventKind; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public class TaskDataModel { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelEvent.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelEvent.java index 231141502..e275dfdc0 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelEvent.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelEvent.java @@ -11,6 +11,8 @@ package org.eclipse.mylyn.tasks.core.data; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public final class TaskDataModelEvent { diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelListener.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelListener.java index 72d47d42c..c234417a9 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelListener.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskDataModelListener.java @@ -14,6 +14,9 @@ package org.eclipse.mylyn.tasks.core.data; */ public abstract class TaskDataModelListener { + /** + * @since 3.0 + */ public abstract void attributeChanged(TaskDataModelEvent event); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskOperation.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskOperation.java index d75a07b1d..e0d3f2f6e 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskOperation.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskOperation.java @@ -17,12 +17,18 @@ import org.eclipse.core.runtime.Assert; */ public class TaskOperation { + /** + * @since 3.0 + */ public static void applyTo(TaskAttribute taskAttribute, String operationId, String label) { TaskData taskData = taskAttribute.getTaskData(); taskData.getAttributeMapper().setValue(taskAttribute, operationId); taskAttribute.getMetaData().defaults().setType(TaskAttribute.TYPE_OPERATION).setLabel(label); } + /** + * @since 3.0 + */ public static TaskOperation createFrom(TaskAttribute taskAttribute) { Assert.isNotNull(taskAttribute); TaskData taskData = taskAttribute.getTaskData(); @@ -45,6 +51,9 @@ public class TaskOperation { private final String taskId; + /** + * @since 3.0 + */ public TaskOperation(String connectorKind, String repositoryUrl, String taskId, String operationId) { Assert.isNotNull(connectorKind); Assert.isNotNull(repositoryUrl); @@ -83,14 +92,23 @@ public class TaskOperation { return true; } + /** + * @since 3.0 + */ public String getConnectorKind() { return connectorKind; } + /** + * @since 3.0 + */ public String getLabel() { return label; } + /** + * @since 3.0 + */ public String getOperationId() { return operationId; } @@ -99,10 +117,16 @@ public class TaskOperation { return repositoryUrl; } + /** + * @since 3.0 + */ public TaskAttribute getTaskAttribute() { return taskAttribute; } + /** + * @since 3.0 + */ public String getTaskId() { return taskId; } @@ -118,10 +142,16 @@ public class TaskOperation { return result; } + /** + * @since 3.0 + */ public void setLabel(String label) { this.label = label; } + /** + * @since 3.0 + */ public void setTaskAttribute(TaskAttribute taskAttribute) { this.taskAttribute = taskAttribute; } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskRelation.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskRelation.java index 5f991a8b8..2e96db6f9 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskRelation.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/TaskRelation.java @@ -22,10 +22,16 @@ public class TaskRelation { private final Direction direction; + /** + * @since 3.0 + */ public enum Direction { INWARD, OUTWARD }; + /** + * @since 3.0 + */ public enum Kind { CONTAINMENT, DEPENDENCY, DUPLICATE } @@ -39,26 +45,44 @@ public class TaskRelation { this.taskId = taskId; } + /** + * @since 3.0 + */ public String getTaskId() { return taskId; } + /** + * @since 3.0 + */ public Kind getKind() { return kind; } + /** + * @since 3.0 + */ public Direction getDirection() { return direction; } + /** + * @since 3.0 + */ public static TaskRelation parentTask(String taskId) { return new TaskRelation(Kind.CONTAINMENT, Direction.INWARD, taskId); } + /** + * @since 3.0 + */ public static TaskRelation subtask(String taskId) { return new TaskRelation(Kind.CONTAINMENT, Direction.OUTWARD, taskId); } + /** + * @since 3.0 + */ public static TaskRelation dependency(String taskId, Direction direction) { return new TaskRelation(Kind.DEPENDENCY, direction, taskId); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/ISynchronizationSession.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/ISynchronizationSession.java index 65fd0643e..016289212 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/ISynchronizationSession.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/ISynchronizationSession.java @@ -20,33 +20,73 @@ import org.eclipse.mylyn.tasks.core.data.TaskData; /** * @since 3.0 * @author Steffen Pingel + * @noimplement This interface is not intended to be implemented by clients. */ public interface ISynchronizationSession { + /** + * @since 3.0 + */ public abstract Set<ITask> getChangedTasks(); + /** + * @since 3.0 + */ public abstract Object getData(); + /** + * @since 3.0 + */ public abstract IStatus getStatus(); + /** + * @since 3.0 + */ public abstract ITaskDataManager getTaskDataManager(); + /** + * @since 3.0 + */ public abstract TaskRepository getTaskRepository(); + /** + * @since 3.0 + */ public abstract Set<ITask> getTasks(); + /** + * @since 3.0 + */ public abstract boolean isFullSynchronization(); + /** + * @since 3.0 + */ public abstract boolean isUser(); + /** + * @since 3.0 + */ public abstract boolean needsPerformQueries(); + /** + * @since 3.0 + */ public abstract void setData(Object data); + /** + * @since 3.0 + */ public abstract void setNeedsPerformQueries(boolean performQueries); + /** + * @since 3.0 + */ public abstract void markStale(ITask task); + /** + * @since 3.0 + */ public abstract void putTaskData(ITask task, TaskData taskData) throws CoreException; }
\ No newline at end of file diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJob.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJob.java index 7f841d291..dc6966331 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJob.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJob.java @@ -26,27 +26,43 @@ import org.eclipse.mylyn.tasks.core.ITask; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public abstract class SubmitJob extends TaskJob { private final List<SubmitJobListener> submitJobListeners = Collections.synchronizedList(new ArrayList<SubmitJobListener>()); + /** + * @since 3.0 + */ public SubmitJob(String name) { super(name); } + /** + * @since 3.0 + */ public void addSubmitJobListener(SubmitJobListener listener) { submitJobListeners.add(listener); } + /** + * @since 3.0 + */ public void removeSubmitJobListener(SubmitJobListener listener) { submitJobListeners.remove(listener); } + /** + * @since 3.0 + */ protected SubmitJobListener[] getSubmitJobListeners() { return submitJobListeners.toArray(new SubmitJobListener[0]); } + /** + * @since 3.0 + */ protected void fireTaskSubmitted(final IProgressMonitor monitor) throws CoreException { SubmitJobListener[] listeners = submitJobListeners.toArray(new SubmitJobListener[0]); if (listeners.length > 0) { @@ -57,6 +73,9 @@ public abstract class SubmitJob extends TaskJob { } } + /** + * @since 3.0 + */ protected void fireTaskSynchronized(final IProgressMonitor monitor) throws CoreException { SubmitJobListener[] listeners = submitJobListeners.toArray(new SubmitJobListener[0]); if (listeners.length > 0) { @@ -67,6 +86,9 @@ public abstract class SubmitJob extends TaskJob { } } + /** + * @since 3.0 + */ protected void fireDone() { SubmitJobListener[] listeners = submitJobListeners.toArray(new SubmitJobListener[0]); if (listeners.length > 0) { @@ -85,6 +107,9 @@ public abstract class SubmitJob extends TaskJob { } } + /** + * @since 3.0 + */ public abstract ITask getTask(); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobEvent.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobEvent.java index 3cb5ec2f0..f297d21bc 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobEvent.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobEvent.java @@ -11,15 +11,23 @@ package org.eclipse.mylyn.tasks.core.sync; /** * @author Steffen Pingel * @since 3.0 + * @noinstantiate This class is not intended to be instantiated by clients. + * @noextend This class is not intended to be subclassed by clients. */ public class SubmitJobEvent { private final SubmitJob job; + /** + * @since 3.0 + */ public SubmitJobEvent(SubmitJob job) { this.job = job; } + /** + * @since 3.0 + */ public SubmitJob getJob() { return job; } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobListener.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobListener.java index c9d14b4c1..0b1ba53be 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobListener.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SubmitJobListener.java @@ -17,10 +17,19 @@ import org.eclipse.core.runtime.IProgressMonitor; */ public abstract class SubmitJobListener { + /** + * @since 3.0 + */ public abstract void taskSubmitted(SubmitJobEvent event, IProgressMonitor monitor) throws CoreException; + /** + * @since 3.0 + */ public abstract void taskSynchronized(SubmitJobEvent event, IProgressMonitor monitor) throws CoreException; + /** + * @since 3.0 + */ public abstract void done(SubmitJobEvent event); } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SynchronizationJob.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SynchronizationJob.java index 8a48ed7cf..d468ebcb6 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SynchronizationJob.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/SynchronizationJob.java @@ -13,6 +13,7 @@ import org.eclipse.core.runtime.jobs.Job; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public abstract class SynchronizationJob extends Job { @@ -20,6 +21,9 @@ public abstract class SynchronizationJob extends Job { private boolean fullSynchronization = false; + /** + * @since 3.0 + */ public SynchronizationJob(String name) { super(name); } @@ -28,6 +32,9 @@ public abstract class SynchronizationJob extends Job { // return changedTasksSynchronization; // } + /** + * @since 3.0 + */ public boolean isFullSynchronization() { return fullSynchronization; } @@ -36,6 +43,9 @@ public abstract class SynchronizationJob extends Job { // this.changedTasksSynchronization = synchronizeChangedTasks; // } + /** + * @since 3.0 + */ public void setFullSynchronization(boolean fullSynchronization) { this.fullSynchronization = fullSynchronization; } diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/TaskJob.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/TaskJob.java index 0af04b3e5..f8b143117 100644 --- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/TaskJob.java +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/sync/TaskJob.java @@ -14,13 +14,20 @@ import org.eclipse.core.runtime.jobs.Job; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public abstract class TaskJob extends Job { + /** + * @since 3.0 + */ public TaskJob(String name) { super(name); } + /** + * @since 3.0 + */ public abstract IStatus getStatus(); } diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/LegendElement.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/LegendElement.java index 500748a7e..5a4e1b028 100644 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/LegendElement.java +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/LegendElement.java @@ -15,9 +15,13 @@ import org.eclipse.swt.graphics.Image; /** * @author Steffen Pingel * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public class LegendElement { + /** + * @since 3.0 + */ public static LegendElement createTask(String label, ImageDescriptor overlay) { return new LegendElement(label, CommonImages.getCompositeTaskImage(TasksUiImages.TASK, overlay, false)); } @@ -31,13 +35,22 @@ public class LegendElement { this.image = image; } + /** + * @since 3.0 + */ public void dispose() { } + /** + * @since 3.0 + */ public Image getImage() { return image; } + /** + * @since 3.0 + */ public String getLabel() { return label; } diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskElementLabelProvider.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskElementLabelProvider.java index 16cb82415..519a889e9 100644 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskElementLabelProvider.java +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskElementLabelProvider.java @@ -45,6 +45,7 @@ import org.eclipse.ui.themes.IThemeManager; /** * @author Mik Kersten * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public class TaskElementLabelProvider extends LabelProvider implements IColorProvider, IFontProvider { diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskHyperlink.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskHyperlink.java index 00914ba09..ab267e59a 100644 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskHyperlink.java +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TaskHyperlink.java @@ -17,6 +17,7 @@ import org.eclipse.mylyn.tasks.core.TaskRepository; * * @author Eugene Kuleshov * @author Steffen Pingel + * @noextend This class is not intended to be subclassed by clients. */ public final class TaskHyperlink implements IHyperlink { diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUi.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUi.java index 9382c3918..24f20c169 100644 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUi.java +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUi.java @@ -19,6 +19,8 @@ import org.eclipse.mylyn.tasks.core.data.ITaskDataManager; * @author Steffen Pingel * @author Mik Kersten * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class TasksUi { diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiImages.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiImages.java index 680043daf..1c6cb7020 100644 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiImages.java +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiImages.java @@ -19,8 +19,8 @@ import org.eclipse.swt.SWT; import org.eclipse.swt.graphics.Image; /** - * API-3.0: consider removing images not used by clients - * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. * @author Mik Kersten * @since 3.0 */ diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiUtil.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiUtil.java index 577eef537..6d08a7524 100644 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiUtil.java +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/TasksUiUtil.java @@ -62,6 +62,8 @@ import org.eclipse.ui.internal.browser.WebBrowserPreference; import org.eclipse.ui.internal.browser.WorkbenchBrowserSupport; /** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. * @since 2.0 * @author Mik Kersten * @author Steffen Pingel |