Update MetaData.java

源程序代码-小米便签-Notes-master/Notes-master/src/net/micode/notes/gtask/data/MetaData.java

@@ -24,56 +24,87 @@ import net.micode.notes.tool.GTaskStringUtils;
 import org.json.JSONException;
 import org.json.JSONObject;
 
-
+/**
+ * 元数据实体类，继承自Task，用于存储与Google Tasks相关的元数据信息
+ * 主要处理元数据的JSON解析、关联GID管理等逻辑
+ */
 public class MetaData extends Task {
     private final static String TAG = MetaData.class.getSimpleName();
-
+	// 关联的Google Tasks的GID（全局唯一标识符）
     private String mRelatedGid = null;
-
+    /**
+     * 设置元数据信息
+     * @param gid 关联的Google Tasks的GID
+     * @param metaInfo 包含元数据的JSON对象
+     */
     public void setMeta(String gid, JSONObject metaInfo) {
         try {
+          // 在元数据JSON中添加GID头部信息
             metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
         } catch (JSONException e) {
             Log.e(TAG, "failed to put related gid");
         }
+      // 将元数据JSON转为字符串存储到便签内容中
         setNotes(metaInfo.toString());
+       // 设置元数据对应的便签名称（固定为预定义常量）
         setName(GTaskStringUtils.META_NOTE_NAME);
     }
-
+    /**
+     * 获取关联的Google Tasks的GID
+     * @return 关联的GID，若无则返回null
+     */
     public String getRelatedGid() {
         return mRelatedGid;
     }
-
+    /**
+     * 判断元数据是否值得保存（当前逻辑：只要便签内容不为空则值得保存）
+     * @return 便签内容不为null时返回true，否则false
+     */
     @Override
     public boolean isWorthSaving() {
         return getNotes() != null;
     }
-
+    /**
+     * 从远程JSON数据中解析并设置元数据内容（供同步模块调用）
+     * @param js 包含远程数据的JSON对象
+     */
     @Override
     public void setContentByRemoteJSON(JSONObject js) {
-        super.setContentByRemoteJSON(js);
+        super.setContentByRemoteJSON(js);   // 先调用父类解析逻辑
         if (getNotes() != null) {
             try {
+              // 解析便签内容中的元数据JSON
                 JSONObject metaInfo = new JSONObject(getNotes().trim());
+              // 提取关联的GID
                 mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
             } catch (JSONException e) {
                 Log.w(TAG, "failed to get related gid");
-                mRelatedGid = null;
+                mRelatedGid = null;  // 解析失败时清空GID
             }
         }
     }
-
+    /**
+     * 本地JSON内容设置方法（禁止调用）
+     * @throws IllegalAccessError 始终抛出异常，表明该方法不允许使用
+     */
     @Override
     public void setContentByLocalJSON(JSONObject js) {
         // this function should not be called
         throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
     }
-
+    /**
+     * 获取本地JSON内容方法（禁止调用）
+     * @throws IllegalAccessError 始终抛出异常，表明该方法不允许使用
+     */
     @Override
     public JSONObject getLocalJSONFromContent() {
         throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
     }
-
+    /**
+     * 获取同步操作类型（禁止调用）
+     * @param c 数据库游标（未使用）
+     * @throws IllegalAccessError 始终抛出异常，表明该方法不允许使用
+     */
     @Override
     public int getSyncAction(Cursor c) {
         throw new IllegalAccessError("MetaData:getSyncAction should not be called");