org.json.stream

Class JSONObjectBuilder

java.lang.Object

org.json.stream.JSONObjectBuilder

public final class JSONObjectBuilder
extends java.lang.Object

Builds a JSON object model using events supplied from JSONStreamReader. This uses less stack space than parsing via JSONTokener, since only one stack frame is allocated per nested object or array.

A simple example of how to use this class:

 JSONObject jsonObject = JSONObjectBuilder.buildJSONObject(JSON_TEXT);
 

Method Summary

Modifier and Type	Method and Description
static JSONArray	buildArraySubTree(JSONStreamReader reader) If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.ARRAY, return the entire subtree as a JSONArray value.
static <AR> AR	buildArraySubTree(JSONStreamReader reader, StructureCollector<?,?,?,AR> collector) If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.ARRAY, return the entire subtree as an array type, as specified by the given collector.
static JSONArray	buildJSONArray(java.io.InputStream inputStream, java.nio.charset.Charset charset) Build a JSONArray from a InputStream and a supplied Charset.
static <AR> AR	buildJSONArray(java.io.InputStream inputStream, java.nio.charset.Charset charset, StructureCollector<?,?,?,AR> collector) Build a JSONArray from a InputStream and a supplied Charset.
static JSONArray	buildJSONArray(JSONStreamReader reader) Build a JSONArray from a JSONStreamReader.
static <AR> AR	buildJSONArray(JSONStreamReader reader, StructureCollector<?,?,?,AR> collector) Build a JSONArray from a JSONStreamReader.
static JSONArray	buildJSONArray(java.io.Reader reader) Build a JSONArray from a Reader.
static <AR> AR	buildJSONArray(java.io.Reader reader, StructureCollector<?,?,?,AR> collector) Build a JSONArray from a Reader.
static JSONArray	buildJSONArray(java.lang.String s) Build a JSONArray from a String.
static <AR> AR	buildJSONArray(java.lang.String s, StructureCollector<?,?,?,AR> collector) Build a JSONArray from a String.
static JSONObject	buildJSONObject(java.io.InputStream inputStream, java.nio.charset.Charset charset) Build a JSONObject from a InputStream and a supplied Charset.
static <OR> OR	buildJSONObject(java.io.InputStream inputStream, java.nio.charset.Charset charset, StructureCollector<?,?,OR,?> collector) Build a JSONObject from a InputStream and a supplied Charset.
static JSONObject	buildJSONObject(JSONStreamReader reader) Build a JSONObject from a JSONStreamReader.
static <OR> OR	buildJSONObject(JSONStreamReader reader, StructureCollector<?,?,OR,?> collector) Build a JSONObject from a JSONStreamReader.
static JSONObject	buildJSONObject(java.io.Reader reader) Build a JSONObject from a Reader.
static <OR> OR	buildJSONObject(java.io.Reader reader, StructureCollector<?,?,OR,?> collector) Build a JSONObject from a Reader.
static JSONObject	buildJSONObject(java.lang.String s) Build a JSONObject from a String.
static <OR> OR	buildJSONObject(java.lang.String s, StructureCollector<?,?,OR,?> collector) Build a JSONObject from a String.
static java.lang.Object	buildJSONValue(java.io.InputStream inputStream, java.nio.charset.Charset charset) Build a JSON value from a InputStream and supplied Charset.
static java.lang.Object	buildJSONValue(java.io.InputStream inputStream, java.nio.charset.Charset charset, StructureCollector<?,?,?,?> collector) Build a JSON value from a InputStream and supplied Charset.
static java.lang.Object	buildJSONValue(JSONStreamReader reader) Build a JSON value from a JSONStreamReader.
static java.lang.Object	buildJSONValue(JSONStreamReader reader, StructureCollector<?,?,?,?> collector) Build a JSON value from a JSONStreamReader.
static java.lang.Object	buildJSONValue(java.io.Reader reader) Build a JSON value from a Reader.
static java.lang.Object	buildJSONValue(java.io.Reader reader, StructureCollector<?,?,?,?> collector) Build a JSON value from a Reader.
static java.lang.Object	buildJSONValue(java.lang.String s) Build a JSON value from a String.
static java.lang.Object	buildJSONValue(java.lang.String s, StructureCollector<?,?,?,?> collector) Build a JSON value from a String.
static JSONObject	buildObjectSubTree(JSONStreamReader reader) If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.OBJECT, return the entire subtree as a JSONObject value.
static <OR> OR	buildObjectSubTree(JSONStreamReader reader, StructureCollector<?,?,OR,?> collector) If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.OBJECT, return the entire subtree as an object type, as specified by the given collector.

Methods inherited from class java.lang.Object

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

Method Detail

buildJSONValue

public static java.lang.Object buildJSONValue(java.io.Reader reader)
                                       throws JSONException

Build a JSON value from a Reader. The value may be one of:

• JSONObject.NULL
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSONObject
• A JSONArray

Parameters:

