javax.json

Class Json

java.lang.Object

javax.json.Json

public class Json
extends Object

Factory to create JsonParser, JsonGenerator, JsonParserFactory and JsonGeneratorFactory instances. This lists only commonly used methods to create JsonParser and JsonGenerator objects, the corresponding factories have all the methods to create these objects.

All the methods would locate a provider instance, which is returned by the provider method, and is used to create JsonParser, JsonGenerator JsonParserFactory and JsonGeneratorFactory instances.

For example, a JSON parser for parsing an empty array could be created as follows:

 
 StringReader reader = new StringReader("[]");
 JsonParser parser = Json.createParser(reader);
 
 

All of the methods in this class are safe for use by multiple concurrent threads.

Author:

Jitendra Kotamraju

Method Summary

Methods

Modifier and Type	Method and Description
static JsonGenerator	createGenerator(OutputStream out) Creates a JSON generator which can be used to write JSON text to the specified byte stream.
static JsonGenerator	createGenerator(Writer writer) Creates a JSON generator which can be used to write JSON text to the specified character stream.
static JsonGeneratorFactory	createGeneratorFactory() Creates a generator factory which can be used to create JsonGenerator.
static JsonGeneratorFactory	createGeneratorFactory(JsonConfiguration config) Creates a generator factory which can be used to create JsonGenerator.
static JsonParser	createParser(InputStream in) Creates a JSON parser from the specified byte stream.
static JsonParser	createParser(Reader reader) Creates a JSON parser from the specified character stream
static JsonParserFactory	createParserFactory() Creates a parser factory which can be used to create JsonParser.
static JsonParserFactory	createParserFactory(JsonConfiguration config) Creates a parser factory which can be used to create JsonParser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createParser

public static JsonParser createParser(Reader reader)

Creates a JSON parser from the specified character stream

Parameters:

reader - i/o reader from which JSON is to be read

createParser

public static JsonParser createParser(InputStream in)

Creates a JSON parser from the specified byte stream. The character encoding of the stream is determined as per the RFC.

Parameters:

in - i/o stream from which JSON is to be read

Throws:

JsonException - if encoding cannot be determined or i/o error (IOException would be cause of JsonException)

createGenerator

public static JsonGenerator createGenerator(Writer writer)

Creates a JSON generator which can be used to write JSON text to the specified character stream.

Parameters:

writer - a i/o writer to which JSON is written

createGenerator

public static JsonGenerator createGenerator(OutputStream out)

Creates a JSON generator which can be used to write JSON text to the specified byte stream.

Parameters:

out - i/o stream to which JSON is written

createParserFactory

public static JsonParserFactory createParserFactory()

Creates a parser factory which can be used to create JsonParser.

Returns:

JSON parser factory

createParserFactory

public static JsonParserFactory createParserFactory(JsonConfiguration config)

Creates a parser factory which can be used to create JsonParser. The created parser factory is configured with the specified configuration

Parameters:

config - configuration of the parser factory

Returns:

JSON parser factory

Throws:

IllegalArgumentException - if a feature in the configuration is not known

createGeneratorFactory

public static JsonGeneratorFactory createGeneratorFactory()

Creates a generator factory which can be used to create JsonGenerator.

Returns:

JSON generator factory

createGeneratorFactory

public static JsonGeneratorFactory createGeneratorFactory(JsonConfiguration config)

Creates a generator factory which can be used to create JsonGenerator. The created generator factory is configured with the specified configuration.

Parameters:

config - configuration of the generator factory

Returns:

JSON generator factory

Throws:

IllegalArgumentException - if a feature in the configuration is not known