xiaomi-Notes/TaskList.java

/*
 * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.micode.notes.gtask.data;

// 引入 Android 数据库操作类，Cursor 用于处理数据库查询结果
import android.database.Cursor;

// 引入 Android 的日志工具类
import android.util.Log;

// 引入自定义的 Notes 数据模型，特别是 NoteColumns 类，包含笔记相关的列名
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.NoteColumns;

// 引入 GTask 的异常处理类，用于处理 GTask 相关操作失败的情况
import net.micode.notes.gtask.exception.ActionFailureException;

// 引入 GTask 的字符串工具类，可能提供与 GTask 数据同步的字符串处理功能
import net.micode.notes.tool.GTaskStringUtils;

// 引入 JSON 处理库，处理 JSON 格式的数据
import org.json.JSONException;
import org.json.JSONObject;

// 引入 ArrayList 类，用于存储动态大小的列表
import java.util.ArrayList;



/*
private static final String TAG = TaskList.class.getSimpleName();：
这是用于日志记录的 TAG，便于在调试时打印日志信息时标明是哪个类生成的日志。getSimpleName() 返回类名 TaskList。


private int mIndex;：
mIndex 用于表示任务列表的索引，可能用于区分不同的任务列表。
这个索引在构造函数中初始化为 1。


private ArrayList<Task> mChildren;：
mChildren 是一个存储任务对象的 ArrayList，
代表当前任务列表下的所有子任务。它是一个动态大小的列表，可以随时添加任务。


public TaskList()：
这是 TaskList 类的构造函数。在构造函数中，调用了父类 Node 的构造函数（super()）,
并初始化了 mChildren（一个新的空 ArrayList）
和 mIndex（设置为 1）。*/
public class TaskList extends Node {
    // 用于日志记录的 TAG，便于调试时查看输出
    private static final String TAG = TaskList.class.getSimpleName();

    // 任务列表的索引，用于区分不同的任务列表
    private int mIndex;

    // 存储任务列表中所有任务对象的 ArrayList
    private ArrayList<Task> mChildren;

    // 构造函数，初始化任务列表对象
    public TaskList() {

        // 调用父类 Node 的构造函数
        super();
        // 初始化任务列表
        mChildren = new ArrayList<Task>();

        // 设置默认索引为 1
        mIndex = 1; 
    }

    
/*

public JSONObject getCreateAction(int actionId)：
该方法用于生成一个 JSON 对象，表示创建任务列表的动作。生成的 JSON 数据将用于向 GTask 服务发送创建任务列表的请求。
参数 actionId 是一个唯一标识符，表示该创建动作的 ID。


JSONObject js = new JSONObject();：
创建一个空的 JSONObject，用于存放任务列表创建请求的相关信息。


js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);：
设置 JSON 中的 action_type 字段为 "create"，表示这是一个创建任务列表的操作。


js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);：
设置 JSON 中的 action_id 字段为传入的 actionId，这个 ID 用来唯一标识此次创建任务列表的动作。


js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);：
设置 JSON 中的 index 字段为 mIndex，任务列表的索引，用于区分不同的任务列表。


JSONObject entity = new JSONObject();：
创建一个新的 JSONObject，用于存放任务列表的详细信息。


entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());：
设置任务列表的名称。getName() 是 Node 类的方法，可能返回当前任务列表的名称。


entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");：
设置任务列表的创建者 ID。此处使用 "null" 字符串表示没有指定创建者的情况。


entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, GTaskStringUtils.GTASK_JSON_TYPE_GROUP);：
设置任务列表的实体类型为 "group"，表示它是一个任务组。


js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);：
将包含任务列表信息的 entity JSON 对象加入到主 JSON 对象 js 中，键为 entity_delta。


异常处理：
如果在生成 JSON 数据过程中遇到 JSONException 异常，捕获异常并输出错误日志，打印异常堆栈信息。
随后抛出一个自定义的 ActionFailureException 异常，表示任务列表创建失败。

return js;：
返回生成的 JSON 对象，该对象包含了用于创建任务列表的所有必要信息。
*/

    
    
