File	Doc	Category	Size	Date	Package
JSONStringer.java	API Doc	Android 1.5 API	10573	Wed May 06 22:41:04 BST 2009	org.json

JSONStringer

• java.lang.Object

myString = new JSONStringer()
.object()
.key("JSON").value("Hello, World!")
.endObject()
.toString();

{"JSON":"Hello, World!"}

Fields Summary
private static final int	maxdepth
private boolean	comma The comma flag determines if a comma should be output before the next value.
private char	mode The current mode. Values: 'a' (array), 'd' (done), 'i' (initial), 'k' (key), 'o' (object).
private StringBuilder	sb The string buffer that holds the JSON text that is built.
private char[]	stack The object/array stack.
private int	top The stack top index. A value of 0 indicates that the stack is empty.

Constructors Summary
public JSONStringer() Make a fresh JSONStringer. It can be used to build one JSON text. this.sb = new StringBuilder(); this.stack = new char[maxdepth]; this.top = 0; this.mode = 'i"; this.comma = false;

Methods Summary
private org.json.JSONStringer	append(java.lang.String s) Append a value. param s A string value. return this throws JSONException If the value is out of sequence. if (s == null) { throw new JSONException("Null pointer"); } if (this.mode == 'o" || this.mode == 'a") { if (this.comma && this.mode == 'a") { this.sb.append(',"); } this.sb.append(s); if (this.mode == 'o") { this.mode = 'k"; } this.comma = true; return this; } throw new JSONException("Value out of sequence.");
public org.json.JSONStringer	array() 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. return 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). if (this.mode == 'i" || this.mode == 'o" || this.mode == 'a") { push('a"); this.append("["); this.comma = false; return this; } throw new JSONException("Misplaced array.");
private org.json.JSONStringer	end(char m, char c) End something. param m Mode param c Closing character return this throws JSONException If unbalanced. if (this.mode != m) { throw new JSONException(m == 'o" ? "Misplaced endObject." : "Misplaced endArray."); } pop(m); this.sb.append(c); this.comma = true; return this;
public org.json.JSONStringer	endArray() End an array. This method most be called to balance calls to array. return this throws JSONException If incorrectly nested. return end('a", ']");
public org.json.JSONStringer	endObject() End an object. This method most be called to balance calls to object. return this throws JSONException If incorrectly nested. return end('k", '}");
public org.json.JSONStringer	key(java.lang.String s) Append a key. The key will be associated with the next value. In an object, every value must be preceded by a key. param s A key string. return this throws JSONException If the key is out of place. For example, keys do not belong in arrays or if the key is null. if (s == null) { throw new JSONException("Null key."); } if (this.mode == 'k") { if (this.comma) { this.sb.append(',"); } this.sb.append(JSONObject.quote(s)); this.sb.append(':"); this.comma = false; this.mode = 'o"; return this; } throw new JSONException("Misplaced key.");
public org.json.JSONStringer	object() 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. return 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). if (this.mode == 'i") { this.mode = 'o"; } if (this.mode == 'o" || this.mode == 'a") { this.append("{"); push('k"); this.comma = false; return this; } throw new JSONException("Misplaced object.");
private void	pop(char c) Pop an array or object scope. param c The scope to close. throws JSONException If nesting is wrong. if (this.top <= 0 || this.stack[this.top - 1] != c) { throw new JSONException("Nesting error."); } this.top -= 1; this.mode = this.top == 0 ? 'd" : this.stack[this.top - 1];
private void	push(char c) Push an array or object scope. param c The scope to open. throws JSONException If nesting is too deep. if (this.top >= maxdepth) { throw new JSONException("Nesting too deep."); } this.stack[this.top] = c; this.mode = c; this.top += 1;
public java.lang.String	toString() Return the JSON text. This method is used to obtain the product of the JSONStringer instance. It will return null if there was a problem in the construction of the JSON text (such as the calls to array were not properly balanced with calls to endArray). return The JSON text. return this.mode == 'd" ? this.sb.toString() : null;
public org.json.JSONStringer	value(boolean b) Append either the value true or the value false. param b A boolean. return this throws JSONException return this.append(b ? "true" : "false");
public org.json.JSONStringer	value(double d) Append a double value. param d A double. return this throws JSONException If the number is not finite. return this.value(new Double(d));
public org.json.JSONStringer	value(long l) Append a long value. param l A long. return this throws JSONException return this.append(Long.toString(l));
public org.json.JSONStringer	value(java.lang.Object o) Append an object value. param o The object to append. It can be null, or a Boolean, Number, String, JSONObject, or JSONArray. return this throws JSONException If the value is out of sequence. if (JSONObject.NULL.equals(o)) { return this.append("null"); } if (o instanceof Number) { JSONObject.testValidity(o); return this.append(JSONObject.numberToString((Number)o)); } if (o instanceof Boolean || o instanceof JSONArray || o instanceof JSONObject) { return this.append(o.toString()); } return this.append(JSONObject.quote(o.toString()));