public class TidyJSONWriter extends JSONWriter
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.
Constructor and Description |
---|
TidyJSONWriter(java.io.Writer w)
Make a fresh JSONWriter.
|
Modifier and Type | Method and Description |
---|---|
TidyJSONWriter |
array()
Begin appending a new array.
|
TidyJSONWriter |
endArray()
End an array.
|
TidyJSONWriter |
endObject()
End an object.
|
boolean |
isTidy()
Checks if the output is nicely formatted.
|
TidyJSONWriter |
key(java.lang.String s)
Append a key.
|
TidyJSONWriter |
object()
Begin appending a new object.
|
void |
setTidy(boolean tidy)
Controls if output should be nicely formatted.
|
TidyJSONWriter |
value(boolean b)
Append either the value
true or the value
false . |
TidyJSONWriter |
value(double d)
Append a double value.
|
TidyJSONWriter |
value(long l)
Append a long value.
|
TidyJSONWriter |
value(java.lang.Object o)
Append an object value.
|
writeArray, writeObject
public TidyJSONWriter(java.io.Writer w)
w
- Writer
public boolean isTidy()
isTidy
in class JSONWriter
true
if nicely formattedpublic void setTidy(boolean tidy)
setTidy
in class JSONWriter
tidy
- true
to nicely format.public TidyJSONWriter array() throws JSONException
endArray
will be appended to this array. The
endArray
method must be called to mark the array's end.array
in class JSONWriter
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).public TidyJSONWriter endArray() throws JSONException
array
.endArray
in class JSONWriter
JSONException
- If incorrectly nested.public TidyJSONWriter endObject() throws JSONException
object
.endObject
in class JSONWriter
JSONException
- If incorrectly nested.public TidyJSONWriter key(java.lang.String s) throws JSONException
key
in class JSONWriter
s
- A key string.JSONException
- If the key is out of place. For example, keys
do not belong in arrays or if the key is null.public TidyJSONWriter object() throws JSONException
endObject
will be appended to this object. The
endObject
method must be called to mark the object's end.object
in class JSONWriter
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).public TidyJSONWriter value(boolean b) throws JSONException
true
or the value
false
.value
in class JSONWriter
b
- A boolean.JSONException
- if some error occurspublic TidyJSONWriter value(double d) throws JSONException
value
in class JSONWriter
d
- A double.JSONException
- If the number is not finite.public TidyJSONWriter value(long l) throws JSONException
value
in class JSONWriter
l
- A long.JSONException
- if some error occurspublic TidyJSONWriter value(java.lang.Object o) throws JSONException
value
in class JSONWriter
o
- The object to append. It can be null, or a Boolean, Number,
String, JSONObject, or JSONArray, or an object with a toJSONString()
method.JSONException
- If the value is out of sequence.Copyright © 2010 - 2020 Adobe. All Rights Reserved