org.json.JSONWriter Class Reference
Public Member Functions | |
| JSONWriter (Writer w) | |
| JSONWriter | array () throws JSONException |
| JSONWriter | endArray () throws JSONException |
| JSONWriter | endObject () throws JSONException |
| JSONWriter | key (String s) 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 o) throws JSONException |
Protected Attributes | |
| char | mode |
| Writer | writer |
Detailed Description
JSONWriter 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 JSONWriter can produce one JSON text.
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.
- Version:
- 2010-03-11
Constructor & Destructor Documentation
| org.json.JSONWriter.JSONWriter | ( | Writer | w | ) |
Make a fresh JSONWriter. It can be used to build one JSON text.
Member Function Documentation
| JSONWriter org.json.JSONWriter.array | ( | ) | throws JSONException |
Begin appending a new array. All values until the balancing endArray will be appended to this array. The endArray method must be called to mark the array's end.
- Returns:
- this
- Exceptions:
-
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).
| JSONWriter org.json.JSONWriter.endArray | ( | ) | throws JSONException |
End an array. This method most be called to balance calls to array.
- Returns:
- this
- Exceptions:
-
JSONException If incorrectly nested.
| JSONWriter org.json.JSONWriter.endObject | ( | ) | throws JSONException |
End an object. This method most be called to balance calls to object.
- Returns:
- this
- Exceptions:
-
JSONException If incorrectly nested.
| JSONWriter org.json.JSONWriter.key | ( | String | s | ) | throws JSONException |
Append a key. The key will be associated with the next value. In an object, every value must be preceded by a key.
- Parameters:
-
s A key string.
- Returns:
- this
- Exceptions:
-
JSONException If the key is out of place. For example, keys do not belong in arrays or if the key is null.
| JSONWriter org.json.JSONWriter.object | ( | ) | throws JSONException |
Begin appending a new object. All keys and values until the balancing endObject will be appended to this object. The endObject method must be called to mark the object's end.
- Returns:
- this
- Exceptions:
-
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).
| JSONWriter org.json.JSONWriter.value | ( | Object | o | ) | throws JSONException |
Append an object value.
- 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
- Exceptions:
-
JSONException If the value is out of sequence.
| JSONWriter org.json.JSONWriter.value | ( | long | l | ) | throws JSONException |
| JSONWriter org.json.JSONWriter.value | ( | double | d | ) | throws JSONException |
Append a double value.
- Parameters:
-
d A double.
- Returns:
- this
- Exceptions:
-
JSONException If the number is not finite.
| JSONWriter org.json.JSONWriter.value | ( | boolean | b | ) | throws JSONException |
Append either the value true or the value false.
- Parameters:
-
b A boolean.
- Returns:
- this
- Exceptions:
-
JSONException
Member Data Documentation
char org.json.JSONWriter.mode [protected] |
The current mode. Values: 'a' (array), 'd' (done), 'i' (initial), 'k' (key), 'o' (object).
Writer org.json.JSONWriter.writer [protected] |
The writer that will receive the output.
