org.json.stream

Class JSONLimitBuilder

java.lang.Object

org.json.stream.JSONLimitBuilder

public final class JSONLimitBuilder
extends java.lang.Object

Builds a JSON object model using events supplied from JSONLimitStreamReader, using secure principles derived from XML parsers.

This class is similar in its external contract to the JSONObjectBuilder class, but intended to be more robust against untrusted JSON sources. For instance, by not using runtime stack for parsing nested JSON structures, it is less susceptible to stack smashing attempts.

For some practical limits for parsing JSON data, see BuilderLimits.secureDefaults().

Method Summary

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

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.io.Reader reader,
                                              BuilderLimits limits)
                                       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.

limits - the limits imposed on the builder

Returns:

a JSON value of the type defined above

Throws:

JSONException

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.InputStream inputStream,
                                              java.nio.charset.Charset charset,
                                              BuilderLimits limits,
                                              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

limits - the limits imposed on the builder

collector - collector object for creating JSON 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,
                                              BuilderLimits limits)
                                       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

limits - the limits imposed on the builder

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.lang.String s,
                                              BuilderLimits limits,
                                              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.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(java.lang.String s,
                                              BuilderLimits limits)
                                       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.

limits - the limits imposed on the builder

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(JSONLimitStreamReader 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.

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(JSONLimitStreamReader reader,
                                              BuilderLimits limits)
                                       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.

limits - the limits imposed on the builder

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONValue

public static java.lang.Object buildJSONValue(JSONLimitStreamReader reader,
                                              BuilderLimits limits,
                                              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.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON value of the type defined above

Throws:

JSONException

buildJSONObject

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

Build a JSON object from a Reader.

Type Parameters:

OR - the result type of the JSON object constructed by the collector

Parameters:

reader - A reader.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON object value

Throws:

JSONException

buildJSONObject

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

Build a JSONObject from a Reader.

Parameters:

reader - A reader.

limits - the limits imposed on the builder

Returns:

a JSONObject value

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.InputStream inputStream,
                                      java.nio.charset.Charset charset,
                                      BuilderLimits limits,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

Build a JSON object from a InputStream and supplied Charset.

Type Parameters:

OR - the result type of the JSON object constructed by the collector

Parameters:

inputStream - the input stream containing the JSON data

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

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON object value

Throws:

JSONException

buildJSONObject

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

Build a JSONObject from a InputStream and supplied Charset.

Parameters:

inputStream - the input stream containing the JSON data

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

limits - the limits imposed on the builder

Returns:

a JSONObject 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 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.lang.String s,
                                      BuilderLimits limits,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

Build a JSON object from a String.

Type Parameters:

OR - the result type of the JSON object constructed by the collector

Parameters:

s - A source string.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON object value

Throws:

JSONException

buildJSONObject

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

Build a JSONObject from a String.

Parameters:

s - A source string.

limits - the limits imposed on the builder

Returns:

a JSONObject 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 JSONObject buildJSONObject(JSONLimitStreamReader reader)
                                  throws JSONException

Build a JSONObject from a JSONLimitStreamReader.

Parameters:

reader - A source stream.

Returns:

a JSONObject value

Throws:

JSONException

buildJSONObject

public static JSONObject buildJSONObject(JSONLimitStreamReader reader,
                                         BuilderLimits limits)
                                  throws JSONException

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

Parameters:

reader - A source stream.

limits - the limits imposed on the builder

Returns:

a JSONObject value

Throws:

JSONException

buildJSONObject

public static <OR> OR buildJSONObject(JSONLimitStreamReader reader,
                                      BuilderLimits limits,
                                      StructureCollector<?,?,OR,?> collector)
                               throws JSONException

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

Type Parameters:

OR - the result type of the JSON object constructed by the collector

Parameters:

reader - A source stream.

limits - the limits imposed on the builder

collector - collector for creating JSON structures

Returns:

a JSON object value

Throws:

JSONException

buildJSONArray

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

Build a JSON array from a Reader.

Type Parameters:

AR - the result type of the JSON array constructed by the collector

Parameters:

reader - A reader.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON array value

Throws:

JSONException

buildJSONArray

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

Build a JSONArray from a Reader.

Parameters:

reader - A reader.

limits - the limits imposed on the builder

Returns:

a JSONArray 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 <AR> AR buildJSONArray(java.io.InputStream inputStream,
                                     java.nio.charset.Charset charset,
                                     BuilderLimits limits,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

Build a JSON array from a InputStream and supplied Charset.

Type Parameters:

AR - the result type of the JSON array constructed by the collector

Parameters:

inputStream - the input stream containing the JSON data

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

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON array value

Throws:

JSONException

buildJSONArray

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

Build a JSONArray from a InputStream and supplied Charset.

Parameters:

inputStream - the input stream containing the JSON data

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

limits - the limits imposed on the builder

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 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.lang.String s,
                                     BuilderLimits limits,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

Build a JSON array from a String.

Type Parameters:

AR - the result type of the JSON array constructed by the collector

Parameters:

s - A source string.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

a JSON array value

Throws:

JSONException

buildJSONArray

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

Build a JSONArray from a String.

Parameters:

s - A source string.

limits - the limits imposed on the builder

Returns:

a JSONArray 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 JSONArray buildJSONArray(JSONLimitStreamReader reader)
                                throws JSONException

Build a JSONArray from a JSONLimitStreamReader.

Parameters:

reader - A source reader.

Returns:

a JSONArray value

Throws:

JSONException

buildJSONArray

public static JSONArray buildJSONArray(JSONLimitStreamReader reader,
                                       BuilderLimits limits)
                                throws JSONException

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

Parameters:

reader - A source stream.

limits - the limits imposed on the builder

Returns:

a JSONArray value

Throws:

JSONException

buildJSONArray

public static <AR> AR buildJSONArray(JSONLimitStreamReader reader,
                                     BuilderLimits limits,
                                     StructureCollector<?,?,?,AR> collector)
                              throws JSONException

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

Type Parameters:

AR - the result type of the JSON array constructed by the collector

Parameters:

reader - A source stream.

limits - the limits imposed on the builder

collector - collector object for creating structures

Returns:

a JSON array value

Throws:

JSONException

buildObjectSubTree

public static JSONObject buildObjectSubTree(JSONLimitStreamReader reader,
                                            BuilderLimits limits)
                                     throws JSONException

If the given JSONLimitStreamReader'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.

limits - the limits imposed on the builder

Returns:

a JSONObject representing the subtree starting at the current OBJECT state

Throws:

JSONException

buildObjectSubTree

public static <OR> OR buildObjectSubTree(JSONLimitStreamReader reader,
                                         BuilderLimits limits,
                                         StructureCollector<?,?,OR,?> collector)
                                  throws JSONException

If the given JSONLimitStreamReader'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 result type of the JSON object constructed by the collector

Parameters:

reader - A source stream reader.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

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

Throws:

JSONException

buildArraySubTree

public static JSONArray buildArraySubTree(JSONLimitStreamReader reader,
                                          BuilderLimits limits)
                                   throws JSONException

If the given JSONLimitStreamReader'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.

Parameters:

reader - A source stream reader.

limits - the limits imposed on the builder

Returns:

a JSONArray representing the subtree starting at the current ARRAY state

Throws:

JSONException

buildArraySubTree

public static <AR> AR buildArraySubTree(JSONLimitStreamReader reader,
                                        BuilderLimits limits,
                                        StructureCollector<?,?,?,AR> collector)
                                 throws JSONException

If the given JSONLimitStreamReader's ParseState was JSONStreamReader.ParseState.ARRAY, return the entire subtree as an array type. 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 result type of the JSON array constructed by the collector

Parameters:

reader - A source stream reader.

limits - the limits imposed on the builder

collector - collector object for creating JSON structures

Returns:

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

Throws:

JSONException