public class JSONWriter
extends java.lang.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.
| Modifier and Type | Field and Description |
|---|---|
protected char |
mode
The current mode.
|
protected java.io.Writer |
writer
The writer that will receive the output.
|
| Constructor and Description |
|---|
JSONWriter(java.io.Writer w)
Make a fresh JSONWriter.
|
| Modifier and Type | Method and Description |
|---|---|
JSONWriter |
array()
Begin appending a new array.
|
JSONWriter |
endArray()
End an array.
|
JSONWriter |
endObject()
End an object.
|
JSONWriter |
key(java.lang.String s)
Append a key.
|
JSONWriter |
nullValue()
Append an object value.
|
JSONWriter |
object()
Begin appending a new object.
|
static java.lang.String |
trimNumber(java.lang.String s) |
JSONWriter |
value(boolean b)
Append either the value
true or the value
false. |
JSONWriter |
value(char string) |
JSONWriter |
value(double d)
Append a double value.
|
JSONWriter |
value(long l)
Append a long value.
|
JSONWriter |
value(java.lang.String string) |
protected char mode
protected java.io.Writer writer
public JSONWriter(java.io.Writer w)
public JSONWriter array() throws java.io.IOException
endArray will be appended to this array. The
endArray method must be called to mark the array's end.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).java.io.IOExceptionpublic JSONWriter endArray() throws java.io.IOException
array.JSONException - If incorrectly nested.java.io.IOExceptionpublic JSONWriter endObject() throws java.io.IOException
object.JSONException - If incorrectly nested.java.io.IOExceptionpublic JSONWriter key(java.lang.String s) throws java.io.IOException
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.java.io.IOExceptionpublic JSONWriter object() throws java.io.IOException
endObject will be appended to this object. The
endObject method must be called to mark the object's end.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).java.io.IOExceptionpublic JSONWriter value(boolean b) throws java.io.IOException
true or the value
false.b - A boolean.JSONExceptionjava.io.IOExceptionpublic JSONWriter value(double d) throws java.io.IOException
d - A double.JSONException - If the number is not finite.java.io.IOExceptionpublic static java.lang.String trimNumber(java.lang.String s)
public JSONWriter value(long l) throws java.io.IOException
l - A long.JSONExceptionjava.io.IOExceptionpublic JSONWriter nullValue() throws java.io.IOException
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.java.io.IOExceptionpublic JSONWriter value(char string) throws java.io.IOException
java.io.IOExceptionpublic JSONWriter value(java.lang.String string) throws java.io.IOException
java.io.IOException