-
public interface JsonGeneratorFactory
Factory to createJsonGenerator
instances. If a factory instance is configured with some configuration, the configuration applies to all generator instances created using that factory instance.The class
Json
also provides methods to createJsonGenerator
instances, but usingJsonGeneratorFactory
is preferred when creating multiple generator instances as shown in the following example:JsonGeneratorFactory factory = Json.createGeneratorFactory(); JsonGenerator generator1 = factory.createGenerator(...); JsonGenerator generator2 = factory.createGenerator(...);
All the methods in this class are safe for use by multiple concurrent threads.
- Author:
- Jitendra Kotamraju
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description JsonGenerator
createGenerator(OutputStream out)
Creates a JSON generator to write JSON text to a byte stream.JsonGenerator
createGenerator(OutputStream out, Charset charset)
Creates a JSON generator to write JSON text to a byte stream.JsonGenerator
createGenerator(Writer writer)
Creates a JSON generator to write JSON text to a character stream.Map<String,?>
getConfigInUse()
Returns a read-only map of supported provider specific configuration properties that are used to configure the JSON generators.
-
-
-
Method Detail
-
createGenerator
JsonGenerator createGenerator(Writer writer)
Creates a JSON generator to write JSON text to a character stream. The generator is configured with the factory configuration.- Parameters:
writer
- i/o writer to which JSON is written
-
createGenerator
JsonGenerator createGenerator(OutputStream out)
Creates a JSON generator to write JSON text to a byte stream. Characters written to the stream are encoded into bytes using UTF-8 encoding. The generator is configured with the factory's configuration.- Parameters:
out
- i/o stream to which JSON is written
-
createGenerator
JsonGenerator createGenerator(OutputStream out, Charset charset)
Creates a JSON generator to write JSON text to a byte stream. Characters written to the stream are encoded into bytes using the specified charset. The generator is configured with the factory's configuration.- Parameters:
out
- i/o stream to which JSON is writtencharset
- a charset
-
getConfigInUse
Map<String,?> getConfigInUse()
Returns a read-only map of supported provider specific configuration properties that are used to configure the JSON generators. If there are any specified configuration properties that are not supported by the provider, they won't be part of the returned map.- Returns:
- a map of supported provider specific properties that are used to configure the created generators. The map may be empty but not null
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/json/stream/jsongeneratorfactory.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.