Package javax.json.stream
Interface JsonGeneratorFactory
-
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.
This is a near-exact copy of the same-titled Java EE 8 Class:javax.json.stream.JsonGeneratorFactory
Commenting has been slightly modified to accompany HiLited Code Examples.
Java Source Code remains identical to the Sun-Oracle & 'GlassFish' Released Distributions.
Read included License:HERE
, and theCDDL+GPL-1.1
Alljavax.json.stream.*
Code Obtained From:GitHub JavaEE jsonp
Public Archive.
The classJson
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.
Hi-Lited Source-Code:This File's Source Code:
- View Here: javax/json/stream/JsonGeneratorFactory.java
- Open New Browser-Tab: javax/json/stream/JsonGeneratorFactory.java
File Size: 4,723 Bytes Line Count: 113 '\n' Characters Found
Glass Fish Implementation Class:
- View Here: org/glassfish/json/JsonGeneratorFactoryImpl.java
- Open New Browser-Tab: org/glassfish/json/JsonGeneratorFactoryImpl.java
File Size: 3,526 Bytes Line Count: 94 '\n' Characters Found
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JsonGenerator
createGenerator(OutputStream out)
Creates a JSON generator to write JSON text to a byte stream.JsonGenerator
createGenerator(OutputStream out, java.nio.charset.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(java.io.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- Returns:
- the created JSON generator
-
createGenerator
JsonGenerator createGenerator(java.io.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- Returns:
- the created JSON generator
-
createGenerator
JsonGenerator createGenerator(java.io.OutputStream out, java.nio.charset.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- Returns:
- the created JSON generator
-
getConfigInUse
java.util.Map<java.lang.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
-
-