Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSam Davis2016-05-19 20:08:20 -0400
committerGerrit Code Review @ Eclipse.org2016-05-27 12:29:57 -0400
commit7d93772224d925b59be2277991856e958bb9a188 (patch)
tree3be6fdbac86b66ebb4c8e6cb87d8343d324260b0
parent62e422daf603e288762f08075f3abf4617e16b15 (diff)
downloadorg.eclipse.mylyn.tasks-7d93772224d925b59be2277991856e958bb9a188.tar.gz
org.eclipse.mylyn.tasks-7d93772224d925b59be2277991856e958bb9a188.tar.xz
org.eclipse.mylyn.tasks-7d93772224d925b59be2277991856e958bb9a188.zip
add JavaDoc for the various kinds of TaskData in TaskDataState
-rw-r--r--org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/data/TaskDataState.java12
-rw-r--r--org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/data/ITaskDataWorkingCopy.java24
2 files changed, 36 insertions, 0 deletions
diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/data/TaskDataState.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/data/TaskDataState.java
index aa0850adc..4ba4b8000 100644
--- a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/data/TaskDataState.java
+++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/data/TaskDataState.java
@@ -163,14 +163,23 @@ public class TaskDataState implements ITaskDataWorkingCopy {
}
}
+ /**
+ * @see #getEditsData()
+ */
public void setEditsData(TaskData editsTaskData) {
this.editsTaskData = editsTaskData;
}
+ /**
+ * @see #getLastReadData()
+ */
public void setLastReadData(TaskData oldTaskData) {
this.lastReadTaskData = oldTaskData;
}
+ /**
+ * @see #getLocalData()
+ */
public void setLocalTaskData(TaskData localTaskData) {
this.localTaskData = localTaskData;
}
@@ -179,6 +188,9 @@ public class TaskDataState implements ITaskDataWorkingCopy {
this.saved = saved;
}
+ /**
+ * @see #getRepositoryData()
+ */
public void setRepositoryData(TaskData newTaskData) {
this.repositoryTaskData = newTaskData;
}
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 efd239aa2..2aa3eae38 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
@@ -15,6 +15,7 @@ import java.util.Set;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.mylyn.internal.tasks.core.AbstractTask;
/**
* @author Steffen Pingel
@@ -25,21 +26,44 @@ import org.eclipse.core.runtime.IProgressMonitor;
public interface ITaskDataWorkingCopy {
/**
+ * Get the unsubmitted edits made locally by the user.
+ *
+ * @return TaskData containing only those attributes that have been edited.
* @since 3.0
*/
public abstract TaskData getEditsData();
/**
+ * Get the "old" data that was retrieved from the repository some time in the past. When the
+ * {@link #getRepositoryData() repository data} contains unread incoming changes, the last read data is the data
+ * that the user last (marked) read. If the task has never been read, this will be the same as the
+ * {@link #getRepositoryData() repository data}.
+ * <p>
+ * When new TaskData is retrieved, if the previous incoming changes in the repository data have been
+ * {@link AbstractTask#isMarkReadPending() marked read}, the last read data is replaced with the repository data,
+ * and the repository data is replaced with the newly retrieved data. If the data has not been marked read, the
+ * repository data is replaced with the newly retrieved data and the last read data is unchanged.
+ *
+ * @return TaskData that has been read by the user, or the latest data retrieved from the repository if the task has
+ * never been read
* @since 3.0
*/
public abstract TaskData getLastReadData();
/**
+ * Get the TaskData that results from applying the user's {@link #getEditsData() edits} to the new
+ * {@link #getRepositoryData() repository data}. This is the only TaskData used to populate the task editor.
+ *
+ * @return TaskData used to populate the task editor
* @since 3.0
*/
public abstract TaskData getLocalData();
/**
+ * Get the "new" data that was recently retrieved from the repository and may have changed since the
+ * {@link #getLastReadData() last read} data was read.
+ *
+ * @return TaskData that may contain incoming changes; the most current copy of the repository's data
* @since 3.0
*/
public abstract TaskData getRepositoryData();

Back to the top