jakartaee#339 - Support x-json-stream, add JsonGenerator writeNewLine()

rbygrave · Dec 14, 2021 · da8ae6f · da8ae6f
1 parent 2da545b
commit da8ae6f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/api/src/main/java/jakarta/json/stream/JsonGenerator.java b/api/src/main/java/jakarta/json/stream/JsonGenerator.java
@@ -514,6 +514,16 @@ public interface JsonGenerator extends Flushable, /*Auto*/Closeable {
      */
     JsonGenerator writeNull();
 
+    /**
+     * Writes the new line character to the underlying content.
+     * This enables a generator to support {@code x-json-stream} new line delimited content.
+     *
+     * @return this generator
+     * @throws jakarta.json.JsonException if an i/o error occurs (IOException
+     * would be cause of JsonException)
+     */
+    JsonGenerator writeNewLine();
+
     /**
      * Closes this generator and frees any resources associated with it.
      * This method closes the underlying output source.