org.json
public class JSONWriter extends Object
A JSONWriter 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 a cascade style. For example,
new JSONWriter(myWriter) .object() .key("JSON") .value("Hello, World!") .endObject();which writes
{"JSON":"Hello, World!"}
The first method called must be array
or object
.
There are no methods for adding commas or colons. JSONWriter 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.
Field Summary | |
---|---|
protected char | mode
The current mode. |
protected Writer | writer
The writer that will receive the output. |
Constructor Summary | |
---|---|
JSONWriter(Writer w)
Make a fresh JSONWriter. |
Method Summary | |
---|---|
JSONWriter | array()
Begin appending a new array. |
JSONWriter | endArray()
End an array. |
JSONWriter | endObject()
End an object. |
JSONWriter | key(String s)
Append a key. |
JSONWriter | object()
Begin appending a new object. |
JSONWriter | value(boolean b)
Append either the value true or the value
false . |
JSONWriter | value(double d)
Append a double value. |
JSONWriter | value(long l)
Append a long value. |
JSONWriter | value(Object o)
Append an object value. |
endArray
will be appended to this array. The
endArray
method must be called to mark the array's end.Returns: this
Throws: JSONException If the nesting is too deep, or if the object is started in the wrong place (for example as a key or after the end of the outermost array or object).
array
.Returns: this
Throws: JSONException If incorrectly nested.
object
.Returns: this
Throws: JSONException If incorrectly nested.
Parameters: s A key string.
Returns: this
Throws: JSONException If the key is out of place. For example, keys do not belong in arrays or if the key is null.
endObject
will be appended to this object. The
endObject
method must be called to mark the object's end.Returns: this
Throws: JSONException If the nesting is too deep, or if the object is started in the wrong place (for example as a key or after the end of the outermost array or object).
true
or the value
false
.Parameters: b A boolean.
Returns: this
Throws: JSONException
Parameters: d A double.
Returns: this
Throws: JSONException If the number is not finite.
Parameters: l A long.
Returns: this
Throws: JSONException
Parameters: o The object to append. It can be null, or a Boolean, Number, String, JSONObject, or JSONArray, or an object with a toJSONString() method.
Returns: this
Throws: JSONException If the value is out of sequence.