添加注释

src/Notes-master/app/src/main/java/net/micode/notes/gtask/data/TaskList.java

@@ -29,35 +29,50 @@ import org.json.JSONObject;
 
 import java.util.ArrayList;
 
-
+/**
+ * TaskList类表示Google Tasks中的任务列表，继承自Node类，
+ * 负责管理一组任务(Task)，并处理与任务列表相关的创建、更新、同步等操作。
+ */
 public class TaskList extends Node {
     private static final String TAG = TaskList.class.getSimpleName();
 
+    // 任务列表在父容器中的位置索引
     private int mIndex;
 
+    // 子任务列表
     private ArrayList<Task> mChildren;
 
+    /**
+     * 构造函数，初始化任务列表对象
+     */
     public TaskList() {
         super();
         mChildren = new ArrayList<Task>();
         mIndex = 1;
     }
 
+    /**
+     * 生成用于创建任务列表的JSON对象
+     * 
+     * @param actionId 操作ID，用于标识此次创建操作
+     * @return 包含创建任务列表所需参数的JSON对象
+     * @throws ActionFailureException 如果生成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, mIndex);
 
-            // entity_delta
+            // 构建任务列表实体信息
             JSONObject entity = new JSONObject();
             entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
             entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
@@ -74,21 +89,28 @@ public class TaskList extends Node {
         return js;
     }
 
+    /**
+     * 生成用于更新任务列表的JSON对象
+     * 
+     * @param actionId 操作ID，用于标识此次更新操作
+     * @return 包含更新任务列表所需参数的JSON对象
+     * @throws ActionFailureException 如果生成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_DELETED, getDeleted());
@@ -103,20 +125,26 @@ public class TaskList extends Node {
         return js;
     }
 
+    /**
+     * 从远程JSON数据设置任务列表内容
+     * 
+     * @param js 包含任务列表信息的JSON对象
+     * @throws ActionFailureException 如果解析JSON对象失败
+     */
     public void setContentByRemoteJSON(JSONObject js) {
         if (js != null) {
             try {
-                // id
+                // 从JSON中提取任务列表ID
                 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));
                 }
@@ -129,6 +157,11 @@ public class TaskList extends Node {
         }
     }
 
+    /**
+     * 从本地JSON数据设置任务列表内容
+     * 
+     * @param js 包含本地任务列表信息的JSON对象
+     */
     public void setContentByLocalJSON(JSONObject js) {
         if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) {
             Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
@@ -137,10 +170,12 @@ public class TaskList extends Node {
         try {
             JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
 
+            // 根据本地笔记类型设置任务列表名称
             if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
                 String name = folder.getString(NoteColumns.SNIPPET);
                 setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name);
             } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
+                // 处理系统文件夹
                 if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER)
                     setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT);
                 else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER)
@@ -157,16 +192,24 @@ public class TaskList extends Node {
         }
     }
 
+    /**
+     * 根据任务列表内容生成本地JSON对象
+     * 
+     * @return 包含任务列表信息的本地JSON对象
+     */
     public JSONObject getLocalJSONFromContent() {
         try {
             JSONObject js = new JSONObject();
             JSONObject folder = new JSONObject();
 
+            // 处理任务列表名称，移除可能的前缀
             String folderName = getName();
             if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
                 folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
                         folderName.length());
             folder.put(NoteColumns.SNIPPET, folderName);
+            
+            // 根据文件夹名称确定类型（系统文件夹或普通文件夹）
             if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)
                     || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE))
                 folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
@@ -183,28 +226,37 @@ public class TaskList extends Node {
         }
     }
 
+    /**
+     * 根据本地数据库游标确定同步操作类型
+     * 
+     * @param c 数据库游标，包含本地任务列表信息
+     * @return 同步操作类型（SYNC_ACTION_NONE, SYNC_ACTION_UPDATE_LOCAL, 
+     *         SYNC_ACTION_UPDATE_REMOTE, SYNC_ACTION_ERROR）
+     */
     public int getSyncAction(Cursor c) {
         try {
+            // 检查本地是否有修改
             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
+                // 本地有修改
+                // 验证Google Tasks 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 {
-                    // for folder conflicts, just apply local modification
+                    // 对于文件夹冲突，直接应用本地修改
                     return SYNC_ACTION_UPDATE_REMOTE;
                 }
             }
@@ -216,16 +268,27 @@ public class TaskList extends Node {
         return SYNC_ACTION_ERROR;
     }
 
+    /**
+     * 获取子任务数量
+     * 
+     * @return 子任务列表的大小
+     */
     public int getChildTaskCount() {
         return mChildren.size();
     }
 
