org.json.stream

Class JSONCollector

java.lang.Object

org.json.stream.JSONCollector

All Implemented Interfaces:

StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

public final class JSONCollector
extends java.lang.Object
implements StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Structure collector that creates JSONObject, JSONArray, and JSONObject.NULL instances.

This collector holds no state, so a singleton is provided.

Field Summary

Fields

Modifier and Type	Field and Description
static JSONCollector	INSTANCE The singleton instance of this collector.

Method Summary

Modifier and Type	Method and Description
void	addNull(JSONArray array) Adds a JSONObject.NULL value to the given JSONArray.
void	addNull(JSONObject object, java.lang.String key) Adds a JSONObject.NULL value an an entry to the given JSONObject.
void	addValue(JSONArray array, java.lang.Object value) Adds the given value to the given JSON array accumulator.
void	addValue(JSONObject object, java.lang.String key, java.lang.Object value) Adds the given entry to the given JSON object.
JSONArray	createArrayAccumulator() Create a new JSONArray into which JSON array entries are added.
JSONObject	createObjectAccumulator() Create a new JSONObject into which JSON object entries are added.
JSONArray	finishArray(JSONArray accumulator) Finish the given JSON array accumulator, returning the array result.
JSONObject	finishObject(JSONObject accumulator) Finish the given JSON object accumulator, returning the object result.
java.lang.Object	nullValue() Provide a null value for circumstances where JSON null is the complete result of a JSON parse.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final JSONCollector INSTANCE

The singleton instance of this collector.

Method Detail

createObjectAccumulator

public JSONObject createObjectAccumulator()

Create a new JSONObject into which JSON object entries are added.

Specified by:

createObjectAccumulator in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Returns:

a new JSONObject instance

addValue

public void addValue(JSONObject object,
                     java.lang.String key,
                     java.lang.Object value)
              throws JSONException

Description copied from interface: StructureCollector

Adds the given entry to the given JSON object.

Specified by:

addValue in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Parameters:

object - the JSON object accumulator to which the entry will be added

key - the key of the entry

value - the value of the entry

Throws:

JSONException - may be thrown if a duplicate key is encountered

addNull

public void addNull(JSONObject object,
                    java.lang.String key)
             throws JSONException

Adds a JSONObject.NULL value an an entry to the given JSONObject.

Specified by:

addNull in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Parameters:

object - the target to which the entry will be added

key - the key of the entry

Throws:

JSONException - a duplicate key is encountered

finishObject

public JSONObject finishObject(JSONObject accumulator)

Description copied from interface: StructureCollector

Finish the given JSON object accumulator, returning the object result. This gives the collector an opportunity to create an immutable result.

Specified by:

finishObject in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Parameters:

accumulator - the JSON object accumulator to be finished

Returns:

the finished object result

createArrayAccumulator

public JSONArray createArrayAccumulator()

Create a new JSONArray into which JSON array entries are added.

Specified by:

createArrayAccumulator in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Returns:

a new JSONArray instance

addValue

public void addValue(JSONArray array,
                     java.lang.Object value)
              throws JSONException

Description copied from interface: StructureCollector

Adds the given value to the given JSON array accumulator.

Specified by:

addValue in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Parameters:

array - the JSON array accumulator to which the value will be added

value - the value to be added

Throws:

JSONException

addNull

public void addNull(JSONArray array)
             throws JSONException

Adds a JSONObject.NULL value to the given JSONArray.

Specified by:

addNull in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Parameters:

array - the target to which the null value will be added

Throws:

JSONException

finishArray

public JSONArray finishArray(JSONArray accumulator)

Description copied from interface: StructureCollector

Finish the given JSON array accumulator, returning the array result. This gives the collector an opportunity to create an immutable result.

Specified by:

finishArray in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Parameters:

accumulator - the JSON array accumulator to be finished

Returns:

the finished array result

nullValue

public java.lang.Object nullValue()

Provide a null value for circumstances where JSON null is the complete result of a JSON parse.

Specified by:

nullValue in interface StructureCollector<JSONObject,JSONArray,JSONObject,JSONArray>

Returns:

The JSONObject.NULL value