org.json.stream

Interface StructureCollector<OA,AA,OR,AR>

Type Parameters:

OA - the JSON object accumulator type

AA - the JSON array accumulator type

OR - the JSON object result type

AR - the JSON array result type

All Known Implementing Classes:

CollectionCollector, JSONCollector

public interface StructureCollector<OA,AA,OR,AR>

Allows JSONLimitBuilder to parameterize the creation and population of object and array structures, null values, and creation of a "finished" result type. Similar to Collector in Java 8's stream package.

For instance, structures may be created as JSONObject and JSONArray, with JSONObject.NULL for JSON null. Another collector may create structures as HashMap and ArrayList, and Java's null value for JSON null.

Method Summary

Modifier and Type	Method and Description
void	addNull(AA array) Adds a JSON null value to the given JSON array accumulator.
void	addNull(OA object, java.lang.String key) Adds a JSON null entry to the given JSON object.
void	addValue(AA array, java.lang.Object value) Adds the given value to the given JSON array accumulator.
void	addValue(OA object, java.lang.String key, java.lang.Object value) Adds the given entry to the given JSON object.
AA	createArrayAccumulator() Create an instance of an object into which JSON array entries are added.
OA	createObjectAccumulator() Create an instance of an object into which JSON object entries are added.
AR	finishArray(AA accumulator) Finish the given JSON array accumulator, returning the array result.
OR	finishObject(OA 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.

Method Detail

createObjectAccumulator

OA createObjectAccumulator()

Create an instance of an object into which JSON object entries are added.

Returns:

a new object instance

addValue

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

Adds the given entry to the given JSON object.

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

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

Adds a JSON null entry to the given JSON object. Implementations may choose to add a sentinel value, or omit the entry entirely.

Parameters:

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

key - the key of the entry

Throws:

JSONException - may be thrown if a duplicate key is encountered

finishObject

OR finishObject(OA accumulator)
         throws JSONException

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

Parameters:

accumulator - the JSON object accumulator to be finished

Returns:

the finished object result

Throws:

JSONException - there was a problem finishing the object

createArrayAccumulator

AA createArrayAccumulator()

Create an instance of an object into which JSON array entries are added.

Returns:

a new array instance

addValue

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

Adds the given value to the given JSON array accumulator.

Parameters:

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

value - the value to be added

Throws:

JSONException

addNull

void addNull(AA array)
      throws JSONException

Adds a JSON null value to the given JSON array accumulator. Implementations can choose the sentinel value to be added.

Parameters:

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

Throws:

JSONException

finishArray

AR finishArray(AA accumulator)
        throws JSONException

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

Parameters:

accumulator - the JSON array accumulator to be finished

Returns:

the finished array result

Throws:

JSONException - there was a problem finishing the array

nullValue

java.lang.Object nullValue()

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

Returns:

a JSON null value