Cleanup/json object api (#14)

* Added some missing JavaDocs * Added some missing JavaDocs put methods for JsonObject are more convenient now. Removed JsonObjectBuilder since it is no longer needed
iamdudeman · Apr 5, 2024 · 18ba672 · 18ba672
1 parent 06e1044
commit 18ba672
Show file tree

Hide file tree

Showing 9 changed files with 279 additions and 142 deletions.
diff --git a/TODO.md b/TODO.md
@@ -1,4 +1,3 @@
-* Javadoc more things
 * Consider adding performance testing
     * https://github.com/clarkware/junitperf
     * compare vs GSON

diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -3,7 +3,6 @@
  */
 module technology.sola.json {
   exports technology.sola.json;
-  exports technology.sola.json.builder;
   exports technology.sola.json.exception;
   exports technology.sola.json.mapper;
   exports technology.sola.json.parser;

diff --git a/src/main/java/technology/sola/json/JsonArray.java b/src/main/java/technology/sola/json/JsonArray.java
@@ -136,7 +136,7 @@ public void add(int index, JsonElement element) {
   }
 
   /**
-   * Appends the specified {@link JsonObject} to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified {@link JsonObject} to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the {@link JsonObject} to append
@@ -149,7 +149,7 @@ public JsonArray add(JsonObject value) {
   }
 
   /**
-   * Appends the specified {@link JsonArray} to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified {@link JsonArray} to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the {@link JsonArray} to append
@@ -162,7 +162,7 @@ public JsonArray add(JsonArray value) {
   }
 
   /**
-   * Appends the specified string to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified string to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the string to append
@@ -175,7 +175,7 @@ public JsonArray add(String value) {
   }
 
   /**
-   * Appends the specified integer to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified integer to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the integer to append
@@ -188,7 +188,7 @@ public JsonArray add(Integer value) {
   }
 
   /**
-   * Appends the specified long to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified long to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the long to append
@@ -201,7 +201,7 @@ public JsonArray add(Long value) {
   }
 
   /**
-   * Appends the specified float to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified float to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the float to append
@@ -214,7 +214,7 @@ public JsonArray add(Float value) {
   }
 
   /**
-   * Appends the specified double to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified double to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the double to append
@@ -227,7 +227,7 @@ public JsonArray add(Double value) {
   }
 
   /**
-   * Appends the specified boolean to the end of this {@link JsonArray}. If the specified value is null
+   * Appends the specified boolean to the end of this {@link JsonArray}. If the specified value is {@code null}
    * the {@link JsonElementType#NULL} will be appended.
    *
    * @param value the boolean to append