com.day.cq.commons

Class TidyJSONWriter

java.lang.Object

org.apache.sling.commons.json.io.JSONWriter

com.day.cq.commons.TidyJSONWriter

public class TidyJSONWriter
extends JSONWriter

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 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 Summary

Constructors

Constructor and Description
TidyJSONWriter(java.io.Writer w) Make a fresh JSONWriter.

Method Summary

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.

Methods inherited from class org.apache.sling.commons.json.io.JSONWriter

writeArray, writeObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TidyJSONWriter

public TidyJSONWriter(java.io.Writer w)

Make a fresh JSONWriter. It can be used to build one JSON text.

Parameters:

w - Writer

Method Detail

isTidy

public boolean isTidy()

Checks if the output is nicely formatted.

Overrides:

isTidy in class JSONWriter

Returns:

true if nicely formatted

setTidy

public void setTidy(boolean tidy)

Controls if output should be nicely formatted.

Overrides:

setTidy in class JSONWriter

Parameters:

tidy - true to nicely format.

array

public TidyJSONWriter array()
                     throws JSONException

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.

Overrides:

array in class JSONWriter

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).

endArray

public TidyJSONWriter endArray()
                        throws JSONException

End an array. This method most be called to balance calls to array.

Overrides:

endArray in class JSONWriter

Returns:

this

Throws:

JSONException - If incorrectly nested.

endObject

public TidyJSONWriter endObject()
                         throws JSONException

End an object. This method most be called to balance calls to object.

Overrides:

endObject in class JSONWriter

Returns:

this

Throws:

JSONException - If incorrectly nested.

key

public TidyJSONWriter key(java.lang.String s)
                   throws JSONException

Append a key. The key will be associated with the next value. In an object, every value must be preceded by a key.

Overrides:

key in class JSONWriter

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

public TidyJSONWriter object()
                      throws JSONException

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.

Overrides:

object in class JSONWriter

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).

value

public TidyJSONWriter value(boolean b)
                     throws JSONException

Append either the value true or the value false.

Overrides:

value in class JSONWriter

Parameters:

b - A boolean.

Returns:

this

Throws:

JSONException - if some error occurs

value

public TidyJSONWriter value(double d)
                     throws JSONException

Append a double value.

Overrides:

value in class JSONWriter

Parameters:

d - A double.

Returns:

this

Throws:

JSONException - If the number is not finite.

value

public TidyJSONWriter value(long l)
                     throws JSONException

Append a long value.

Overrides:

value in class JSONWriter

Parameters:

l - A long.

Returns:

this

Throws:

JSONException - if some error occurs

value

public TidyJSONWriter value(java.lang.Object o)
                     throws JSONException

Append an object value.

Overrides:

value in class JSONWriter

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.