|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.json.util.JSONBuilder
public class JSONBuilder
JSONBuilder 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 JSONBuilder 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 JSONBuilder instance, permitting a cascade style.
For example,
new JSONBuilder(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. JSONBuilder 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 | |
---|---|
JSONBuilder(Writer w)
Make a fresh JSONBuilder. |
Method Summary | |
---|---|
JSONBuilder |
array()
Begin appending a new array. |
JSONBuilder |
endArray()
End an array. |
JSONBuilder |
endObject()
End an object. |
JSONBuilder |
key(String s)
Append a key. |
JSONBuilder |
object()
Begin appending a new object. |
JSONBuilder |
value(boolean b)
Append either the value true or the value
false . |
JSONBuilder |
value(double d)
Append a double value. |
JSONBuilder |
value(long l)
Append a long value. |
JSONBuilder |
value(Object o)
Append an object value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected char mode
protected Writer writer
Constructor Detail |
---|
public JSONBuilder(Writer w)
Method Detail |
---|
public JSONBuilder array()
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).public JSONBuilder endArray()
array
.
JSONException
- If incorrectly nested.public JSONBuilder endObject()
object
.
JSONException
- If incorrectly nested.public JSONBuilder key(String s)
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 JSONBuilder object()
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).public JSONBuilder value(boolean b)
true
or the value
false
.
b
- A boolean.
JSONException
public JSONBuilder value(double d)
d
- A double.
JSONException
- If the number is not finite.public JSONBuilder value(long l)
l
- A long.
JSONException
public JSONBuilder value(Object o)
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |