public class JSONWriter extends java.lang.Object
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 avalue 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.
| Modifiers | Name | Description |
|---|---|---|
protected enum |
JSONWriter.Mode |
Enumeration of the possible modes of the JSONWriter |
private static class |
JSONWriter.NullWritable |
|
private static class |
JSONWriter.QuotedWritable |
|
private static class |
JSONWriter.WritableString |
| Modifiers | Name | Description |
|---|---|---|
protected boolean |
comma |
The comma flag determines if a comma should be output before the next value. |
protected JSONWriter.Mode |
mode |
The current mode. |
static groovy.lang.Writable |
nullWritable |
|
private java.util.Stack<Mode> |
stack |
The Mode stack. |
protected java.io.Writer |
writer |
The writer that will receive the output. |
| Constructor and description |
|---|
JSONWriter
(java.io.Writer w)Make a fresh JSONWriter. |
| Type Params | Return Type | Name and description |
|---|---|---|
|
protected JSONWriter |
append(java.lang.String s)Append a value. |
|
protected JSONWriter |
append(groovy.lang.Writable writableValue) |
|
public JSONWriter |
array()Begin appending a new array. |
|
protected void |
comma() |
|
protected JSONWriter |
end(JSONWriter.Mode m, char c)End something. |
|
public JSONWriter |
endArray()End an array. |
|
public JSONWriter |
endObject()End an object. |
|
public JSONWriter |
key(java.lang.String s)Append a key. |
|
public JSONWriter |
object()Begin appending a new object. |
|
protected void |
pop(JSONWriter.Mode c)Pop an array or object scope. |
|
protected void |
push(JSONWriter.Mode c)Push an array or object scope. |
|
public JSONWriter |
value(boolean b)Append either the value true or the value
false. |
|
public JSONWriter |
value(double d)Append a double value. |
|
public JSONWriter |
value(long l)Append a long value. |
|
public JSONWriter |
value(java.lang.Number number)Append a number value |
|
public JSONWriter |
value(java.lang.Object o)Append an object value. |
|
public JSONWriter |
valueNull() |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
The comma flag determines if a comma should be output before the next value.
The current mode. Values:
The Mode stack.
The writer that will receive the output.
Make a fresh JSONWriter. It can be used to build one JSON text.
Append a value.
s - A string value. 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.
End something.
m - Modec - Closing character End an array. This method most be called to balance calls to
array.
End an object. This method most be called to balance calls to
object.
Append a key. The key will be associated with the next value. In an object, every value must be preceded by a key.
s - A key string. 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.
Pop an array or object scope.
c - The scope to close.Push an array or object scope.
c - The scope to open. Append either the value true or the value
false.
b - A boolean.Append a double value.
d - A double.Append a long value.
l - A long.Append a number value
Append an object value.
o - The object to append. It can be null, or a Boolean, Number,
String, JSONObject, or JSONArray.