What is the contract for of JsonGenerator#close() on error? jakartaee…

…#156 Signed-off-by: Jorge Bescos Gascon <jorge.bescos.gascon@oracle.com>
jbescos · Oct 4, 2021 · d9445cb · d9445cb
1 parent d166d5d
commit d9445cb
Showing 1 changed file with 4 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
@@ -518,6 +518,10 @@ public interface JsonGenerator extends Flushable, /*Auto*/Closeable {
      * Closes this generator and frees any resources associated with it.
      * This method closes the underlying output source.
      *
+     * The underlying stream is closed only if complete JSON object is written. In case
+     * of incomplete object JsonGenerationException is thrown and underlying stream is
+     * not closed.
+     *
      * @throws jakarta.json.JsonException if an i/o error occurs (IOException
      * would be cause of JsonException)
      * @throws JsonGenerationException if an incomplete JSON is generated