add comments.

Author: webee

README.md

@@ -15,6 +15,6 @@ To install the library add:
         maven { url "https://jitpack.io" }
    }
    dependencies {
-         compile 'com.github.webee:java-json-api:v1.0.0'
+         compile 'com.github.webee:java-json-api:v1.1.0'
    }
    ```

src/main/java/com/github/webee/json/JSONArray.java

@@ -8,6 +8,7 @@ public interface JSONArray {
     JSONType getType(int index);
 
     boolean isNull(int index);
+    // get the pure java object that correspond to it's type.
     Object get(int index);
     Boolean getBoolean(int index);
     Integer getInteger(int index);

src/main/java/com/github/webee/json/JSONObject.java

@@ -11,6 +11,7 @@ public interface JSONObject {
     JSONType getType(String key);
 
     boolean isNull(String key);
+    // get the pure java object that correspond to it's type.
     Object get(String key);
     Boolean getBoolean(String key);
     Integer getInteger(String key);

src/main/java/com/github/webee/json/JSONType.java

@@ -4,10 +4,10 @@
  * Created by webee on 16/11/25.
  */
 public enum JSONType {
-    Null,
-    Boolean,
-    Number,
-    String,
-    Object,
-    Array,
+    Null,    // -> null
+    Boolean, // -> Boolean
+    Number,  // -> Number
+    String,  // -> String
+    Object,  // -> Map<String, Object>
+    Array,   // -> Object[]
 }

src/main/java/com/github/webee/json/Utils.java

@@ -7,6 +7,11 @@
  * Created by webee on 16/11/25.
  */
 public final class Utils {
+    /**
+     * judge value's json type.
+     * @param value the value to judge.
+     * @return the json type.
+     */
     public static JSONType getType(Object value) {
         if (value == null) {
             return JSONType.Null;
@@ -22,10 +27,19 @@ public static JSONType getType(Object value) {
             return JSONType.Object;
         } else if (value instanceof Object[]) {
             return JSONType.Array;
+        } else if (value instanceof JSONObject) {
+            return JSONType.Object;
+        } else if (value instanceof JSONArray) {
+            return JSONType.Array;
         }
         return null;
     }
 
+    /**
+     * convert JSONArray to a Object[] array mixed tree with pure java objects.
+     * @param array the JSONArray to convert.
+     * @return the pure java objects array mixed tree.
+     */
     public static Object[] arrayToObjects(JSONArray array) {
         if (array == null) {
             return null;
@@ -38,6 +52,11 @@ public static Object[] arrayToObjects(JSONArray array) {
         return res;
     }
 
+    /**
+     * convert JSONObject to a Map<String, Object> tree with pure java objects.
+     * @param object the JSONObject to convert.
+     * @return the pure java objects tree .
+     */
     public static Map<String, Object> objectToMap(JSONObject object) {
         if (object == null) {
             return null;
@@ -50,6 +69,11 @@ public static Map<String, Object> objectToMap(JSONObject object) {
         return res;
     }
 
+    /**
+     * convert value to pure java objects.
+     * @param value the value to convert.
+     * @return pure java object.
+     */
     public static Object resolveValue(Object value) {
         if (value instanceof JSONArray) {
             return Utils.arrayToObjects((JSONArray) value);