gtask/data/Task.java注释

app/src/main/java/net/micode/notes/gtask/data/Task.java

@@ -32,64 +32,68 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 
+// 任务类，继承自Node抽象类，代表GTask中的一个任务
 public class Task extends Node {
+    // 日志标签，使用类名
     private static final String TAG = Task.class.getSimpleName();
-
+    // 任务完成状态
     private boolean mCompleted;
-
+    // 任务备注
     private String mNotes;
-
+    // 任务元信息
     private JSONObject mMetaInfo;
-
+    // 前一个兄弟任务
     private Task mPriorSibling;
-
+    // 父任务列表
     private TaskList mParent;
 
+    // 构造方法，初始化任务对象
     public Task() {
         super();
-        mCompleted = false;
+        mCompleted = false;         // 默认为未完成状态
-        mNotes = null;
+        mNotes = null;              // 初始化备注为null
-        mPriorSibling = null;
+        mPriorSibling = null;       // 初始化前一个兄弟任务为null
-        mParent = null;
+        mParent = null;             // 初始化父任务列表为null
-        mMetaInfo = null;
+        mMetaInfo = null;           // 初始化元信息为null
     }
 
+    // 创建同步操作的JSON对象（创建任务）
     public JSONObject getCreateAction(int actionId) {
         JSONObject js = new JSONObject();
 
         try {
-            // action_type
+            // 设置操作类型为创建
             js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
                     GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
 
-            // action_id
+            // 设置操作ID
             js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
 
-            // index
+            // 设置任务在父列表中的索引
             js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
 
-            // entity_delta
+            // 设置实体增量信息
             JSONObject entity = new JSONObject();
-            entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
+            entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 任务名称
-            entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
+            entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 创建者ID
             entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
-                    GTaskStringUtils.GTASK_JSON_TYPE_TASK);
+                    GTaskStringUtils.GTASK_JSON_TYPE_TASK); // 实体类型为任务
             if (getNotes() != null) {
-                entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
+                entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 任务备注
             }
             js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
 
-            // parent_id
+            // 设置父ID为父任务列表的Gid
             js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
 
-            // dest_parent_type
+            // 设置目标父类型为组
             js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
                     GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
 
-            // list_id
+            // 设置列表ID为父任务列表的Gid
             js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
 
-            // prior_sibling_id
+            // 如果有前一个兄弟任务，设置其Gid
             if (mPriorSibling != null) {
                 js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid());
             }
@@ -103,27 +107,28 @@ public class Task extends Node {
         return js;
     }
 
+    // 创建同步操作的JSON对象（更新任务）
     public JSONObject getUpdateAction(int actionId) {
         JSONObject js = new JSONObject();
 
         try {
-            // action_type
+            // 设置操作类型为更新
             js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
                     GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);
 
-            // action_id
+            // 设置操作ID
             js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
 
-            // id
+            // 设置任务ID
             js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());
 
-            // entity_delta
+            // 设置实体增量信息
             JSONObject entity = new JSONObject();
-            entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
+            entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 任务名称
             if (getNotes() != null) {
-                entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
+                entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); // 任务备注
             }
-            entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());
+            entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 删除状态
             js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
 
         } catch (JSONException e) {
@@ -135,35 +140,36 @@ public class Task extends Node {
         return js;
     }
 
+    // 从远程JSON数据设置任务内容
     public void setContentByRemoteJSON(JSONObject js) {
         if (js != null) {
             try {
-                // id
+                // 设置任务Gid
                 if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
                     setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
                 }
 
-                // last_modified
+                // 设置最后修改时间
                 if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
                     setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
                 }
 
-                // name
+                // 设置任务名称
                 if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
                     setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
                 }
 
-                // notes
+                // 设置任务备注
                 if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) {
                     setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES));
                 }
 
-                // deleted
+                // 设置删除状态
                 if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) {
                     setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED));
                 }
 
-                // completed
+                // 设置完成状态
                 if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) {
                     setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED));
                 }
@@ -175,6 +181,7 @@ public class Task extends Node {
         }
     }
 
