git/java/net/micode/notes/tool/GTaskStringUtils.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.
 */

// GTaskStringUtils.java - Google任务（GTasks）同步相关的字符串常量工具类
// 主要功能：定义与Google Tasks API交互时使用的JSON键名、操作类型、元数据标识等常量
// 这些常量用于序列化和反序列化Google Tasks的JSON数据
package net.micode.notes.tool;

// ======================= Google Tasks JSON键名常量 =======================
/**
 * GTaskStringUtils - Google Tasks同步字符串常量工具类
 * 包含所有与Google Tasks API通信时使用的JSON键名、操作类型、文件夹标识等常量
 * 所有常量都是public static final，确保全局唯一且不可修改
 */
public class GTaskStringUtils {

    // ======================= 操作相关键名 =======================

    /** 操作ID键名 - JSON中标识操作的唯一ID */
    public final static String GTASK_JSON_ACTION_ID = "action_id";

    /** 操作列表键名 - JSON中包含多个操作的数组 */
    public final static String GTASK_JSON_ACTION_LIST = "action_list";

    /** 操作类型键名 - JSON中标识操作类型的字段 */
    public final static String GTASK_JSON_ACTION_TYPE = "action_type";

    // ======================= 操作类型值 =======================

    /** 创建操作类型值 - 表示创建新项的操作 */
    public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create";

    /** 获取全部操作类型值 - 表示获取所有数据的操作 */
    public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all";

    /** 移动操作类型值 - 表示移动项到其他位置的操作 */
    public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move";

    /** 更新操作类型值 - 表示更新现有项的操作 */
    public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update";

    // ======================= 创建者和版本信息 =======================

    /** 创建者ID键名 - JSON中标识创建者的字段 */
    public final static String GTASK_JSON_CREATOR_ID = "creator_id";

    /** 客户端版本键名 - JSON中标识客户端版本的字段 */
    public final static String GTASK_JSON_CLIENT_VERSION = "client_version";

    // ======================= 实体和子项相关 =======================

    /** 子实体键名 - JSON中表示子项的列表 */
    public final static String GTASK_JSON_CHILD_ENTITY = "child_entity";

    /** 实体增量键名 - JSON中表示实体变更的字段 */
    public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta";

    /** 实体类型键名 - JSON中标识实体类型的字段 */
    public final static String GTASK_JSON_ENTITY_TYPE = "entity_type";

    // ======================= 状态和删除相关 =======================

    /** 完成状态键名 - JSON中标识任务是否完成的字段 */
    public final static String GTASK_JSON_COMPLETED = "completed";

    /** 删除状态键名 - JSON中标识项是否被删除的字段 */
    public final static String GTASK_JSON_DELETED = "deleted";

    /** 获取删除项键名 - JSON中标识是否获取已删除项的字段 */
    public final static String GTASK_JSON_GET_DELETED = "get_deleted";

    // ======================= ID和索引相关 =======================

    /** ID键名 - JSON中最基本的ID字段 */
    public final static String GTASK_JSON_ID = "id";

    /** 新ID键名 - JSON中表示新生成的ID字段（用于创建操作） */
    public final static String GTASK_JSON_NEW_ID = "new_id";

    /** 索引键名 - JSON中表示项在列表中的位置索引 */
    public final static String GTASK_JSON_INDEX = "index";

    /** 父项ID键名 - JSON中表示父项的ID */
    public final static String GTASK_JSON_PARENT_ID = "parent_id";

    /** 前一个兄弟项ID键名 - JSON中表示同一层级中前一项的ID（用于确定位置） */
    public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id";

    // ======================= 列表相关 =======================

    /** 当前列表ID键名 - JSON中表示当前活动列表的ID */
    public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id";

    /** 默认列表ID键名 - JSON中表示默认列表的ID */
    public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id";

    /** 列表ID键名 - JSON中表示列表的ID */
    public final static String GTASK_JSON_LIST_ID = "list_id";

    /** 列表集合键名 - JSON中包含多个列表的数组 */
    public final static String GTASK_JSON_LISTS = "lists";

    /** 源列表键名 - JSON中表示移动操作的源列表 */
    public final static String GTASK_JSON_SOURCE_LIST = "source_list";

    /** 目标列表键名 - JSON中表示移动操作的目标列表 */
    public final static String GTASK_JSON_DEST_LIST = "dest_list";

    // ======================= 移动操作相关 =======================

    /** 目标父项键名 - JSON中表示移动操作的目标父项 */
    public final static String GTASK_JSON_DEST_PARENT = "dest_parent";

    /** 目标父项类型键名 - JSON中表示移动操作的目标父项类型 */
    public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type";

    // ======================= 时间和同步相关 =======================

    /** 最后修改时间键名 - JSON中表示项的最后修改时间戳 */
    public final static String GTASK_JSON_LAST_MODIFIED = "last_modified";

    /** 最新同步点键名 - JSON中表示最新的同步时间点（用于增量同步） */
    public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point";

    // ======================= 名称和内容相关 =======================

    /** 名称键名 - JSON中表示项的名称/标题字段 */
    public final static String GTASK_JSON_NAME = "name";

    /** 便签内容键名 - JSON中表示便签具体内容的字段 */
    public final static String GTASK_JSON_NOTES = "notes";

    // ======================= 结果和任务相关 =======================

    /** 结果键名 - JSON中表示操作结果集的字段 */
    public final static String GTASK_JSON_RESULTS = "results";

    /** 任务集合键名 - JSON中包含多个任务的数组 */
    public final static String GTASK_JSON_TASKS = "tasks";

    // ======================= 类型相关 =======================

    /** 类型键名 - JSON中表示项的类型字段 */
    public final static String GTASK_JSON_TYPE = "type";

    /** 组类型值 - JSON中表示组/文件夹类型的值 */
    public final static String GTASK_JSON_TYPE_GROUP = "GROUP";

    /** 任务类型值 - JSON中表示任务/便签类型的值 */
    public final static String GTASK_JSON_TYPE_TASK = "TASK";

    // ======================= 用户相关 =======================

    /** 用户键名 - JSON中表示用户信息的字段 */
    public final static String GTASK_JSON_USER = "user";

    // ======================= MIUI便签专用文件夹前缀 =======================

    /** MIUI文件夹前缀 - 用于标识MIUI便签创建的Google Tasks文件夹 */
    public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]";

    /** 默认文件夹名称 - 在Google Tasks中创建的默认文件夹名称 */
    public final static String FOLDER_DEFAULT = "Default";

    /** 通话记录文件夹名称 - 在Google Tasks中创建的通话记录专用文件夹 */
    public final static String FOLDER_CALL_NOTE = "Call_Note";

    // ======================= 元数据相关 =======================

    /** 元数据文件夹标识 - 用于标识存储同步元数据的特殊文件夹 */
    public final static String FOLDER_META = "METADATA";

    /** 元数据头-GTaskID - 元数据中存储Google Task ID的字段前缀 */
    public final static String META_HEAD_GTASK_ID = "meta_gid";

    /** 元数据头-便签 - 元数据中存储便签信息的字段前缀 */
    public final static String META_HEAD_NOTE = "meta_note";

    /** 元数据头-数据 - 元数据中存储便签详细数据的字段前缀 */
    public final static String META_HEAD_DATA = "meta_data";

    /** 元数据便签名称 - 用于存储同步元数据的特殊便签的名称（提示用户不要修改） */
    public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE";
}