MetaData.java代码注释

notes/gtask/data/MetaData.java

@@ -26,15 +26,23 @@ import org.json.JSONObject;
 
 
 public class MetaData extends Task {
+    /*
+     功能描述：得到类的简写名称存入字符串TAG中
+     实现过程：调用getSimpleName()函数
+     */
     private final static String TAG = MetaData.class.getSimpleName();
 
     private String mRelatedGid = null;
 
+    /*
+     功能描述：设置数据，即生成元数据库
+     实现过程：调用JSONObject库函数put()，Task类中的函数setNotes()和setName()函数
+     */
     public void setMeta(String gid, JSONObject metaInfo) {
         try {
             metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
         } catch (JSONException e) {
-            Log.e(TAG, "failed to put related gid");
+            Log.e(TAG, "failed to put related gid");//输出错误信息
         }
         setNotes(metaInfo.toString());
         setName(GTaskStringUtils.META_NOTE_NAME);
@@ -42,13 +50,17 @@ public class MetaData extends Task {
 
     public String getRelatedGid() {
         return mRelatedGid;
-    }
+    }//获取相关联的Gid
 
     @Override
     public boolean isWorthSaving() {
         return getNotes() != null;
-    }
+    }//判断当前数据是否为空，若为空则返回真即值得保存
 
+    /*
+     功能描述：使用远程json数据对象设置元素数据内容
+     实现过程：调用父类setContentByRemoteJSON()函数
+     */
     @Override
     public void setContentByRemoteJSON(JSONObject js) {
         super.setContentByRemoteJSON(js);
@@ -57,26 +69,34 @@ public class MetaData extends Task {
                 JSONObject metaInfo = new JSONObject(getNotes().trim());
                 mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
             } catch (JSONException e) {
-                Log.w(TAG, "failed to get related gid");
+                Log.w(TAG, "failed to get related gid");//输出警告信息
                 mRelatedGid = null;
             }
         }
     }
 
+    /*
+     功能描述：使用本地json数据对象设置元数据内容，一般用不到，若用到则抛出异常
+     */
     @Override
     public void setContentByLocalJSON(JSONObject js) {
         // this function should not be called
-        throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
+        throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");//传递非法参数异常
     }
 
+    /*
+     功能描述：从元数据内容总获取本地json对象，一般用不到，若用到则抛出异常
+     */
     @Override
     public JSONObject getLocalJSONFromContent() {
         throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
     }
 
+    /*
+     功能描述：获取同步动作状态，一般用不到，若用到则抛出异常
+     */
     @Override
     public int getSyncAction(Cursor c) {
-        throw new IllegalAccessError("MetaData:getSyncAction should not be called");
+        throw new IllegalAccessError("MetaData:getSyncAction should not be called");//传递非法参数异常
     }
-
 }