#1 - Improve javadoc on use of type(Object.class)

Author: rbygrave

blackbox-test/src/test/java/org/example/customer/CustomerTest.java

@@ -93,4 +93,19 @@ private Map<String, Object> contactMap(String fn, String ln) {
     contactMap.put("lastName", ln);
     return contactMap;
   }
+
+  @Test
+  void toJson_viaTypeObject()  {
+
+    Object customerAsObject = new Customer().id(42L).name("rob").status(Customer.Status.ACTIVE);
+
+    Jsonb jsonb = Jsonb.newBuilder().build();
+    String asJson = jsonb.type(Object.class).toJson(customerAsObject);
+    assertThat(asJson).isEqualTo("{\"id\":42,\"name\":\"rob\",\"status\":\"ACTIVE\"}");
+
+    Customer from1 = jsonb.type(Customer.class).fromJson(asJson);
+    assertThat(from1.id()).isEqualTo(42L);
+    assertThat(from1.name()).isEqualTo("rob");
+    assertThat(from1.status()).isEqualTo(Customer.Status.ACTIVE);
+  }
 }

blackbox-test/src/test/java/org/example/customer/IntegerTest.java

@@ -81,4 +81,15 @@ void array_viaTypes()  {
     Integer[] fromJson = (Integer[]) integerArrayJson.fromJson(asJson);
     assertThat(fromJson).containsExactly(41, 42);
   }
+
+  @Test
+  void toJson_viaTypeObject()  {
+
+    Set<Integer> integers = new LinkedHashSet<>();
+    integers.add(52);
+    integers.add(55);
+
+    String asJson = jsonb.type(Object.class).toJson(integers);
+    assertThat(asJson).isEqualTo("[52,55]");
+  }
 }

jsonb/src/main/java/io/avaje/jsonb/Jsonb.java

@@ -83,11 +83,35 @@ static Builder newBuilder() {
 
   /**
    * Return the JsonType used to read and write json for the given class.
+   *
+   * <h3>Using Object.class</h3>
+   * <p>
+   * We can use <code>type(Object.class)</code> when we don't know the specific type that is being
+   * written toJson or read fromJson.
+   * <p>
+   * When using <code>Object.class</code> and writing <code>toJson()</code> then the underlying JsonAdapter
+   * is determined dynamically based on the type of the object value passed in.
+   * <p>
+   * When using <code>Object.class</code> and reading <code>fromJson()</code> then the java types used in
+   * the result are determined dynamically based on the JSON types being read and the resulting java types
+   * are ArrayList, LinkedHashMap, String, boolean, and double.
    */
   <T> JsonType<T> type(Class<T> cls);
 
   /**
    * Return the JsonType used to read and write json for the given type.
+   *
+   * <h3>Using Object.class</h3>
+   * <p>
+   * We can use <code>type(Object.class)</code> when we don't know the specific type that is being
+   * written toJson or read fromJson.
+   * <p>
+   * When using <code>Object.class</code> and writing <code>toJson()</code> then the underlying JsonAdapter
+   * is determined dynamically based on the type of the object value passed in.
+   * <p>
+   * When using <code>Object.class</code> and reading <code>fromJson()</code> then the java types used in
+   * the result are determined dynamically based on the JSON types being read and the resulting java types
+   * are ArrayList, LinkedHashMap, String, boolean, and double.
    */
   <T> JsonType<T> type(Type type);