reader - A reader.

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.io.Reader reader,
                                              StructureCollector<?,?,?,?> collector)
                                       throws JSONException

Build a JSON value from a Reader. The value may be one of:

• A null value, as defined by the collector
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSON object, as specified by the collector result type
• A JSON array, as specified by the collector result type

Parameters:

reader - A reader.

collector - A collector object for creating structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.io.InputStream inputStream,
                                              java.nio.charset.Charset charset)
                                       throws JSONException

Build a JSON value from a InputStream and supplied Charset. The value may be one of:

• JSONObject.NULL
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSONObject
• A JSONArray

Parameters:

inputStream - the input stream containing the JSON data

charset - the character set with which to interpret the input stream

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.io.InputStream inputStream,
                                              java.nio.charset.Charset charset,
                                              StructureCollector<?,?,?,?> collector)
                                       throws JSONException

Build a JSON value from a InputStream and supplied Charset. The value may be one of:

• A null value, as defined by the collector
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSON object, as specified by the collector result type
• A JSON array, as specified by the collector result type

Parameters:

inputStream - the input stream containing the JSON data

charset - the character set with which to interpret the input stream

collector - A collector object for creating structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.lang.String s)
                                       throws JSONException

Build a JSON value from a String. The value may be one of:

• JSONObject.NULL
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSONObject
• A JSONArray

Parameters:

s - A source string.

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.lang.String s,
                                              StructureCollector<?,?,?,?> collector)
                                       throws JSONException

Build a JSON value from a String. The value may be one of:

• A null value, as defined by the collector
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSON object, as specified by the collector result type
• A JSON array, as specified by the collector result type

Parameters:

s - A source string.

collector - A collector object for creating structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(JSONStreamReader reader)
                                       throws JSONException

Build a JSON value from a JSONStreamReader. The value may be one of:

• JSONObject.NULL
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSONObject
• A JSONArray

The reader must be at the beginning of the document.

Parameters:

reader - A source stream reader.

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(JSONStreamReader reader,
                                              StructureCollector<?,?,?,?> collector)
                                       throws JSONException

Build a JSON value from a JSONStreamReader. The value may be one of:

• A null value, as defined by the collector
• Boolean.TRUE or Boolean.FALSE
• A Double, Long, Integer, BigDecimal, or BigInteger
• A String
• A JSON object, as specified by the collector result type
• A JSON array, as specified by the collector result type

The reader must be at the beginning of the document.

Parameters:

reader - A source stream reader.

collector - A collector object for creating structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONObject

public static JSONObject buildJSONObject(java.io.Reader reader)
                                  throws JSONException

Build a JSONObject from a Reader.

Parameters:

reader - A reader.

Returns:

a JSONObject value

Throws:

JSONException

buildJSONObject

