Package net.sf.json.util
Class JSONBuilder
java.lang.Object
net.sf.json.util.JSONBuilder
- Direct Known Subclasses:
JSONStringer
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.- Version:
- 1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
The comma flag determines if a comma should be output before the next value.private static final int
protected char
The current mode.private char[]
The object/array stack.private int
The stack top index.protected Writer
The writer that will receive the output. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate JSONBuilder
Append a value.array()
Begin appending a new array.private JSONBuilder
end
(char m, char c) End something.endArray()
End an array.End an object.Append a key.object()
Begin appending a new object.private void
pop
(char c) Pop an array or object scope.private void
push
(char c) Push an array or object scope.value
(boolean b) Append either the valuetrue
or the valuefalse
.value
(double d) Append a double value.value
(long l) Append a long value.Append an object value.
-
Field Details
-
MAXDEPTH
private static final int MAXDEPTH- See Also:
-
comma
private boolean commaThe comma flag determines if a comma should be output before the next value. -
mode
protected char modeThe current mode. Values: 'a' (array), 'd' (done), 'i' (initial), 'k' (key), 'o' (object). -
stack
private char[] stackThe object/array stack. -
top
private int topThe stack top index. A value of 0 indicates that the stack is empty. -
writer
The writer that will receive the output.
-
-
Constructor Details
-
JSONBuilder
Make a fresh JSONBuilder. It can be used to build one JSON text.
-
-
Method Details
-
append
Append a value.- Parameters:
s
- A string value.- Returns:
- this
- Throws:
JSONException
- If the value is out of sequence.
-
array
Begin appending a new array. All values until the balancingendArray
will be appended to this array. TheendArray
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).
-
end
End something.- Parameters:
m
- Modec
- Closing character- Returns:
- this
- Throws:
JSONException
- If unbalanced.
-
endArray
End an array. This method most be called to balance calls toarray
.- Returns:
- this
- Throws:
JSONException
- If incorrectly nested.
-
endObject
End an object. This method most be called to balance calls toobject
.- Returns:
- this
- Throws:
JSONException
- If incorrectly nested.
-
key
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
- Throws:
JSONException
- If the key is out of place. For example, keys do not belong in arrays or if the key is null.
-
object
Begin appending a new object. All keys and values until the balancingendObject
will be appended to this object. TheendObject
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).
-
pop
private void pop(char c) Pop an array or object scope.- Parameters:
c
- The scope to close.- Throws:
JSONException
- If nesting is wrong.
-
push
private void push(char c) Push an array or object scope.- Parameters:
c
- The scope to open.- Throws:
JSONException
- If nesting is too deep.
-
value
Append either the valuetrue
or the valuefalse
.- Parameters:
b
- A boolean.- Returns:
- this
- Throws:
JSONException
-
value
Append a double value.- Parameters:
d
- A double.- Returns:
- this
- Throws:
JSONException
- If the number is not finite.
-
value
Append a long value.- Parameters:
l
- A long.- Returns:
- this
- Throws:
JSONException
-
value
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
- Throws:
JSONException
- If the value is out of sequence.
-