添加注释

src/Notes-master/app/src/main/java/net/micode/notes/model/Note.java

@@ -15,6 +15,7 @@
  */
 
 package net.micode.notes.model;
+
 import android.content.ContentProviderOperation;
 import android.content.ContentProviderResult;
 import android.content.ContentUris;
@@ -33,16 +34,28 @@ import net.micode.notes.data.Notes.TextNote;
 
 import java.util.ArrayList;
 
-
+/**
+ * Note 类用于管理笔记数据，提供创建、更新、同步笔记的功能。
+ * 该类封装了与笔记相关的数据操作，包括基本笔记信息和附加数据（如文本内容、通话记录等）。
+ */
 public class Note {
+    // 存储笔记基本信息的变更值
     private ContentValues mNoteDiffValues;
+    // 管理笔记附加数据的内部类实例
     private NoteData mNoteData;
+    // 日志标签
     private static final String TAG = "Note";
+
     /**
-     * Create a new note id for adding a new note to databases
+     * 静态方法，创建新笔记并返回其ID。
+     * 
+     * @param context 应用上下文
+     * @param folderId 笔记所属文件夹ID
+     * @return 新创建笔记的ID
+     * @throws IllegalStateException 当获取到无效的笔记ID时抛出
      */
     public static synchronized long getNewNoteId(Context context, long folderId) {
-        // Create a new note in the database
+        // 创建新笔记记录，设置创建时间、修改时间、类型、修改状态和父文件夹ID
         ContentValues values = new ContentValues();
         long createdTime = System.currentTimeMillis();
         values.put(NoteColumns.CREATED_DATE, createdTime);
@@ -50,8 +63,11 @@ public class Note {
         values.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
         values.put(NoteColumns.LOCAL_MODIFIED, 1);
         values.put(NoteColumns.PARENT_ID, folderId);
+        
+        // 插入新笔记记录并获取返回的URI
         Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values);
 
+        // 从URI中提取笔记ID
         long noteId = 0;
         try {
             noteId = Long.valueOf(uri.getPathSegments().get(1));
@@ -59,69 +75,124 @@ public class Note {
             Log.e(TAG, "Get note id error :" + e.toString());
             noteId = 0;
         }
+        
+        // 验证笔记ID有效性
         if (noteId == -1) {
             throw new IllegalStateException("Wrong note id:" + noteId);
         }
         return noteId;
     }
 
+    /**
+     * 构造函数，初始化笔记数据结构
+     */
     public Note() {
         mNoteDiffValues = new ContentValues();
         mNoteData = new NoteData();
     }
 
+    /**
+     * 设置笔记的基本属性值
+     * 
+     * @param key 属性键名
+     * @param value 属性值
+     */
     public void setNoteValue(String key, String value) {
         mNoteDiffValues.put(key, value);
+        // 标记笔记已被修改，并更新修改时间
         mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
         mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
     }
 
+    /**
+     * 设置笔记的文本内容数据
+     * 
+     * @param key 文本数据键名
+     * @param value 文本数据值
+     */
     public void setTextData(String key, String value) {
         mNoteData.setTextData(key, value);
     }
 
+    /**
+     * 设置文本数据ID
+     * 
+     * @param id 文本数据ID
+     */
     public void setTextDataId(long id) {
         mNoteData.setTextDataId(id);
     }
 
+    /**
+     * 获取文本数据ID
+     * 
+     * @return 文本数据ID
+     */
     public long getTextDataId() {
         return mNoteData.mTextDataId;
     }
 
+    /**
+     * 设置通话记录数据ID
+     * 
+     * @param id 通话记录数据ID
+     */
     public void setCallDataId(long id) {
         mNoteData.setCallDataId(id);
     }
 
+    /**
+     * 设置通话记录数据
+     * 
+     * @param key 通话数据键名
+     * @param value 通话数据值
+     */
     public void setCallData(String key, String value) {
         mNoteData.setCallData(key, value);
     }
 
+    /**
+     * 检查笔记是否有本地修改
+     * 
+     * @return 如果有修改返回true，否则返回false
+     */
     public boolean isLocalModified() {
         return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
     }
 
+    /**
+     * 将笔记的本地修改同步到内容提供者
+     * 
+     * @param context 应用上下文
+     * @param noteId 笔记ID
+     * @return 同步成功返回true，失败返回false
+     * @throws IllegalArgumentException 当笔记ID无效时抛出
+     */
     public boolean syncNote(Context context, long noteId) {
+        // 验证笔记ID有效性
         if (noteId <= 0) {
             throw new IllegalArgumentException("Wrong note id:" + noteId);
         }
 
+        // 如果没有修改，直接返回成功
         if (!isLocalModified()) {
             return true;
         }
 
         /**
-         * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and
+         * 理论上，一旦数据发生变化，笔记应该在{@link NoteColumns#LOCAL_MODIFIED}和
-         * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the
+         * {@link NoteColumns#MODIFIED_DATE}上更新。为了数据安全，即使更新笔记失败，
-         * note data info
+         * 我们也会更新笔记数据信息
          */
         if (context.getContentResolver().update(
                 ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null,
                 null) == 0) {
             Log.e(TAG, "Update note error, should not happen");
-            // Do not return, fall through
+            // 不返回，继续执行
         }
         mNoteDiffValues.clear();
 
+        // 同步笔记的附加数据，如果失败则返回false
         if (mNoteData.isLocalModified()
                 && (mNoteData.pushIntoContentResolver(context, noteId) == null)) {
             return false;
@@ -130,17 +201,24 @@ public class Note {
         return true;
     }
 
+    /**
+     * 内部类，用于管理笔记的附加数据，包括文本内容和通话记录
+     */
     private class NoteData {
+        // 文本数据ID
         private long mTextDataId;
-
+        // 存储文本数据的变更值
         private ContentValues mTextDataValues;
-
+        // 通话记录数据ID
         private long mCallDataId;
-
+        // 存储通话记录数据的变更值
         private ContentValues mCallDataValues;
-
+        // 日志标签
         private static final String TAG = "NoteData";
 
+        /**
+         * 构造函数，初始化数据结构
+         */
         public NoteData() {
             mTextDataValues = new ContentValues();
             mCallDataValues = new ContentValues();
@@ -148,10 +226,21 @@ public class Note {
             mCallDataId = 0;
         }
 
+        /**
+         * 检查附加数据是否有本地修改
+         * 
+         * @return 如果有修改返回true，否则返回false
+         */
         boolean isLocalModified() {
             return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
         }
 
+        /**
+         * 设置文本数据ID
+         * 
+         * @param id 文本数据ID
+         * @throws IllegalArgumentException 当ID无效时抛出
+         */
         void setTextDataId(long id) {
             if(id <= 0) {
                 throw new IllegalArgumentException("Text data id should larger than 0");
@@ -159,6 +248,12 @@ public class Note {
             mTextDataId = id;
         }
 
+        /**
+         * 设置通话记录数据ID
+         * 
+         * @param id 通话记录数据ID
+         * @throws IllegalArgumentException 当ID无效时抛出
+         */
         void setCallDataId(long id) {
             if (id <= 0) {
                 throw new IllegalArgumentException("Call data id should larger than 0");
@@ -166,36 +261,64 @@ public class Note {
             mCallDataId = id;
         }
 
+        /**
+         * 设置通话记录数据
+         * 
+         * @param key 通话数据键名
+         * @param value 通话数据值
+         */
         void setCallData(String key, String value) {
             mCallDataValues.put(key, value);
+            // 标记笔记已被修改，并更新修改时间
             mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
             mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
         }
 
+        /**
+         * 设置文本内容数据
+         * 
+         * @param key 文本数据键名
+         * @param value 文本数据值
+         */
         void setTextData(String key, String value) {
             mTextDataValues.put(key, value);
+            // 标记笔记已被修改，并更新修改时间
             mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
             mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
         }
 
+        /**
+         * 将附加数据推送到内容提供者
+         * 
+         * @param context 应用上下文
+         * @param noteId 笔记ID
+         * @return 操作成功返回笔记URI，失败返回null
+         * @throws IllegalArgumentException 当笔记ID无效时抛出
+         */
         Uri pushIntoContentResolver(Context context, long noteId) {
             /**
-             * Check for safety
+             * 安全检查
              */
             if (noteId <= 0) {
                 throw new IllegalArgumentException("Wrong note id:" + noteId);
             }
 
+            // 创建操作列表，用于批量执行内容提供者操作
             ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
             ContentProviderOperation.Builder builder = null;
 
+            // 处理文本数据
             if(mTextDataValues.size() > 0) {
+                // 设置文本数据关联的笔记ID
                 mTextDataValues.put(DataColumns.NOTE_ID, noteId);
+                
+                // 如果是新文本数据，执行插入操作
                 if (mTextDataId == 0) {
                     mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE);
                     Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                             mTextDataValues);
                     try {
+                        // 保存插入后的文本数据ID
                         setTextDataId(Long.valueOf(uri.getPathSegments().get(1)));
                     } catch (NumberFormatException e) {
                         Log.e(TAG, "Insert new text data fail with noteId" + noteId);
@@ -203,6 +326,7 @@ public class Note {
                         return null;
                     }
                 } else {
+                    // 如果是已存在的文本数据，执行更新操作
                     builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                             Notes.CONTENT_DATA_URI, mTextDataId));
                     builder.withValues(mTextDataValues);
@@ -211,13 +335,18 @@ public class Note {
                 mTextDataValues.clear();
             }
 
+            // 处理通话记录数据
             if(mCallDataValues.size() > 0) {
+                // 设置通话记录数据关联的笔记ID
                 mCallDataValues.put(DataColumns.NOTE_ID, noteId);
+                
+                // 如果是新通话记录数据，执行插入操作
                 if (mCallDataId == 0) {
                     mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE);
                     Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI,
                             mCallDataValues);
                     try {
+                        // 保存插入后的通话记录数据ID
                         setCallDataId(Long.valueOf(uri.getPathSegments().get(1)));
                     } catch (NumberFormatException e) {
                         Log.e(TAG, "Insert new call data fail with noteId" + noteId);
@@ -225,6 +354,7 @@ public class Note {
                         return null;
                     }
                 } else {
+                    // 如果是已存在的通话记录数据，执行更新操作
                     builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(
                             Notes.CONTENT_DATA_URI, mCallDataId));
                     builder.withValues(mCallDataValues);
@@ -233,6 +363,7 @@ public class Note {
                 mCallDataValues.clear();
             }
 
+            // 批量执行内容提供者操作
             if (operationList.size() > 0) {
                 try {
                     ContentProviderResult[] results = context.getContentResolver().applyBatch(