    /**
     * 生成创建任务列表的 JSON 对象，用于请求创建新任务列表
     *
     * @param actionId 唯一的动作 ID，用于标识这个请求
     * @return JSONObject 创建任务列表的 JSON 数据
     */
    
    
    public JSONObject getCreateAction(int actionId) {
        
        // 创建一个新的 JSON 对象，用于存储创建任务列表的相关数据
        JSONObject js = new JSONObject();

        try {
            
            // 设置 action_type 为 "create"，表示这是一个创建任务列表的动作
            js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
                    GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);

            // 设置 action_id，表示这次创建任务的唯一标识符
            js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);

            // 设置任务列表的索引，这个索引用于区分任务列表
            js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);

            // 创建一个子 JSON 对象，表示任务实体的变动信息
            JSONObject entity = new JSONObject();

            // 设置任务列表的名称
            entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());

            // 设置任务列表的创建者 ID，这里使用 "null" 字符串表示未知或没有指定创建者
            entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");

            // 设置任务实体的类型，这里是任务列表组的类型
            entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
                    GTaskStringUtils.GTASK_JSON_TYPE_GROUP);

            // 将任务实体信息放入 JSON 对象中
            js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);

        } catch (JSONException e) {
            
            // 捕获 JSON 异常，打印错误日志并抛出自定义异常
            Log.e(TAG, e.toString());
            e.printStackTrace();
            throw new ActionFailureException("fail to generate tasklist-create jsonobject");
        }

        // 返回生成的 JSON 对象
        return js;
    }
}



        /*js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);：
        该行设置 JSON 中的 action_type 字段为 "update"，表示这是一个更新任务列表的操作。
                
        js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);：
        设置 action_id 字段为传入的 actionId，用于唯一标识此次更新操作。
                
        js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());：
        设置任务列表的唯一标识符 id。getGid() 是获取当前任务列表的标识符的方法。
                
        JSONObject entity = new JSONObject();：
        创建一个新的 JSONObject，用于存放任务实体的变动信息。
                
        entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());：
        将任务列表的名称加入 entity JSON 对象。getName() 返回当前任务列表的名称。
                
        entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());：
        将任务列表的删除状态加入 entity JSON 对象。getDeleted() 返回当前任务列表是否被删除的状态。
                
        js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);：
        将包含任务实体变动信息的 entity 对象放入主 JSON 对象 js 中，键为 entity_delta。
                
        异常处理：
        如果在生成 JSON 数据过程中遇到 JSONException 异常，捕获该异常并打印错误日志。之后，抛出一个自定义的 ActionFailureException 异常，表示任务列表更新失败。

                返回 JSON 对象：

                最终返回构建好的 JSON 对象 js，该对象包含了任务列表的更新操作的所有必要信息。*/
    public JSONObject getUpdateAction(int actionId) {
        // 创建一个空的 JSON 对象，用于存放更新请求的数据
        JSONObject js = new JSONObject(); 

        try {
            // 设置 JSON 中的 action_type 字段，表示这是一个更新操作
            js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
                    GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE);

            // 设置 JSON 中的 action_id 字段，表示此次更新操作的唯一标识符
            js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);

            // 设置任务列表的唯一标识符 id
            js.put(GTaskStringUtils.GTASK_JSON_ID, getGid());

            // 创建一个新的 JSON 对象，表示任务实体的变动信息（entity_delta）
            JSONObject entity = new JSONObject();

            // 设置任务列表的名称，使用当前对象的 `getName()` 方法获取任务列表名称
            entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());

            // 设置任务列表的删除状态，使用当前对象的 `getDeleted()` 方法获取删除状态
            entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted());

            // 将包含任务实体信息的 `entity` 对象放入主 JSON 对象中
            js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);

        } catch (JSONException e) {
            
            // 捕获 JSON 处理过程中的异常，打印错误信息并抛出自定义的 ActionFailureException
            Log.e(TAG, e.toString());
            e.printStackTrace();
            throw new ActionFailureException("fail to generate tasklist-update jsonobject");
        }

        // 返回生成的 JSON 对象，包含了更新任务列表所需的所有信息
        return js;
    }


    
         /*  if (js != null)：
            该行确保传入的 JSON 对象 js 不为空。若为空则不会继续执行更新操作。
                    
            if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); }：
            检查 JSON 对象中是否包含 id 字段。如果包含，则调用 setGid() 方法将任务列表的 ID 设置为 JSON 中的 ID。
                    
            if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); }：
            检查 JSON 对象中是否包含 last_modified 字段。如果包含，则调用 setLastModified() 方法将任务列表的最后修改时间设置为 JSON 中的 last_modified 时间。
                    
            if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); }：
            检查 JSON 对象中是否包含 name 字段。如果包含，则调用 setName() 方法将任务列表的名称设置为 JSON 中的 name。
                    
            异常处理：
            如果在获取 JSON 数据过程中发生 JSONException 异常，捕获该异常并打印错误日志，随后抛出自定义异常 ActionFailureException，表示从 JSON 中获取任务列表内容失败。
                    
                    无返回值：
                    该方法没有返回值，直接通过 setGid、setLastModified 和 setName 等方法更新当前对象的属性。*/

