javax.json.JsonReaderFactory Maven / Gradle / Ivy
Show all versions of jboss-json-api_1.0_spec Show documentation
package javax.json;
import java.io.InputStream;
import java.io.Reader;
import java.nio.charset.Charset;
import java.util.Map;
/**
* Factory to create {@link javax.json.JsonReader} instances. If a factory
* instance is configured with some configuration, that would be
* used to configure the created reader instances.
*
*
* {@link javax.json.JsonReader} can also be created using {@link Json}'s
* {@code createReader} methods. If multiple reader instances are created,
* then creating them using a reader factory is preferred.
*
*
* For example:
*
*
* JsonReaderFactory factory = Json.createReaderFactory(...);
* JsonReader reader1 = factory.createReader(...);
* JsonReader reader2 = factory.createReader(...);
*
*
*
* All the methods in this class are safe for use by multiple concurrent
* threads.
*
* @author Jitendra Kotamraju
*/
public interface JsonReaderFactory {
/**
* Creates a JSON reader from a character stream. The reader is configured
* with the factory configuration.
*
* @param reader a reader from which JSON is to be read
* @return a JSON reader
*/
JsonReader createReader(Reader reader);
/**
* Creates a JSON reader from a byte stream. The character encoding of
* the stream is determined as described in
* RFC 4627.
* The reader is configured with the factory configuration.
*
* @param in a byte stream from which JSON is to be read
* @return a JSON reader
*/
JsonReader createReader(InputStream in);
/**
* Creates a JSON reader from a byte stream. The bytes of the stream
* are decoded to characters using the specified charset. The reader is
* configured with the factory configuration.
*
* @param in a byte stream from which JSON is to be read
* @param charset a charset
* @return a JSON reader
*/
JsonReader createReader(InputStream in, Charset charset);
/**
* Returns read-only map of supported provider specific configuration
* properties that are used to configure the created JSON readers.
* 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 readers. The map be empty but not null.
*/
Map getConfigInUse();
}