jakarta.json.stream.JsonGeneratorFactory Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.json.stream;
import java.io.OutputStream;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.Map;
/**
* Factory to create {@link JsonGenerator} instances. If a factory
* instance is configured with some configuration, the configuration applies
* to all generator instances created using that factory instance.
*
*
* The class {@link jakarta.json.Json Json} also provides methods to create
* {@link JsonGenerator} instances, but using {@code JsonGeneratorFactory} 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.
*/
public interface JsonGeneratorFactory {
/**
* Creates a JSON generator to write JSON text to a character stream.
* The generator is configured with the factory configuration.
*
* @param writer i/o writer to which JSON is written
* @return the created JSON generator
*/
JsonGenerator createGenerator(Writer writer);
/**
* 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.
*
* @param out i/o stream to which JSON is written
* @return the created JSON generator
*/
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 the specified charset.
* The generator is configured with the factory's configuration.
*
* @param out i/o stream to which JSON is written
* @param charset a charset
* @return the created JSON generator
*/
JsonGenerator createGenerator(OutputStream out, Charset charset);
/**
* 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.
*
* @return a map of supported provider specific properties that are used
* to configure the created generators. The map may be empty but not null
*/
Map getConfigInUse();
}