+    // 从本地JSON数据设置任务内容
     public void setContentByLocalJSON(JSONObject js) {
         if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
                 || !js.has(GTaskStringUtils.META_HEAD_DATA)) {
@@ -185,11 +192,13 @@ public class Task extends Node {
             JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
             JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
 
+            // 检查类型是否为笔记
             if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) {
                 Log.e(TAG, "invalid type");
                 return;
             }
 
+            // 从数据中获取任务名称
             for (int i = 0; i < dataArray.length(); i++) {
                 JSONObject data = dataArray.getJSONObject(i);
                 if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
@@ -204,11 +213,12 @@ public class Task extends Node {
         }
     }
 
+    // 从内容获取本地JSON表示
     public JSONObject getLocalJSONFromContent() {
         String name = getName();
         try {
             if (mMetaInfo == null) {
-                // new task created from web
+                // 处理从网络创建的新任务
                 if (name == null) {
                     Log.w(TAG, "the note seems to be an empty one");
                     return null;
@@ -225,10 +235,11 @@ public class Task extends Node {
                 js.put(GTaskStringUtils.META_HEAD_NOTE, note);
                 return js;
             } else {
-                // synced task
+                // 处理已同步的任务
                 JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
                 JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
 
+                // 更新任务名称
                 for (int i = 0; i < dataArray.length(); i++) {
                     JSONObject data = dataArray.getJSONObject(i);
                     if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
@@ -247,6 +258,7 @@ public class Task extends Node {
         }
     }
 
+    // 设置任务元信息
     public void setMetaInfo(MetaData metaData) {
         if (metaData != null && metaData.getNotes() != null) {
             try {
@@ -258,9 +270,11 @@ public class Task extends Node {
         }
     }
 
+    // 获取同步操作类型
     public int getSyncAction(Cursor c) {
         try {
             JSONObject noteInfo = null;
+            // 从元信息中获取笔记信息
             if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
                 noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
             }
@@ -270,36 +284,39 @@ public class Task extends Node {
                 return SYNC_ACTION_UPDATE_REMOTE;
             }
 
+            // 检查笔记ID是否存在
             if (!noteInfo.has(NoteColumns.ID)) {
                 Log.w(TAG, "remote note id seems to be deleted");
                 return SYNC_ACTION_UPDATE_LOCAL;
             }
 
-            // validate the note id now
+            // 验证笔记ID是否匹配
             if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) {
                 Log.w(TAG, "note id doesn't match");
                 return SYNC_ACTION_UPDATE_LOCAL;
             }
 
+            // 检查本地修改标记
             if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
-                // there is no local update
+                // 本地没有更新
                 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
-                    // no update both side
+                    // 两边都没有更新
                     return SYNC_ACTION_NONE;
                 } else {
-                    // apply remote to local
+                    // 应用远程更新到本地
                     return SYNC_ACTION_UPDATE_LOCAL;
                 }
             } else {
-                // validate gtask id
+                // 验证GTask ID是否匹配
                 if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
                     Log.e(TAG, "gtask id doesn't match");
                     return SYNC_ACTION_ERROR;
                 }
                 if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
-                    // local modification only
+                    // 只有本地修改
                     return SYNC_ACTION_UPDATE_REMOTE;
                 } else {
+                    // 发生更新冲突
                     return SYNC_ACTION_UPDATE_CONFLICT;
                 }
             }
@@ -311,41 +328,49 @@ public class Task extends Node {
         return SYNC_ACTION_ERROR;
     }
 
+    // 判断任务是否值得保存
     public boolean isWorthSaving() {
         return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
                 || (getNotes() != null && getNotes().trim().length() > 0);
     }
 
+    // 设置任务完成状态
     public void setCompleted(boolean completed) {
         this.mCompleted = completed;
     }
 
+    // 设置任务备注
     public void setNotes(String notes) {
         this.mNotes = notes;
     }
 
+    // 设置前一个兄弟任务
     public void setPriorSibling(Task priorSibling) {
         this.mPriorSibling = priorSibling;
     }
 
+    // 设置父任务列表
     public void setParent(TaskList parent) {
         this.mParent = parent;
     }
 
+    // 获取任务完成状态
     public boolean getCompleted() {
         return this.mCompleted;
     }
 
+    // 获取任务备注
     public String getNotes() {
         return this.mNotes;
     }
 
+    // 获取前一个兄弟任务
     public Task getPriorSibling() {
         return this.mPriorSibling;
     }
 
+    // 获取父任务列表
     public TaskList getParent() {
         return this.mParent;
     }
-
 }