org.json.stream

Class CollectionCollector

java.lang.Object

org.json.stream.CollectionCollector

All Implemented Interfaces:

StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

public final class CollectionCollector
extends java.lang.Object
implements StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Structure collector that creates HashMap, ArrayList, and null instances. The result types are finished using Collections.unmodifiableMap() and Collections.unmodifiableList().

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	addNull(java.util.List<java.lang.Object> array) Adds a Java null value to the given JSON array.
void	addNull(java.util.Map<java.lang.String,java.lang.Object> object, java.lang.String key) Adds a Java null value an an entry to the given JSON object.
void	addValue(java.util.List<java.lang.Object> array, java.lang.Object value) Adds the given value to the given JSON array accumulator.
void	addValue(java.util.Map<java.lang.String,java.lang.Object> object, java.lang.String key, java.lang.Object value) Adds the given entry to the given JSON object.
java.util.List<java.lang.Object>	createArrayAccumulator() Create a new ArrayList into which JSON array entries are added.
java.util.Map<java.lang.String,java.lang.Object>	createObjectAccumulator() Create a new HashMap into which JSON object entries are added.
java.util.List<java.lang.Object>	finishArray(java.util.List<java.lang.Object> accumulator) Finish the given JSON array accumulator, returning the array result.
java.util.Map<java.lang.String,java.lang.Object>	finishObject(java.util.Map<java.lang.String,java.lang.Object> 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 CollectionCollector INSTANCE

The singleton instance of this collector.

Method Detail

createObjectAccumulator

public java.util.Map<java.lang.String,java.lang.Object> createObjectAccumulator()

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

Specified by:

createObjectAccumulator in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Returns:

a new HashMap instance

addValue

public void addValue(java.util.Map<java.lang.String,java.lang.Object> 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<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.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

public void addNull(java.util.Map<java.lang.String,java.lang.Object> object,
                    java.lang.String key)
             throws JSONException

Adds a Java null value an an entry to the given JSON object.

Specified by:

addNull in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

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 java.util.Map<java.lang.String,java.lang.Object> finishObject(java.util.Map<java.lang.String,java.lang.Object> accumulator)

Finish the given JSON object accumulator, returning the object result. The result is an unmodifiable Map.

Specified by:

finishObject in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Parameters:

accumulator - the JSON object accumulator to be finished

Returns:

the finished object result, as an unmodifiable Map

createArrayAccumulator

public java.util.List<java.lang.Object> createArrayAccumulator()

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

Specified by:

createArrayAccumulator in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Returns:

a new ArrayList instance

addValue

public void addValue(java.util.List<java.lang.Object> array,
                     java.lang.Object value)

Description copied from interface: StructureCollector

Adds the given value to the given JSON array accumulator.

Specified by:

addValue in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Parameters:

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

value - the value to be added

addNull

public void addNull(java.util.List<java.lang.Object> array)

Adds a Java null value to the given JSON array.

Specified by:

addNull in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Parameters:

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

finishArray

public java.util.List<java.lang.Object> finishArray(java.util.List<java.lang.Object> accumulator)

Finish the given JSON array accumulator, returning the array result. The result in an unmodifiable List.

Specified by:

finishArray in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Parameters:

accumulator - the JSON array accumulator to be finished

Returns:

the finished array result, as an unmodifiable List

nullValue

public java.lang.Object nullValue()

Description copied from interface: StructureCollector

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

Specified by:

nullValue in interface StructureCollector<java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>,java.util.List<java.lang.Object>>

Returns:

a JSON null value