Package org.json
Class JSONStringer
- java.lang.Object
-
- org.json.JSONWriter
-
- org.json.JSONStringer
-
public class JSONStringer extends JSONWriter
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 akey
method for adding keys before values in objects. There arearray
andendArray
methods that make and bound array values, andobject
andendObject
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
orobject
. 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.
- Since:
- Ptolemy II 10.0
- Version:
- $Id$, 2008-09-18
- Author:
- JSON.org
-
-
Field Summary
-
Fields inherited from class org.json.JSONWriter
mode, writer
-
-
Constructor Summary
Constructors Constructor Description JSONStringer()
Make a fresh JSONStringer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
Return the JSON text.
-
-
-
Method Detail
-
toString
public java.lang.String toString()
Return the JSON text. This method is used to obtain the product of the JSONStringer instance. It will returnnull
if there was a problem in the construction of the JSON text (such as the calls toarray
were not properly balanced with calls toendArray
).- Overrides:
toString
in classjava.lang.Object
- Returns:
- The JSON text.
-
-