+    /**
+     * 添加子任务到任务列表末尾
+     * 
+     * @param task 要添加的任务对象
+     * @return 添加成功返回true，失败返回false
+     */
     public boolean addChildTask(Task task) {
         boolean ret = false;
         if (task != null && !mChildren.contains(task)) {
             ret = mChildren.add(task);
             if (ret) {
-                // need to set prior sibling and parent
+                // 设置任务的同级前一个任务和父任务列表
                 task.setPriorSibling(mChildren.isEmpty() ? null : mChildren
                         .get(mChildren.size() - 1));
                 task.setParent(this);
@@ -234,6 +297,13 @@ public class TaskList extends Node {
         return ret;
     }
 
+    /**
+     * 在指定位置添加子任务
+     * 
+     * @param task 要添加的任务对象
+     * @param index 指定的插入位置索引
+     * @return 添加成功返回true，失败返回false
+     */
     public boolean addChildTask(Task task, int index) {
         if (index < 0 || index > mChildren.size()) {
             Log.e(TAG, "add child task: invalid index");
@@ -244,7 +314,7 @@ public class TaskList extends Node {
         if (task != null && pos == -1) {
             mChildren.add(index, task);
 
-            // update the task list
+            // 更新任务列表中前后任务的同级关系
             Task preTask = null;
             Task afterTask = null;
             if (index != 0)
@@ -260,6 +330,12 @@ public class TaskList extends Node {
         return true;
     }
 
+    /**
+     * 从任务列表中移除子任务
+     * 
+     * @param task 要移除的任务对象
+     * @return 移除成功返回true，失败返回false
+     */
     public boolean removeChildTask(Task task) {
         boolean ret = false;
         int index = mChildren.indexOf(task);
@@ -267,11 +343,11 @@ public class TaskList extends Node {
             ret = mChildren.remove(task);
 
             if (ret) {
-                // reset prior sibling and parent
+                // 重置被移除任务的同级关系和父任务列表
                 task.setPriorSibling(null);
                 task.setParent(null);
 
-                // update the task list
+                // 更新任务列表中后续任务的同级关系
                 if (index != mChildren.size()) {
                     mChildren.get(index).setPriorSibling(
                             index == 0 ? null : mChildren.get(index - 1));
@@ -281,8 +357,14 @@ public class TaskList extends Node {
         return ret;
     }
 
+    /**
+     * 将子任务移动到指定位置
+     * 
+     * @param task 要移动的任务对象
+     * @param index 目标位置索引
+     * @return 移动成功返回true，失败返回false
+     */
     public boolean moveChildTask(Task task, int index) {
-
         if (index < 0 || index >= mChildren.size()) {
             Log.e(TAG, "move child task: invalid index");
             return false;
@@ -296,9 +378,17 @@ public class TaskList extends Node {
 
         if (pos == index)
             return true;
+            
+        // 通过先移除再添加的方式实现移动
         return (removeChildTask(task) && addChildTask(task, index));
     }
 
+    /**
+     * 通过GID查找子任务
+     * 
+     * @param gid 任务的全局唯一标识符
+     * @return 找到的任务对象，如果不存在则返回null
+     */
     public Task findChildTaskByGid(String gid) {
         for (int i = 0; i < mChildren.size(); i++) {
             Task t = mChildren.get(i);
@@ -309,10 +399,22 @@ public class TaskList extends Node {
         return null;
     }
 
+    /**
+     * 获取子任务在列表中的索引位置
+     * 
+     * @param task 要查找的任务对象
+     * @return 任务在列表中的索引，如果不存在则返回-1
+     */
     public int getChildTaskIndex(Task task) {
         return mChildren.indexOf(task);
     }
 
+    /**
+     * 通过索引获取子任务
+     * 
+     * @param index 任务的索引位置
+     * @return 指定索引位置的任务对象，如果索引无效则返回null
+     */
     public Task getChildTaskByIndex(int index) {
         if (index < 0 || index >= mChildren.size()) {
             Log.e(TAG, "getTaskByIndex: invalid index");
@@ -321,6 +423,12 @@ public class TaskList extends Node {
         return mChildren.get(index);
     }
 
+    /**
+     * 通过GID获取子任务（与findChildTaskByGid功能相同，不同命名）
+     * 
+     * @param gid 任务的全局唯一标识符
+     * @return 找到的任务对象，如果不存在则返回null
+     */
     public Task getChilTaskByGid(String gid) {
         for (Task task : mChildren) {
             if (task.getGid().equals(gid))
@@ -329,14 +437,29 @@ public class TaskList extends Node {
         return null;
     }
 
+    /**
+     * 获取所有子任务列表
+     * 
+     * @return 包含所有子任务的ArrayList
+     */
     public ArrayList<Task> getChildTaskList() {
         return this.mChildren;
     }
 
+    /**
+     * 设置任务列表在父容器中的索引位置
+     * 
+     * @param index 索引位置
+     */
     public void setIndex(int index) {
         this.mIndex = index;
     }
 
+    /**
+     * 获取任务列表在父容器中的索引位置
+     * 
+     * @return 索引位置
+     */
     public int getIndex() {
         return this.mIndex;
     }