commit 28088169f208de53bdb2032cc43bca13e615fdb5
author Jorge Bescos Gascon <jorge.bescos.gascon@oracle.com> Mon Oct 04 12:31:49 2021 +0200
committer Lukas Jungmann <lukas.jungmann@oracle.com> Wed Oct 13 20:28:19 2021 +0200
tree bbad6d346b73b3271095c510a4520ff33f664311
parent a80b0be17503d554e877f2f90be1d207c5fa961f

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

Signed-off-by: Jorge Bescos Gascon <jorge.bescos.gascon@oracle.com>

api/src/main/java/jakarta/json/stream/JsonGenerator.java

diff --git a/api/src/main/java/jakarta/json/stream/JsonGenerator.java b/api/src/main/java/jakarta/json/stream/JsonGenerator.java
index 7389b7f..f253ee2 100644
--- a/api/src/main/java/jakarta/json/stream/JsonGenerator.java
+++ b/api/src/main/java/jakarta/json/stream/JsonGenerator.java
@@ -518,6 +518,10 @@
      * 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