JSONStringer Class Reference

Inheritance diagram for JSONStringer:

Public Member Functions
	JSONStringer ()
String	toString ()
Public Member Functions inherited from JSONWriter
	JSONWriter (Writer w)
JSONWriter	array () throws JSONException
JSONWriter	endArray () throws JSONException
JSONWriter	endObject () throws JSONException
JSONWriter	key (String string) throws JSONException
JSONWriter	object () throws JSONException
JSONWriter	value (boolean b) throws JSONException
JSONWriter	value (double d) throws JSONException
JSONWriter	value (long l) throws JSONException
JSONWriter	value (Object object) throws JSONException

Additional Inherited Members
Protected Attributes inherited from JSONWriter
char	mode
Writer	writer

Detailed Description

JSONStringer provides a quick and convenient way of producing JSON text. The texts produced strictly conform to JSON syntax rules. No whitespace is added, so the results are ready for transmission or storage. Each instance of JSONStringer can produce one JSON text.

A JSONStringer instance provides a value method for appending values to the text, and a key method for adding keys before values in objects. There are array and endArray methods that make and bound array values, and object and endObject methods which make and bound object values. All of these methods return the JSONWriter instance, permitting cascade style. For example,

myString = new JSONStringer()
    .object()
        .key("JSON")
        .value("Hello, World!")
    .endObject()
    .toString();

which produces the string

{"JSON":"Hello, World!"}

The first method called must be array or object. There are no methods for adding commas or colons. JSONStringer adds them for you. Objects and arrays can be nested up to 20 levels deep.

This can sometimes be easier than using a JSONObject to build a string.

Author

JSON.org

Version

2008-09-18

Constructor & Destructor Documentation

JSONStringer()

JSONStringer

(

)

Make a fresh JSONStringer. It can be used to build one JSON text.

Member Function Documentation

toString()

String toString

(

)

Return the JSON text. This method is used to obtain the product of the JSONStringer instance. It will return null if there was a problem in the construction of the JSON text (such as the calls to array were not properly balanced with calls to endArray).

Returns

The JSON text.