org.apache.sling.commons.json.io

Class JSONWriter

java.lang.Object

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

Direct Known Subclasses:

CustomJSONWriter, JSONStringer, TidyJSONWriter

Deprecated.

@Deprecated
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 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
JSONWriter(java.io.Writer w) Deprecated. Make a fresh JSONWriter.

Method Summary

Modifier and Type	Method and Description
JSONWriter	array() Deprecated. Begin appending a new array.
JSONWriter	endArray() Deprecated. End an array.
JSONWriter	endObject() Deprecated. End an object.
boolean	isTidy() Deprecated. Checks if the output is nicely formatted.
JSONWriter	key(java.lang.String s) Deprecated. Append a key.
JSONWriter	object() Deprecated. Begin appending a new object.
void	setTidy(boolean tidy) Deprecated. Controls if output should be nicely formatted.
JSONWriter	value(boolean b) Deprecated. Append either the value true or the value false.
JSONWriter	value(double d) Deprecated. Append a double value.
JSONWriter	value(long l) Deprecated. Append a long value.
JSONWriter	value(java.lang.Object o) Deprecated. Append an object value.
JSONWriter	writeArray(JSONArray a) Deprecated. Append a JSON Array
JSONWriter	writeObject(JSONObject o) Deprecated. Append a JSON Object

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONWriter

public JSONWriter(java.io.Writer w)

Deprecated.

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

Method Detail

isTidy

public boolean isTidy()

Deprecated.

Checks if the output is nicely formatted.

Returns:

true if nicely formatted

setTidy

public void setTidy(boolean tidy)

Deprecated.

Controls if output should be nicely formatted.

Parameters:

tidy - true to nicely format.

array

public JSONWriter array()
                 throws JSONException

Deprecated.

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.

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 JSONWriter endArray()
                    throws JSONException

Deprecated.

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

Returns:

this

Throws:

JSONException - If incorrectly nested.

endObject

public JSONWriter endObject()
                     throws JSONException

Deprecated.

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

Returns:

this

Throws:

JSONException - If incorrectly nested.

key

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

Deprecated.

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

public JSONWriter object()
                  throws JSONException

Deprecated.

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.

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 JSONWriter value(boolean b)
                 throws JSONException

Deprecated.

Append either the value true or the value false.

Parameters:

b - A boolean.

Returns:

this

Throws:

JSONException

value

public JSONWriter value(double d)
                 throws JSONException

Deprecated.

Append a double value.

Parameters:

d - A double.

Returns:

this

Throws:

JSONException - If the number is not finite.

value

public JSONWriter value(long l)
                 throws JSONException

Deprecated.

Append a long value.

Parameters:

l - A long.

Returns:

this

Throws:

JSONException

value

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

Deprecated.

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.

writeObject

public JSONWriter writeObject(JSONObject o)
                       throws JSONException

Deprecated.

Append a JSON Object

Parameters:

o -

Returns:

Throws:

JSONException

writeArray

public JSONWriter writeArray(JSONArray a)
                      throws JSONException

Deprecated.

Append a JSON Array

Parameters:

a -

Returns:

Throws:

JSONException