public static <OR> OR buildJSONObject(java.io.Reader reader,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

Build a JSONObject from a Reader.

Type Parameters:

OR - The resulting JSON object type

Parameters:

reader - A reader.

collector - A collector object for creating structures

Returns:

the parsed JSON object value

Throws:

JSONException

buildJSONObject

public static JSONObject buildJSONObject(java.io.InputStream inputStream,
                                         java.nio.charset.Charset charset)
                                  throws JSONException

Build a JSONObject from a InputStream and a supplied Charset.

Parameters:

inputStream - the input stream containing the JSON data

charset - the character set with which to interpret the input stream

Returns:

a JSONObject value

Throws:

JSONException

buildJSONObject

public static <OR> OR buildJSONObject(java.io.InputStream inputStream,
                                      java.nio.charset.Charset charset,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

Build a JSONObject from a InputStream and a supplied Charset.

Type Parameters:

OR - The resulting JSON object type

Parameters:

inputStream - the input stream containing the JSON data

charset - the character set with which to interpret the input stream

collector - A collector object for creating structures

Returns:

the parsed JSON object value

Throws:

JSONException

buildJSONObject

public static JSONObject buildJSONObject(java.lang.String s)
                                  throws JSONException

Build a JSONObject from a String.

Parameters:

s - A source string.

Returns:

a JSONObject value

Throws:

JSONException

buildJSONObject

public static <OR> OR buildJSONObject(java.lang.String s,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

Build a JSONObject from a String.

Type Parameters:

OR - The resulting JSON object type

Parameters:

s - A source string.

collector - A collector object for creating structures

Returns:

the parsed JSON object value

Throws:

JSONException

buildJSONObject

public static JSONObject buildJSONObject(JSONStreamReader reader)
                                  throws JSONException

Build a JSONObject from a JSONStreamReader. The reader must be at the beginning of the document.

Parameters:

reader - A source stream reader.

Returns:

a JSONObject value

Throws:

JSONException

buildJSONObject

public static <OR> OR buildJSONObject(JSONStreamReader reader,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

Build a JSONObject from a JSONStreamReader. The reader must be at the beginning of the document.

Type Parameters:

OR - The resulting JSON object type

Parameters:

reader - A source stream reader.

collector - A collector object for creating structures

Returns:

the parsed JSON object value

Throws:

JSONException

buildJSONArray

public static <AR> AR buildJSONArray(java.io.Reader reader,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

Build a JSONArray from a Reader.

Type Parameters:

AR - The resulting JSON array type

Parameters:

reader - A reader.

collector - A collector object for creating structures

Returns:

the parsed JSON array value

Throws:

JSONException

buildJSONArray

public static JSONArray buildJSONArray(java.io.Reader reader)
                                throws JSONException

Build a JSONArray from a Reader.

Parameters:

reader - A reader.

Returns:

a JSONArray value

Throws:

JSONException

buildJSONArray

public static JSONArray buildJSONArray(java.io.InputStream inputStream,
                                       java.nio.charset.Charset charset)
                                throws JSONException

Build a JSONArray from a InputStream and a supplied Charset.

Parameters:

inputStream - the input stream containing the JSON data

charset - the character set with which to interpret the input stream

Returns:

a JSONArray value

Throws:

JSONException

buildJSONArray

public static <AR> AR buildJSONArray(java.io.InputStream inputStream,
                                     java.nio.charset.Charset charset,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

Build a JSONArray from a InputStream and a supplied Charset.

Type Parameters:

AR - The resulting JSON array type

Parameters:

inputStream - the input stream containing the JSON data

charset - the character set with which to interpret the input stream

collector - A collector object for creating structures

Returns:

the parsed JSON array value

Throws:

JSONException

buildJSONArray

public static JSONArray buildJSONArray(java.lang.String s)
                                throws JSONException

Build a JSONArray from a String.

Parameters:

s - A source string.

Returns:

a JSONArray value

Throws:

JSONException

buildJSONArray

public static <AR> AR buildJSONArray(java.lang.String s,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

Build a JSONArray from a String.

Type Parameters:

AR - The resulting JSON array type

Parameters:

s - A source string.

collector - A collector object for creating structures

Returns:

the parsed JSON array value

Throws:

JSONException

buildJSONArray

public static JSONArray buildJSONArray(JSONStreamReader reader)
                                throws JSONException

Build a JSONArray from a JSONStreamReader. The reader must be at the beginning of the document.

Parameters:

reader - A source stream.

Returns:

a JSONArray value

Throws:

JSONException

buildJSONArray

public static <AR> AR buildJSONArray(JSONStreamReader reader,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

Build a JSONArray from a JSONStreamReader. The reader must be at the beginning of the document.

Type Parameters:

AR - The resulting JSON array type

Parameters:

reader - A source stream.

collector - A collector object for creating structures

Returns:

the parsed JSON array value

Throws:

JSONException

buildObjectSubTree

public static JSONObject buildObjectSubTree(JSONStreamReader reader)
                                     throws JSONException

If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.OBJECT, return the entire subtree as a JSONObject value. This method advances the parser onto the JSONStreamReader.ParseState.END_OBJECT state.

If the JSON stream is not parseable as an object, a JSONException will be thrown.

Parameters:

reader - A source stream reader.

Returns:

a JSONObject representing the subtree starting at the current OBJECT state

Throws:

JSONException

buildObjectSubTree

public static <OR> OR buildObjectSubTree(JSONStreamReader reader,
                                         StructureCollector<?,?,OR,?> collector)
                                  throws JSONException

If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.OBJECT, return the entire subtree as an object type, as specified by the given collector. This method advances the parser onto the JSONStreamReader.ParseState.END_OBJECT state.

If the JSON stream is not parseable as an object, a JSONException will be thrown.

Type Parameters:

OR - The resulting JSON object type

Parameters:

reader - A source stream reader.

collector - A collector object for creating structures

Returns:

a JSON object representing the subtree starting at the current OBJECT state

Throws:

JSONException

buildArraySubTree

public static JSONArray buildArraySubTree(JSONStreamReader reader)
                                   throws JSONException

If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.ARRAY, return the entire subtree as a JSONArray value. This method advances the parser onto the JSONStreamReader.ParseState.END_ARRAY state.

If the JSON stream is not parseable as an array, a JSONException will be thrown.

Parameters:

reader - A source stream reader.

Returns:

a JSONArray representing the subtree starting at the current ARRAY state

Throws:

JSONException

buildArraySubTree

public static <AR> AR buildArraySubTree(JSONStreamReader reader,
                                        StructureCollector<?,?,?,AR> collector)
                                 throws JSONException

If the given JSONStreamReader's ParseState was JSONStreamReader.ParseState.ARRAY, return the entire subtree as an array type, as specified by the given collector. This method advances the parser onto the JSONStreamReader.ParseState.END_ARRAY state.

If the JSON stream is not parseable as an array, a JSONException will be thrown.

Type Parameters:

AR - The resulting JSON array type

Parameters:

reader - A source stream reader.

collector - A collector object for creating structures

Returns:

the JSON array representing the subtree starting at the current ARRAY state

Throws:

JSONException