From 26e528412b3d3ee17a0d03f459d642baf68faa06 Mon Sep 17 00:00:00 2001 From: chengshuaishuai <2087761457@qq.com> Date: Tue, 13 May 2025 22:32:43 +0800 Subject: [PATCH] second test --- src/tool/BackupUtils.java | 162 +++++++++++++++++++++--------- src/tool/DataUtils(1).java | 106 ++++++++++++++++++- src/tool/GTaskStringUtils(1).java | 145 +++++++++++++++++--------- src/tool/ResourceParser(1).java | 125 +++++++++++++++++++++-- 4 files changed, 435 insertions(+), 103 deletions(-) diff --git a/src/tool/BackupUtils.java b/src/tool/BackupUtils.java index 39f6ec4..a89566b 100644 --- a/src/tool/BackupUtils.java +++ b/src/tool/BackupUtils.java @@ -35,12 +35,21 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintStream; - +/** + * 备份工具类，用于将笔记导出为文本文件 + * 支持导出所有笔记、文件夹和通话记录，并按照指定格式保存到SD卡 + */ public class BackupUtils { private static final String TAG = "BackupUtils"; - // Singleton stuff + // 单例模式实例 private static BackupUtils sInstance; + /** + * 获取BackupUtils的单例实例 + * + * @param context 应用上下文 + * @return BackupUtils实例 + */ public static synchronized BackupUtils getInstance(Context context) { if (sInstance == null) { sInstance = new BackupUtils(context); @@ -49,18 +58,17 @@ public class BackupUtils { } /** - * Following states are signs to represents backup or restore - * status + * 备份或恢复操作的状态码 */ - // Currently, the sdcard is not mounted + // 当前SD卡未挂载 public static final int STATE_SD_CARD_UNMOUONTED = 0; - // The backup file not exist + // 备份文件不存在 public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; - // The data is not well formated, may be changed by other programs + // 数据格式损坏，可能被其他程序修改 public static final int STATE_DATA_DESTROIED = 2; - // Some run-time exception which causes restore or backup fails + // 运行时异常导致备份或恢复失败 public static final int STATE_SYSTEM_ERROR = 3; - // Backup or restore success + // 备份或恢复成功 public static final int STATE_SUCCESS = 4; private TextExport mTextExport; @@ -69,78 +77,112 @@ public class BackupUtils { mTextExport = new TextExport(context); } + /** + * 检查外部存储是否可用 + * + * @return 可用返回true，否则返回false + */ private static boolean externalStorageAvailable() { return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } + /** + * 导出笔记为文本文件 + * + * @return 操作状态码 + */ public int exportToText() { return mTextExport.exportToText(); } + /** + * 获取导出的文本文件名 + * + * @return 文件名 + */ public String getExportedTextFileName() { return mTextExport.mFileName; } + /** + * 获取导出的文本文件目录 + * + * @return 文件目录 + */ public String getExportedTextFileDir() { return mTextExport.mFileDirectory; } + /** + * 内部类：文本导出器，负责将笔记数据导出为文本格式 + */ private static class TextExport { + // 笔记查询投影，指定要查询的列 private static final String[] NOTE_PROJECTION = { - NoteColumns.ID, - NoteColumns.MODIFIED_DATE, - NoteColumns.SNIPPET, - NoteColumns.TYPE + NoteColumns.ID, // 笔记ID + NoteColumns.MODIFIED_DATE, // 修改日期 + NoteColumns.SNIPPET, // 摘要 + NoteColumns.TYPE // 类型 }; + // 笔记投影列索引 private static final int NOTE_COLUMN_ID = 0; - private static final int NOTE_COLUMN_MODIFIED_DATE = 1; - private static final int NOTE_COLUMN_SNIPPET = 2; + // 数据查询投影，指定要查询的数据列 private static final String[] DATA_PROJECTION = { - DataColumns.CONTENT, - DataColumns.MIME_TYPE, - DataColumns.DATA1, - DataColumns.DATA2, - DataColumns.DATA3, - DataColumns.DATA4, + DataColumns.CONTENT, // 内容 + DataColumns.MIME_TYPE, // MIME类型 + DataColumns.DATA1, // 数据1（通话记录中存储通话日期） + DataColumns.DATA2, // 数据2 + DataColumns.DATA3, // 数据3 + DataColumns.DATA4, // 数据4（通话记录中存储电话号码） }; + // 数据投影列索引 private static final int DATA_COLUMN_CONTENT = 0; - private static final int DATA_COLUMN_MIME_TYPE = 1; - private static final int DATA_COLUMN_CALL_DATE = 2; - private static final int DATA_COLUMN_PHONE_NUMBER = 4; + // 导出文本的格式数组 private final String [] TEXT_FORMAT; - private static final int FORMAT_FOLDER_NAME = 0; - private static final int FORMAT_NOTE_DATE = 1; - private static final int FORMAT_NOTE_CONTENT = 2; + // 格式数组索引常量 + private static final int FORMAT_FOLDER_NAME = 0; // 文件夹名称格式 + private static final int FORMAT_NOTE_DATE = 1; // 笔记日期格式 + private static final int FORMAT_NOTE_CONTENT = 2; // 笔记内容格式 private Context mContext; - private String mFileName; - private String mFileDirectory; + private String mFileName; // 导出的文件名 + private String mFileDirectory; // 导出的文件目录 public TextExport(Context context) { + // 从资源文件中获取导出格式数组 TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); mContext = context; mFileName = ""; mFileDirectory = ""; } + /** + * 获取指定ID的格式字符串 + * + * @param id 格式ID + * @return 格式字符串 + */ private String getFormat(int id) { return TEXT_FORMAT[id]; } /** - * Export the folder identified by folder id to text + * 将指定文件夹下的所有笔记导出为文本 + * + * @param folderId 文件夹ID + * @param ps 输出流 */ private void exportFolderToText(String folderId, PrintStream ps) { - // Query notes belong to this folder + // 查询属于该文件夹的所有笔记 Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { folderId @@ -149,11 +191,11 @@ public class BackupUtils { if (notesCursor != null) { if (notesCursor.moveToFirst()) { do { - // Print note's last modified date + // 打印笔记的最后修改日期 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询属于该笔记的数据 String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (notesCursor.moveToNext()); @@ -163,9 +205,13 @@ public class BackupUtils { } /** - * Export note identified by id to a print stream + * 将指定ID的笔记导出到输出流 + * + * @param noteId 笔记ID + * @param ps 输出流 */ private void exportNoteToText(String noteId, PrintStream ps) { + // 查询属于该笔记的所有数据（包括文本内容、通话记录等） Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { noteId @@ -176,7 +222,8 @@ public class BackupUtils { do { String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); if (DataConstants.CALL_NOTE.equals(mimeType)) { - // Print phone number + // 处理通话记录类型 + // 打印电话号码 String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); String location = dataCursor.getString(DATA_COLUMN_CONTENT); @@ -185,16 +232,17 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), phoneNumber)); } - // Print call date + // 打印通话日期 ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat .format(mContext.getString(R.string.format_datetime_mdhm), callDate))); - // Print call attachment location + // 打印通话附件位置 if (!TextUtils.isEmpty(location)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); } } else if (DataConstants.NOTE.equals(mimeType)) { + // 处理普通笔记类型 String content = dataCursor.getString(DATA_COLUMN_CONTENT); if (!TextUtils.isEmpty(content)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), @@ -205,7 +253,7 @@ public class BackupUtils { } dataCursor.close(); } - // print a line separator between note + // 在笔记之间打印分隔符 try { ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER @@ -216,20 +264,25 @@ public class BackupUtils { } /** - * Note will be exported as text which is user readable + * 将所有笔记导出为用户可读的文本格式 + * + * @return 操作状态码 */ public int exportToText() { + // 检查外部存储是否可用 if (!externalStorageAvailable()) { Log.d(TAG, "Media was not mounted"); return STATE_SD_CARD_UNMOUONTED; } + // 获取用于导出的打印流 PrintStream ps = getExportToTextPrintStream(); if (ps == null) { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; } - // First export folder and its notes + + // 首先导出文件夹及其包含的笔记 Cursor folderCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -240,7 +293,7 @@ public class BackupUtils { if (folderCursor != null) { if (folderCursor.moveToFirst()) { do { - // Print folder's name + // 打印文件夹名称 String folderName = ""; if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { folderName = mContext.getString(R.string.call_record_folder_name); @@ -257,20 +310,21 @@ public class BackupUtils { folderCursor.close(); } - // Export notes in root's folder + // 导出根文件夹中的笔记 Cursor noteCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, - NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID + "=0", null, null); if (noteCursor != null) { if (noteCursor.moveToFirst()) { do { + // 打印笔记的最后修改日期 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询属于该笔记的数据 String noteId = noteCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (noteCursor.moveToNext()); @@ -283,9 +337,12 @@ public class BackupUtils { } /** - * Get a print stream pointed to the file {@generateExportedTextFile} + * 获取指向导出文本文件的打印流 + * + * @return 打印流，如果出错则返回null */ private PrintStream getExportToTextPrintStream() { + // 生成存储在SD卡上的文件 File file = generateFileMountedOnSDcard(mContext, R.string.file_path, R.string.file_name_txt_format); if (file == null) { @@ -310,13 +367,20 @@ public class BackupUtils { } /** - * Generate the text file to store imported data + * 生成存储在SD卡上的文件 + * + * @param context 应用上下文 + * @param filePathResId 文件路径资源ID + * @param fileNameFormatResId 文件名格式资源ID + * @return 生成的文件，如果出错则返回null */ private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { StringBuilder sb = new StringBuilder(); + // 构建文件路径 sb.append(Environment.getExternalStorageDirectory()); sb.append(context.getString(filePathResId)); File filedir = new File(sb.toString()); + // 构建文件名（包含时间戳） sb.append(context.getString( fileNameFormatResId, DateFormat.format(context.getString(R.string.format_date_ymd), @@ -324,9 +388,11 @@ public class BackupUtils { File file = new File(sb.toString()); try { + // 创建目录（如果不存在） if (!filedir.exists()) { filedir.mkdir(); } + // 创建文件（如果不存在） if (!file.exists()) { file.createNewFile(); } @@ -339,6 +405,4 @@ public class BackupUtils { return null; } -} - - +} \ No newline at end of file diff --git a/src/tool/DataUtils(1).java b/src/tool/DataUtils(1).java index 2a14982..068accb 100644 --- a/src/tool/DataUtils(1).java +++ b/src/tool/DataUtils(1).java @@ -34,9 +34,20 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; - +/** + * 数据工具类，提供笔记数据的增删改查等操作方法 + * 包含批量操作、数据检查、文件夹管理等功能 + */ public class DataUtils { public static final String TAG = "DataUtils"; + + /** + * 批量删除笔记 + * + * @param resolver ContentResolver对象 + * @param ids 要删除的笔记ID集合 + * @return 删除成功返回true，失败返回false + */ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { if (ids == null) { Log.d(TAG, "the ids is null"); @@ -53,11 +64,13 @@ public class DataUtils { Log.e(TAG, "Don't delete system folder root"); continue; } + // 构建删除操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); operationList.add(builder.build()); } try { + // 批量执行删除操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); @@ -72,14 +85,31 @@ public class DataUtils { return false; } + /** + * 将笔记移动到指定文件夹 + * + * @param resolver ContentResolver对象 + * @param id 要移动的笔记ID + * @param srcFolderId 源文件夹ID + * @param desFolderId 目标文件夹ID + */ public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) { ContentValues values = new ContentValues(); values.put(NoteColumns.PARENT_ID, desFolderId); values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); values.put(NoteColumns.LOCAL_MODIFIED, 1); + // 更新笔记的父文件夹信息 resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); } + /** + * 批量将笔记移动到指定文件夹 + * + * @param resolver ContentResolver对象 + * @param ids 要移动的笔记ID集合 + * @param folderId 目标文件夹ID + * @return 移动成功返回true，失败返回false + */ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, long folderId) { if (ids == null) { @@ -89,6 +119,7 @@ public class DataUtils { ArrayList operationList = new ArrayList(); for (long id : ids) { + // 构建更新操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); builder.withValue(NoteColumns.PARENT_ID, folderId); @@ -97,6 +128,7 @@ public class DataUtils { } try { + // 批量执行更新操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); @@ -112,7 +144,10 @@ public class DataUtils { } /** - * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} + * 获取用户文件夹数量（不包括系统文件夹） + * + * @param resolver ContentResolver对象 + * @return 用户文件夹数量 */ public static int getUserFolderCount(ContentResolver resolver) { Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, @@ -136,6 +171,14 @@ public class DataUtils { return count; } + /** + * 检查笔记是否在数据库中可见（类型匹配且不在回收站） + * + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @param type 笔记类型 + * @return 存在返回true，不存在返回false + */ public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, @@ -153,6 +196,13 @@ public class DataUtils { return exist; } + /** + * 检查笔记是否存在于数据库中 + * + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @return 存在返回true，不存在返回false + */ public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, null, null, null); @@ -167,6 +217,13 @@ public class DataUtils { return exist; } + /** + * 检查数据项是否存在于数据库中 + * + * @param resolver ContentResolver对象 + * @param dataId 数据ID + * @return 存在返回true，不存在返回false + */ public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null, null, null, null); @@ -181,6 +238,13 @@ public class DataUtils { return exist; } + /** + * 检查可见文件夹中是否存在指定名称的文件夹 + * + * @param resolver ContentResolver对象 + * @param name 文件夹名称 + * @return 存在返回true，不存在返回false + */ public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + @@ -197,6 +261,13 @@ public class DataUtils { return exist; } + /** + * 获取指定文件夹下的所有笔记小部件属性 + * + * @param resolver ContentResolver对象 + * @param folderId 文件夹ID + * @return 包含小部件属性的集合 + */ public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, @@ -224,6 +295,13 @@ public class DataUtils { return set; } + /** + * 根据笔记ID获取通话记录的电话号码 + * + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @return 电话号码，如果不存在则返回空字符串 + */ public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.PHONE_NUMBER }, @@ -243,6 +321,14 @@ public class DataUtils { return ""; } + /** + * 根据电话号码和通话日期获取笔记ID + * + * @param resolver ContentResolver对象 + * @param phoneNumber 电话号码 + * @param callDate 通话日期 + * @return 笔记ID，如果不存在则返回0 + */ public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.NOTE_ID }, @@ -264,6 +350,14 @@ public class DataUtils { return 0; } + /** + * 根据笔记ID获取摘要信息 + * + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @return 摘要信息 + * @throws IllegalArgumentException 如果笔记不存在 + */ public static String getSnippetById(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, new String [] { NoteColumns.SNIPPET }, @@ -282,6 +376,12 @@ public class DataUtils { throw new IllegalArgumentException("Note is not found with id: " + noteId); } + /** + * 格式化摘要信息（去除首尾空格，截取第一行） + * + * @param snippet 原始摘要 + * @return 格式化后的摘要 + */ public static String getFormattedSnippet(String snippet) { if (snippet != null) { snippet = snippet.trim(); @@ -292,4 +392,4 @@ public class DataUtils { } return snippet; } -} +} \ No newline at end of file diff --git a/src/tool/GTaskStringUtils(1).java b/src/tool/GTaskStringUtils(1).java index 666b729..afe38fc 100644 --- a/src/tool/GTaskStringUtils(1).java +++ b/src/tool/GTaskStringUtils(1).java @@ -16,98 +16,153 @@ package net.micode.notes.tool; +/** + * Google Tasks同步相关的字符串常量定义类 + * 包含JSON数据结构中的字段名、文件夹名称、元数据标识等常量 + */ public class GTaskStringUtils { + // ====== JSON请求/响应字段名 ====== + + /** 操作ID，用于标识特定操作 */ public final static String GTASK_JSON_ACTION_ID = "action_id"; - + + /** 操作列表，包含多个操作的数组 */ public final static String GTASK_JSON_ACTION_LIST = "action_list"; - + + /** 操作类型字段 */ 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字段 */ public final static String GTASK_JSON_CREATOR_ID = "creator_id"; - + + /** 子实体字段 */ public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; - + + /** 客户端版本字段 */ public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; - + + /** 完成状态字段 */ public final static String GTASK_JSON_COMPLETED = "completed"; - + + /** 当前列表ID字段 */ public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; - + + /** 默认列表ID字段 */ public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; - + + /** 删除状态字段 */ public final static String GTASK_JSON_DELETED = "deleted"; - + + /** 目标列表字段 */ public final static String GTASK_JSON_DEST_LIST = "dest_list"; - + + /** 目标父级ID字段 */ public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; - + + /** 目标父级类型字段 */ public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; - + + /** 实体差异字段，用于增量同步 */ public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; - + + /** 实体类型字段 */ public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; - + + /** 获取已删除项的标识字段 */ public final static String GTASK_JSON_GET_DELETED = "get_deleted"; - + + /** ID字段 */ public final static String GTASK_JSON_ID = "id"; - + + /** 索引位置字段 */ public final static String GTASK_JSON_INDEX = "index"; - + + /** 最后修改时间字段 */ public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; - + + /** 最新同步点字段 */ public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; - + + /** 列表ID字段 */ public final static String GTASK_JSON_LIST_ID = "list_id"; - + + /** 列表集合字段 */ public final static String GTASK_JSON_LISTS = "lists"; - + + /** 名称字段 */ public final static String GTASK_JSON_NAME = "name"; - + + /** 新ID字段，用于创建操作返回 */ public final static String GTASK_JSON_NEW_ID = "new_id"; - + + /** 备注字段 */ public final static String GTASK_JSON_NOTES = "notes"; - + + /** 父级ID字段 */ public final static String GTASK_JSON_PARENT_ID = "parent_id"; - + + /** 前一个兄弟节点ID字段 */ public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; - + + /** 结果字段 */ public final static String GTASK_JSON_RESULTS = "results"; - + + /** 源列表字段 */ public final static String GTASK_JSON_SOURCE_LIST = "source_list"; - + + /** 任务集合字段 */ public final static String GTASK_JSON_TASKS = "tasks"; - + + /** 类型字段 */ public final static String GTASK_JSON_TYPE = "type"; - + + /** 组类型值 */ public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; - + + /** 任务类型值 */ public final static String GTASK_JSON_TYPE_TASK = "TASK"; - + + /** 用户字段 */ public final static String GTASK_JSON_USER = "user"; + // ====== 文件夹相关常量 ====== + + /** MIUI便签专用文件夹前缀，用于标识由MIUI便签创建的文件夹 */ public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; - + + /** 默认文件夹名称 */ public final static String FOLDER_DEFAULT = "Default"; - + + /** 通话记录文件夹名称 */ public final static String FOLDER_CALL_NOTE = "Call_Note"; - + + /** 元数据文件夹名称 */ public final static String FOLDER_META = "METADATA"; + // ====== 元数据头部标识 ====== + + /** 元数据中存储Google Tasks 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"; - -} +} \ No newline at end of file diff --git a/src/tool/ResourceParser(1).java b/src/tool/ResourceParser(1).java index 1ad3ad6..ec7cd8e 100644 --- a/src/tool/ResourceParser(1).java +++ b/src/tool/ResourceParser(1).java @@ -22,24 +22,47 @@ import android.preference.PreferenceManager; import net.micode.notes.R; import net.micode.notes.ui.NotesPreferenceActivity; +/** + * 资源解析工具类 + * 提供便签颜色、大小、背景资源等的解析和管理功能 + */ public class ResourceParser { + // ====== 便签颜色常量 ====== + + /** 黄色便签标识 */ public static final int YELLOW = 0; + /** 蓝色便签标识 */ public static final int BLUE = 1; + /** 白色便签标识 */ public static final int WHITE = 2; + /** 绿色便签标识 */ public static final int GREEN = 3; + /** 红色便签标识 */ public static final int RED = 4; - + + /** 默认便签颜色（黄色） */ public static final int BG_DEFAULT_COLOR = YELLOW; + // ====== 文本大小常量 ====== + + /** 小号文本标识 */ public static final int TEXT_SMALL = 0; + /** 中号文本标识（默认） */ public static final int TEXT_MEDIUM = 1; + /** 大号文本标识 */ public static final int TEXT_LARGE = 2; + /** 超大号文本标识 */ public static final int TEXT_SUPER = 3; - + + /** 默认字体大小（中等） */ public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; + /** + * 编辑界面便签背景资源管理类 + */ public static class NoteBgResources { + /** 便签编辑界面背景资源数组 */ private final static int [] BG_EDIT_RESOURCES = new int [] { R.drawable.edit_yellow, R.drawable.edit_blue, @@ -48,6 +71,7 @@ public class ResourceParser { R.drawable.edit_red }; + /** 便签编辑界面标题背景资源数组 */ private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] { R.drawable.edit_title_yellow, R.drawable.edit_title_blue, @@ -56,25 +80,51 @@ public class ResourceParser { R.drawable.edit_title_red }; + /** + * 获取指定颜色的便签编辑界面背景资源ID + * + * @param id 颜色ID（使用ResourceParser中定义的颜色常量） + * @return 背景资源ID + */ public static int getNoteBgResource(int id) { return BG_EDIT_RESOURCES[id]; } + /** + * 获取指定颜色的便签编辑界面标题背景资源ID + * + * @param id 颜色ID（使用ResourceParser中定义的颜色常量） + * @return 标题背景资源ID + */ public static int getNoteTitleBgResource(int id) { return BG_EDIT_TITLE_RESOURCES[id]; } } + /** + * 获取默认便签背景颜色ID + * 根据用户设置决定是返回固定默认颜色还是随机颜色 + * + * @param context 应用上下文 + * @return 背景颜色ID + */ public static int getDefaultBgId(Context context) { if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { + // 如果用户开启了随机颜色选项，则返回随机颜色 return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); } else { + // 否则返回固定的默认颜色 return BG_DEFAULT_COLOR; } } + /** + * 列表项便签背景资源管理类 + * 管理便签在列表中不同位置（首项、中间项、末项、单独项）的背景资源 + */ public static class NoteItemBgResources { + /** 列表中第一个便签的背景资源数组 */ private final static int [] BG_FIRST_RESOURCES = new int [] { R.drawable.list_yellow_up, R.drawable.list_blue_up, @@ -83,6 +133,7 @@ public class ResourceParser { R.drawable.list_red_up }; + /** 列表中中间便签的背景资源数组 */ private final static int [] BG_NORMAL_RESOURCES = new int [] { R.drawable.list_yellow_middle, R.drawable.list_blue_middle, @@ -91,6 +142,7 @@ public class ResourceParser { R.drawable.list_red_middle }; + /** 列表中最后一个便签的背景资源数组 */ private final static int [] BG_LAST_RESOURCES = new int [] { R.drawable.list_yellow_down, R.drawable.list_blue_down, @@ -99,6 +151,7 @@ public class ResourceParser { R.drawable.list_red_down, }; + /** 列表中单独便签（只有一项）的背景资源数组 */ private final static int [] BG_SINGLE_RESOURCES = new int [] { R.drawable.list_yellow_single, R.drawable.list_blue_single, @@ -107,28 +160,61 @@ public class ResourceParser { R.drawable.list_red_single }; + /** + * 获取列表中第一个便签的背景资源ID + * + * @param id 颜色ID + * @return 背景资源ID + */ public static int getNoteBgFirstRes(int id) { return BG_FIRST_RESOURCES[id]; } + /** + * 获取列表中最后一个便签的背景资源ID + * + * @param id 颜色ID + * @return 背景资源ID + */ public static int getNoteBgLastRes(int id) { return BG_LAST_RESOURCES[id]; } + /** + * 获取列表中单独便签的背景资源ID + * + * @param id 颜色ID + * @return 背景资源ID + */ public static int getNoteBgSingleRes(int id) { return BG_SINGLE_RESOURCES[id]; } + /** + * 获取列表中中间便签的背景资源ID + * + * @param id 颜色ID + * @return 背景资源ID + */ public static int getNoteBgNormalRes(int id) { return BG_NORMAL_RESOURCES[id]; } + /** + * 获取文件夹项的背景资源ID + * + * @return 文件夹背景资源ID + */ public static int getFolderBgRes() { return R.drawable.list_folder; } } + /** + * 桌面小部件背景资源管理类 + */ public static class WidgetBgResources { + /** 2x尺寸小部件的背景资源数组 */ private final static int [] BG_2X_RESOURCES = new int [] { R.drawable.widget_2x_yellow, R.drawable.widget_2x_blue, @@ -137,10 +223,17 @@ public class ResourceParser { R.drawable.widget_2x_red, }; + /** + * 获取2x尺寸小部件的背景资源ID + * + * @param id 颜色ID + * @return 背景资源ID + */ public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } + /** 4x尺寸小部件的背景资源数组 */ private final static int [] BG_4X_RESOURCES = new int [] { R.drawable.widget_4x_yellow, R.drawable.widget_4x_blue, @@ -149,12 +242,22 @@ public class ResourceParser { R.drawable.widget_4x_red }; + /** + * 获取4x尺寸小部件的背景资源ID + * + * @param id 颜色ID + * @return 背景资源ID + */ public static int getWidget4xBgResource(int id) { return BG_4X_RESOURCES[id]; } } + /** + * 文本外观资源管理类 + */ public static class TextAppearanceResources { + /** 文本外观资源数组 */ private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { R.style.TextAppearanceNormal, R.style.TextAppearanceMedium, @@ -162,11 +265,16 @@ public class ResourceParser { R.style.TextAppearanceSuper }; + /** + * 获取指定ID的文本外观资源 + * + * @param id 文本大小ID（使用ResourceParser中定义的文本大小常量） + * @return 文本外观资源ID + */ public static int getTexAppearanceResource(int id) { /** - * HACKME: Fix bug of store the resource id in shared preference. - * The id may larger than the length of resources, in this case, - * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} + * HACKME: 修复在共享偏好中存储资源ID的问题。 + * 如果ID大于资源数组长度，返回默认字体大小 */ if (id >= TEXTAPPEARANCE_RESOURCES.length) { return BG_DEFAULT_FONT_SIZE; @@ -174,8 +282,13 @@ public class ResourceParser { return TEXTAPPEARANCE_RESOURCES[id]; } + /** + * 获取文本外观资源的数量 + * + * @return 资源数量 + */ public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } } -} +} \ No newline at end of file