#11 - Add convenience methods to Jsonb for toJson ... bytes, writer, outputStream

Author: rbygrave

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

@@ -3,7 +3,10 @@
 import io.avaje.jsonb.*;
 import org.junit.jupiter.api.Test;
 
+import java.io.ByteArrayOutputStream;
+import java.io.OutputStreamWriter;
 import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.*;
 
@@ -29,6 +32,31 @@ void anyToJsonPretty() {
     assertThat(asJson).isEqualTo("{\n  \"id\": 42,\n  \"name\": \"rob\",\n  \"status\": \"ACTIVE\"\n}");
   }
 
+  @Test
+  void anyToWriter() {
+    var customer = new Customer().id(42L).name("rob").status(Customer.Status.ACTIVE);
+    StringWriter writer = new StringWriter();
+    jsonb.toJson(customer,  writer);
+    assertThat(writer.toString()).isEqualTo("{\"id\":42,\"name\":\"rob\",\"status\":\"ACTIVE\"}");
+  }
+
+  @Test
+  void anyToOutputStream() {
+    var customer = new Customer().id(42L).name("rob").status(Customer.Status.ACTIVE);
+    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+    jsonb.toJson(customer,  baos);
+    String asString = baos.toString(StandardCharsets.UTF_8);
+    assertThat(asString).isEqualTo("{\"id\":42,\"name\":\"rob\",\"status\":\"ACTIVE\"}");
+  }
+
+  @Test
+  void anyToBytes() {
+    var customer = new Customer().id(42L).name("rob").status(Customer.Status.ACTIVE);
+    byte[] bytes = jsonb.toJsonBytes(customer);
+    String asString = new String(bytes, StandardCharsets.UTF_8);
+    assertThat(asString).isEqualTo("{\"id\":42,\"name\":\"rob\",\"status\":\"ACTIVE\"}");
+  }
+
   @Test
   void toJson_view() {
     JsonView<Customer> customerJsonView = jsonb.type(Customer.class).view("(id, name)");

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

@@ -89,7 +89,7 @@ static Builder newBuilder() {
   /**
    * Return json content for the given object.
    * <p>
-   * This is a convenience method for using {@code jsonb.type(Object.class).toJson(any) }
+   * This is a convenience method for {@code jsonb.type(Object.class).toJson(any) }
    *
    * @param any The object to return as json string
    * @return Return json content for the given object.
@@ -99,28 +99,61 @@ static Builder newBuilder() {
   /**
    * 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) }
+   * This is a convenience method for {@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 value as json content in bytes form.
+   * <p>
+   * This is a convenience method for {@code jsonb.type(Object.class).toJsonBytes(any) }
+   */
+  byte[] toJsonBytes(Object any);
+
+  /**
+   * Write to the given writer.
+   * <p>
+   * This is a convenience method for {@code jsonb.type(Object.class).toJson(any, writer) }
+   */
+  void toJson(Object any, Writer writer);
+
+  /**
+   * Write to the given outputStream.
+   * <p>
+   * This is a convenience method for {@code jsonb.type(Object.class).toJsonBytes(any, outputStream) }
+   */
+  void toJson(Object any, OutputStream outputStream);
+
   /**
    * Return the JsonType used to read and write json for the given class.
    *
-   * <h3>Examples</h3>
+   * <h3>fromJson() example</h3>
    * <pre>{@code
    *
-   *   JsonType<Customer> customerType = jsonb.type(Customer.class)
+   *   Customer customer = jsonb
+   *     .type(Customer.class)
+   *     .fromJson(jsonContent);
    *
-   *   Customer customer = ...
-   *   customerType.toJson(customer);
    *
-   *   JsonType<List<Customer>> customerListType = customerType.list()
+   *   // list
+   *   List<Customer> customers = jsonb
+   *     .type(Customer.class)
+   *     .list()
+   *     .fromJson(jsonContent);
+   *
+   * }</pre>
+   *
+   * <h3>toJson() example</h3>
+   * <pre>{@code
+   *
+   *   Customer customer = ...
    *
-   *   List<Customer> customers = ...
-   *   customerListType.toJson(customers);
+   *   String jsonContent = jsonb
+   *     .type(Customer.class)
+   *     .toJson(customer);
    *
    * }</pre>
    *
@@ -129,6 +162,21 @@ static Builder newBuilder() {
    * 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>
+   *
+   * <h3>Object toJson()</h3>
+   * <pre>{@code
+   *
+   *   Object any = ...
+   *
+   *   String jsonContent = jsonb
+   *     .type(Object.class)
+   *     .toJson(any);
+   *
+   *   // the same as
+   *   String jsonContent = jsonb.toJson(any);
+   *
+   * }</pre>
+   * <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>
@@ -158,6 +206,20 @@ static Builder newBuilder() {
    * <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.
+   *
+   * <h3>Object toJson()</h3>
+   * <pre>{@code
+   *
+   *   Object any = ...
+   *
+   *   String jsonContent = jsonb
+   *     .type(Object.class)
+   *     .toJson(any);
+   *
+   *   // the same as
+   *   String jsonContent = jsonb.toJson(any);
+   *
+   * }</pre>
    * <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.

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

@@ -51,6 +51,21 @@ public String toJsonPretty(Object any) {
     return anyType.toJsonPretty(any);
   }
 
+  @Override
+  public byte[] toJsonBytes(Object any) {
+    return anyType.toJsonBytes(any);
+  }
+
+  @Override
+  public void toJson(Object any, Writer writer) {
+    anyType.toJson(any, writer);
+  }
+
+  @Override
+  public void toJson(Object any, OutputStream outputStream) {
+    anyType.toJson(any, outputStream);
+  }
+
   @Override
   public PropertyNames properties(String... names) {
     return io.properties(names);