public void setContentByRemoteJSON(JSONObject js) {
        if (js != null) {  // 确保传入的 JSON 对象不为空
            try {
                // 如果 JSON 中包含任务列表的唯一标识符 (id)，则更新当前对象的 GID
                if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {
                    setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID));
                }

                // 如果 JSON 中包含任务列表的最后修改时间 (last_modified)，则更新当前对象的最后修改时间
                if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {
                    setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED));
                }

                // 如果 JSON 中包含任务列表的名称 (name)，则更新当前对象的名称
                if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {
                    setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME));
                }

            } catch (JSONException e) {
                // 捕获 JSON 处理过程中的异常，打印错误信息并抛出自定义的 ActionFailureException
                Log.e(TAG, e.toString());
                e.printStackTrace();
                throw new ActionFailureException("fail to get tasklist content from jsonobject");
            }
        }
    }




    /*创建 JSON 对象：
        创建两个 JSONObject，一个用来存放最终结果 js，另一个用来存放文件夹相关信息 folder。
        
        
        获取文件夹名称：
        调用 getName() 方法获取当前任务列表的名称 folderName。
        
        处理 MIUI 文件夹前缀：
        如果任务列表的名称以 MIUI 文件夹的前缀（MIUI_FOLDER_PREFFIX）开始，去除该前缀，得到文件夹的实际名称。
        
        设置文件夹的 SNIPPET 字段：
        将 folderName 放入 folder JSON 对象中的 "SNIPPET" 字段。
        
        判断文件夹类型：
        如果 folderName 等于默认文件夹或电话笔记文件夹，则将文件夹类型设置为系统类型 Notes.TYPE_SYSTEM。
        否则，文件夹类型设置为普通文件夹 Notes.TYPE_FOLDER。
        
        构建最终 JSON：
        将 folder 对象放入 js 对象中，键为 META_HEAD_NOTE，这是最终返回的 JSON 对象。
        
        异常处理：
        如果在生成 JSON 数据时遇到 JSONException 异常，打印错误日志并返回 null。*/
    public JSONObject getLocalJSONFromContent() {
        try {
            // 创建一个空的 JSON 对象，用于存放结果数据
            JSONObject js = new JSONObject();
            // 创建一个空的 JSON 对象，用于存放文件夹信息
            JSONObject folder = new JSONObject();  

            // 获取当前任务列表的名称
            String folderName = getName();

            // 如果任务列表名称以 MIUI 文件夹前缀开头，则去除前缀
            if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))
                folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(),
                        folderName.length());

            // 将任务列表名称作为文件夹的“SNIPPET”字段放入 folder 对象中
            folder.put(NoteColumns.SNIPPET, folderName);

            // 判断任务列表名称，如果是默认文件夹或电话笔记文件夹，则设置类型为系统类型
            if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)
                    || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE))
                // 类型为系统
                folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);  
            else
                // 否则类型为普通文件夹
                folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); 

            // 将 folder 对象放入主 JSON 对象中，键为 "META_HEAD_NOTE"
            js.put(GTaskStringUtils.META_HEAD_NOTE, folder);

            // 返回构建好的 JSON 对象
            return js;
        } catch (JSONException e) {
            // 捕获 JSON 处理中的异常，打印错误日志并返回 null
            Log.e(TAG, e.toString());
            e.printStackTrace();
            return null;
        }
    }


    
    /*判断本地是否有修改：
            
            检查数据库中 LOCAL_MODIFIED_COLUMN 字段的值。如果该值为 0，表示本地没有修改；否则表示有本地修改。
            
            
            没有本地修改的情况：
            如果本地没有修改（LOCAL_MODIFIED_COLUMN == 0），则进一步判断 SYNC_ID_COLUMN（同步 ID）是否等于
            当前任务列表的最后修改时间 getLastModified()：
            如果两者相同，说明本地和远程都没有任何修改，返回 SYNC_ACTION_NONE，表示不需要同步。
            如果不同，则说明远程有修改，需要将远程的数据同步到本地，返回 SYNC_ACTION_UPDATE_LOCAL。
            
            有本地修改的情况：
            如果本地有修改（LOCAL_MODIFIED_COLUMN != 0），首先检查数据库中的 GTask ID (GTASK_ID_COLUMN) 是否与
            当前任务列表的 GTask ID 匹配：
            如果不匹配，打印错误日志并返回 SYNC_ACTION_ERROR，表示发生了 ID 不匹配的错误。
            如果 GTask ID 匹配，继续判断同步 ID 是否与本地修改时间一致：

            如果同步 ID 与最后修改时间一致，说明只有本地修改需要同步到远程，返回 SYNC_ACTION_UPDATE_REMOTE。
            如果不同，说明存在文件夹冲突的情况，仍然返回 SYNC_ACTION_UPDATE_REMOTE，表示选择应用本地修改。
            异常处理：

            如果方法执行过程中遇到任何异常，捕获并打印日志，最后返回 SYNC_ACTION_ERROR 表示同步失败。*/
    
    
    public int getSyncAction(Cursor c) {
        try {
            // 如果数据库中没有本地修改（LOCAL_MODIFIED_COLUMN == 0）
            if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
                
                // 如果本地和远程的同步 ID 相同（没有更新）
                if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
                    
                    // 本地和远程都没有更新，不需要同步
                    return SYNC_ACTION_NONE;
                } else {
                    
                    // 远程数据有更新，需要将远程数据同步到本地
                    return SYNC_ACTION_UPDATE_LOCAL;
                }
            } else {
                // 如果有本地修改
                // 检查 GTask ID 是否匹配
                if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {
                    Log.e(TAG, "gtask id doesn't match");

                    // 如果 GTask ID 不匹配，返回错误
                    return SYNC_ACTION_ERROR;  
                }
                // 如果同步 ID 与本地修改时间相同，说明只有本地修改
                if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
                    
                    // 本地修改需要更新远程数据
                    return SYNC_ACTION_UPDATE_REMOTE;
                } else {
                    
                    // 对于文件夹冲突的情况，选择应用本地修改
                    return SYNC_ACTION_UPDATE_REMOTE;
                }
            }
        } catch (Exception e) {
            
            // 捕获任何异常，打印日志并返回错误
            Log.e(TAG, e.toString());
            e.printStackTrace();
        }

        // 默认返回错误，表示同步操作失败
        return SYNC_ACTION_ERROR;
    }

    
   // mChildren 是一个存储子任务的集合（通常是 List<Task> 类型），该方法返回其当前大小（即子任务的数量）。
    public int getChildTaskCount() {
        // 返回子任务的数量，即 mChildren 列表的元素数量
        return mChildren.size();  
    }


    
    
    /*任务验证：
            首先检查 task 是否为空，并且检查该任务是否已经存在于 mChildren 列表中。如果任务为空或已经存在，则不会执行后续的添加操作。

            添加任务：
            调用 mChildren.add(task) 尝试将任务添加到 mChildren 列表中，ret 用来记录添加操作是否成功。

            更新兄弟任务和父任务：
                设置新任务的 前置兄弟任务（priorSibling）:
                如果 mChildren 不为空，设置当前任务的前置兄弟为当前 mChildren 列表的最后一个任务。
            
                设置新任务的 父任务（parent）：
                将当前任务作为父任务传给新任务。
            
            返回值：
            返回任务是否成功添加到子任务列表的结果（ret）。
            */
    public boolean addChildTask(Task task) {
        boolean ret = false;
        // 确保任务不为空且尚未添加到子任务列表中
        if (task != null && !mChildren.contains(task)) {
            // 添加任务到子任务列表
            ret = mChildren.add(task); 
            if (ret) {
                
                // 如果添加成功，需要设置该任务的 priorSibling（前置兄弟任务）和 parent（父任务）

                // 设置前置兄弟任务
                task.setPriorSibling(mChildren.isEmpty() ? null : mChildren.get(mChildren.size() - 1));
                // 设置当前任务作为任务的父任务
                task.setParent(this); 
            }
        }
        // 返回添加任务是否成功
        return ret;  
    }


    
  /*  
    索引合法性检查：
            首先检查传入的 index 是否在有效范围内（即不小于 0 且不大于 mChildren 列表的大小）。
            如果索引不合法，打印错误日志并返回 false，表示添加失败。

            任务位置检查：
            查找 task 在当前子任务列表 mChildren 中的位置。如果 task 不在列表中（即 pos == -1），则继续进行添加操作。

            任务添加：
            调用 mChildren.add(index, task) 在指定的索引位置将任务添加到子任务列表中。

            更新兄弟任务关系：
                获取新任务的前置任务：
                    如果索引不为 0，说明添加位置前面有任务，需要更新新任务的 前置兄弟任务。
                获取新任务的后置任务：
                    如果索引不是列表的最后一个位置，则需要获取 后置任务 并更新其前置兄弟为当前任务。
            返回值：方法成功执行时返回 true，表示任务已被成功添加到子任务列表。
*/

    public boolean addChildTask(Task task, int index) {
        // 检查索引是否合法
        if (index < 0 || index > mChildren.size()) {
            // 如果索引不合法，打印错误日志
            Log.e(TAG, "add child task: invalid index");
            // 返回 false，表示添加失败
            return false;  
        }

        // 查找任务在当前子任务列表中的位置
        int pos = mChildren.indexOf(task);
        // 确保任务不为空，并且任务不在列表中
        if (task != null && pos == -1) {

            // 在指定索引位置添加任务
            mChildren.add(index, task); 

            // 更新前置任务和后置任务
            Task preTask = null;
            Task afterTask = null;

            // 如果索引不是 0，则获取前一个任务
            if (index != 0)  
                preTask = mChildren.get(index - 1);

            // 如果索引不是最后一个，则获取下一个任务
            if (index != mChildren.size() - 1)  
                afterTask = mChildren.get(index + 1);

            // 设置当前任务的前置兄弟任务
            task.setPriorSibling(preTask);

            // 如果存在后置任务，设置后置任务的前置兄弟为当前任务
            if (afterTask != null)  
                afterTask.setPriorSibling(task);
        }

        // 返回 true，表示任务成功添加
        return true;  
    }


    
    /*
            任务索引：
                     使用 mChildren.indexOf(task) 查找指定任务在子任务列表中的位置。
            任务移除：
                    如果任务存在，则调用 mChildren.remove(task) 移除该任务。
            更新任务关系：
                    将移除任务的 priorSibling 和 parent 设置为 null，表示该任务不再有前置兄弟任务和父任务。
                    如果移除的任务不是列表中的最后一个任务，需要更新后续任务的 priorSibling，使其指向前一个任务。
            返回值：
                    如果移除任务成功，返回 true，否则返回 false。
                 
     */
    public boolean removeChildTask(Task task) {
        boolean ret = false;
        // 查找任务在子任务列表中的索引
        int index = mChildren.indexOf(task);
        // 如果任务存在于子任务列表中
        if (index != -1) {
            // 移除该任务
            ret = mChildren.remove(task);

            // 如果移除成功
            if (ret) {  
                // 重置任务的 priorSibling（前置兄弟任务）和 parent（父任务）
                task.setPriorSibling(null);
                task.setParent(null);

                // 更新任务列表中的其他任务

                // 如果移除的任务不是最后一个
                if (index != mChildren.size()) { 
                    mChildren.get(index).setPriorSibling(
                            // 更新后续任务的前置兄弟任务
                            index == 0 ? null : mChildren.get(index - 1));  
                }
            }
        }

        // 返回任务是否成功移除
        return ret;  
    }


    
   /* 
            索引有效性检查：
            首先检查传入的目标索引是否在有效范围内。

            任务存在性检查：
            使用 mChildren.indexOf(task) 确保要移动的任务存在于列表中。

            任务已经在目标位置：
            如果任务已经在目标位置，直接返回 true，无需执行任何操作。

            任务移动：
            如果任务不在目标位置，则通过调用 removeChildTask(task) 移除任务，然后调用 addChildTask(task, index) 将其添加到新的位置。

            返回值：
            如果任务成功移动，返回 true；否则返回 false。
            
    */
    public boolean moveChildTask(Task task, int index) {

        // 检查索引是否有效
        if (index < 0 || index >= mChildren.size()) {  
            Log.e(TAG, "move child task: invalid index");
            // 如果索引无效，打印错误日志并返回 false
            return false;  
        }

        // 查找任务在子任务列表中的位置
        int pos = mChildren.indexOf(task);
        // 如果任务不在列表中
        if (pos == -1) {  
            Log.e(TAG, "move child task: the task should in the list");
            // 返回 false
            return false; 
        }

        // 如果任务已经在目标位置
        if (pos == index)
            // 不需要移动，直接返回 true
            return true; 

        // 移除任务并将其添加到新的索引位置

        // 调用 removeChildTask 和 addChildTask 方法进行移动
        return (removeChildTask(task) && addChildTask(task, index)); 
    }

    /*
            遍历子任务列表：
                    使用 for 循环遍历 mChildren 列表。
            任务匹配：
                    通过调用 t.getGid().equals(gid) 检查每个任务的 gid 是否与指定的 gid 匹配。
            返回值：
                    如果找到匹配的任务，则返回该任务；否则返回 null。
                    
     */
    public Task findChildTaskByGid(String gid) {
        // 遍历子任务列表
        for (int i = 0; i < mChildren.size(); i++) {  
            Task t = mChildren.get(i);
            // 如果任务的 gid 与指定的 gid 匹配
            if (t.getGid().equals(gid)) {
                // 返回找到的任务
                return t;  
            }
        }
        // 如果没有找到，返回 null
        return null;  
    }


    /*
    返回任务索引：
            直接调用 mChildren.indexOf(task) 获取任务在子任务列表中的索引。
            
     */
    public int getChildTaskIndex(Task task) {
        // 返回任务在子任务列表中的索引
        return mChildren.indexOf(task);  
    }


    /*
            索引有效性检查：
                    首先检查传入的索引是否在有效范围内。
            返回任务：
                    如果索引有效，则通过 mChildren.get(index) 返回对应的任务，否则返回 null。
                    
     */
    public Task getChildTaskByIndex(int index) {
        // 检查索引是否有效
        if (index < 0 || index >= mChildren.size()) {  
            Log.e(TAG, "getTaskByIndex: invalid index");
            // 如果索引无效，返回 null
            return null; 
        }
        // 返回指定索引位置的任务
        return mChildren.get(index); 
    }


    /*
            遍历子任务列表：
                    使用 for-each 循环遍历 mChildren 列表。
            任务匹配：
                    检查任务的 gid 是否与指定的 gid 匹配。
            返回值：
                    如果找到匹配的任务，则返回该任务；否则返回 null。
                    
     */

public Task getChilTaskByGid(String gid) {

        // 遍历子任务列表
        for (Task task : mChildren) {
            // 如果任务的 gid 匹配
            if (task.getGid().equals(gid))
                // 返回匹配的任务
                return task; 
        }

        // 如果没有找到，返回 null
        return null;  
    }


    //返回子任务列表：直接返回存储子任务的 mChildren 列表。
    
    public ArrayList<Task> getChildTaskList() {
        // 返回子任务列表
        return this.mChildren;  
    }


    
    //设置索引：将传入的 index 值设置为当前任务的索引。
    public void setIndex(int index) {
        // 设置当前任务的索引
        this.mIndex = index; 
    }


    
    //返回索引：返回当前任务的 mIndex 值。
public int getIndex() {
        // 返回当前任务的索引
        return this.mIndex;  
    }

}