-
- All Superinterfaces:
- AutoCloseable, Closeable
public interface JsonWriter extends Closeable
Writes a JSONobject
orarray
structure to an output source.The class
Json
contains methods to create writers from output sources (OutputStream
andWriter
).The following example demonstrates how write an empty JSON object:
JsonWriter jsonWriter = Json.createWriter(...); jsonWriter.writeObject(Json.createObjectBuilder().build()); jsonWriter.close();
The class
JsonWriterFactory
also contains methods to createJsonWriter
instances. A factory instance can be used to create multiple writer instances with the same configuration. This the preferred way to create multiple instances. A sample usage is shown in the following example:JsonWriterFactory factory = Json.createWriterFactory(config); JsonWriter writer1 = factory.createWriter(...); JsonWriter writer2 = factory.createWriter(...);
- Author:
- Jitendra Kotamraju
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
close()
Closes this JSON writer and frees any resources associated with the writer.void
write(JsonStructure value)
void
writeArray(JsonArray array)
Writes the specified JSONarray
to the output source.void
writeObject(JsonObject object)
Writes the specified JSONobject
to the output source.
-
-
-
Method Detail
-
writeArray
void writeArray(JsonArray array)
Writes the specified JSONarray
to the output source. This method needs to be called only once for a writer instance.- Parameters:
array
- JSON array that is to be written to the output source- Throws:
JsonException
- if the specified JSON object cannot be written due to i/o error (IOException would be cause of JsonException)IllegalStateException
- if writeArray, writeObject, write or close method is already called
-
writeObject
void writeObject(JsonObject object)
Writes the specified JSONobject
to the output source. This method needs to be called only once for a writer instance.- Parameters:
object
- JSON object that is to be written to the output source- Throws:
JsonException
- if the specified JSON object cannot be written due to i/o error (IOException would be cause of JsonException)IllegalStateException
- if writeArray, writeObject, write or close method is already called
-
write
void write(JsonStructure value)
Writes the specified JSONobject
orarray
to the output source. This method needs to be called only once for a writer instance.- Parameters:
value
- JSON array or object that is to be written to the output source- Throws:
JsonException
- if the specified JSON object cannot be written due to i/o error (IOException would be cause of JsonException)IllegalStateException
- if writeArray, writeObject, write or close method is already called
-
close
void close()
Closes this JSON writer and frees any resources associated with the writer. This method closes the underlying output source.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
JsonException
- if an i/o error occurs (IOException would be cause of JsonException)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 17:18:37 Cette version de la page est en cache (à la date du 21/08/2025 17:18:37) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/json/JsonWriter.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.