Add toJsonPretty() convenience method

Author: rbygrave

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

@@ -27,6 +27,9 @@ void toJson()  {
     var view = type.view("(two, four)");
     String viewJson = view.toJson(b);
     assertThat(viewJson).isEqualTo("{\"two\":43,\"four\":\"fourValue\"}");
+
+    String viewJsonPretty = view.toJsonPretty(b).replace("\" : ", "\": ");
+    assertThat(viewJsonPretty).isEqualTo("{\n  \"two\": 43,\n  \"four\": \"fourValue\"\n}");
   }
 
   @Test

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

@@ -15,6 +15,20 @@ class CustomerTest {
 
   Jsonb jsonb = Jsonb.newBuilder().build();
 
+  @Test
+  void anyToJson() {
+    var customer = new Customer().id(42L).name("rob").status(Customer.Status.ACTIVE);
+    String asJson = jsonb.toJson(customer);
+    assertThat(asJson).isEqualTo("{\"id\":42,\"name\":\"rob\",\"status\":\"ACTIVE\"}");
+  }
+
+  @Test
+  void anyToJsonPretty() {
+    var customer = new Customer().id(42L).name("rob").status(Customer.Status.ACTIVE);
+    String asJson = jsonb.toJsonPretty(customer).replace("\" : ", "\": ");
+    assertThat(asJson).isEqualTo("{\n  \"id\": 42,\n  \"name\": \"rob\",\n  \"status\": \"ACTIVE\"\n}");
+  }
+
   @Test
   void toJson_view() {
     JsonView<Customer> customerJsonView = jsonb.type(Customer.class).view("(id, name)");

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

@@ -34,6 +34,11 @@ public interface JsonView<T> {
    */
   String toJson(T value);
 
+  /**
+   * Return as json string in pretty format.
+   */
+  String toJsonPretty(T value);
+
   /**
    * Return the value as json content in bytes form.
    */

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

@@ -86,9 +86,44 @@ static Builder newBuilder() {
     return DefaultBootstrap.newBuilder();
   }
 
+  /**
+   * Return JSON content for the given object.
+   * <p>
+   * This is a convenience method for using {@code jsonb.type(Object.class).toJson(any) }
+   *
+   * @param any The object to return as JSON string
+   * @return Return JSON content for the given object.
+   */
+  String toJson(Object any);
+
+  /**
+   * Return JSON content in pretty format for the given object.
+   * <p>
+   * This is a convenience method for using {@code jsonb.type(Object.class).toJsonPretty(any) }
+   *
+   * @param any The object to return as JSON string in pretty format
+   * @return Return JSON content in pretty format for the given object.
+   */
+  String toJsonPretty(Object any);
+
   /**
    * Return the JsonType used to read and write json for the given class.
    *
+   * <h3>Examples</h3>
+   * <pre>{@code
+   *
+   *   JsonType<Customer> customerType = jsonb.type(Customer.class)
+   *
+   *   Customer customer = ...
+   *   customerType.toJson(customer);
+   *
+   *   JsonType<List<Customer>> customerListType = customerType.list()
+   *
+   *   List<Customer> customers = ...
+   *   customerListType.toJson(customers);
+   *
+   * }</pre>
+   *
    * <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
@@ -105,6 +140,19 @@ static Builder newBuilder() {
 
   /**
    * Return the JsonType used to read and write json for the given type.
+   * <p>
+   * We can use {@link Types} to obtain common generic types for List, Set, Map, Array etc.
+   *
+   * <h3>Example</h3>
+   * <pre>{@code
+   *
+   *   JsonType<List<String>> listOfStringType = jsonb.type(Types.listOf(String.class))
+   *
+   *   JsonType<List<Customer>> listOfCustomerType = jsonb.type(Types.listOf(Customer.class))
+   *
+   *   JsonType<Map<String,Integer>> adapter = jsonb.type(Types.mapOf(Integer.class))
+   *
+   * }</pre>
    *
    * <h3>Using Object.class</h3>
    * <p>
@@ -121,7 +169,7 @@ static Builder newBuilder() {
   <T> JsonType<T> type(Type type);
 
   /**
-   * Return the JsonType for the given value using the values class.
+   * Return the JsonType for the given value using the class of the value being passed in.
    * <p>
    * This is a helper method that supports returning an inferred generic type.
    *

jsonb/src/main/java/io/avaje/jsonb/core/DJsonType.java

@@ -53,6 +53,15 @@ public String toJson(T value) {
     }
   }
 
+  @Override
+  public String toJsonPretty(T value) {
+    try (BufferedJsonWriter writer = jsonb.bufferedWriter()) {
+      writer.pretty(true);
+      toJson(value, writer);
+      return writer.result();
+    }
+  }
+
   @Override
   public byte[] toJsonBytes(T value) {
     try (BytesJsonWriter writer = jsonb.bufferedWriterAsBytes()) {

jsonb/src/main/java/io/avaje/jsonb/core/DJsonb.java

@@ -24,6 +24,7 @@ class DJsonb implements Jsonb {
   private final JsonStreamAdapter io;
   private final Map<Type, DJsonType<?>> typeCache = new ConcurrentHashMap<>();
   private final ConcurrentHashMap<ViewKey,JsonView<?>> viewCache = new ConcurrentHashMap<>();
+  private final JsonType<Object> anyType;
 
   DJsonb(JsonStreamAdapter adapter, List<JsonAdapter.Factory> factories, boolean serializeNulls, boolean serializeEmpty, boolean failOnUnknown, boolean mathAsString) {
     this.builder = new CoreAdapterBuilder(this, factories, mathAsString);
@@ -37,6 +38,17 @@ class DJsonb implements Jsonb {
         this.io = new JsonStream(serializeNulls, serializeEmpty, failOnUnknown);
       }
     }
+    this.anyType = type(Object.class);
+  }
+
+  @Override
+  public String toJson(Object any) {
+    return anyType.toJson(any);
+  }
+
+  @Override
+  public String toJsonPretty(Object any) {
+    return anyType.toJsonPretty(any);
   }
 
   @Override

jsonb/src/main/java/io/avaje/jsonb/core/ViewBuilder.java

@@ -201,6 +201,15 @@ public String toJson(T value) {
       }
     }
 
+    @Override
+    public String toJsonPretty(T value) {
+      try (BufferedJsonWriter writer = jsonb.bufferedWriter()) {
+        writer.pretty(true);
+        toJson(value, writer);
+        return writer.result();
+      }
+    }
+
     @Override
     public byte[] toJsonBytes(T value) {
       try (BytesJsonWriter writer = jsonb.bufferedWriterAsBytes()) {