Build 1.0_r1(from source)

org.json
Class JSONStringer

java.lang.Object
  extended by org.json.JSONStringer

public class JSONStringer
extends Object

JSONStringer 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 JSONStringer can produce one JSON text.

A JSONStringer 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 JSONStringer instance, permitting cascade style. For example,

 myString = new JSONStringer()
     .object()
         .key("JSON").value("Hello, World!")
     .endObject()
     .toString();
which produces the string
 {"JSON":"Hello, World!"}

The first method called must be array or object. There are no methods for adding commas or colons. JSONStringer 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
JSONStringer()
          Make a fresh JSONStringer.
 
Method Summary
 JSONStringer array()
          Begin appending a new array.
 JSONStringer endArray()
          End an array.
 JSONStringer endObject()
          End an object.
 JSONStringer key(String s)
          Append a key.
 JSONStringer object()
          Begin appending a new object.
 String toString()
          Return the JSON text.
 JSONStringer value(boolean b)
          Append either the value true or the value false.
 JSONStringer value(double d)
          Append a double value.
 JSONStringer value(long l)
          Append a long value.
 JSONStringer value(Object o)
          Append an object value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JSONStringer

public JSONStringer()
Make a fresh JSONStringer. It can be used to build one JSON text.

Method Detail

array

public JSONStringer 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.

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 JSONStringer endArray()
                      throws JSONException
End an array. This method most be called to balance calls to array.

Returns:
this
Throws:
JSONException - If incorrectly nested.

endObject

public JSONStringer endObject()
                       throws JSONException
End an object. This method most be called to balance calls to object.

Returns:
this
Throws:
JSONException - If incorrectly nested.

key

public JSONStringer key(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.

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

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 JSONStringer value(boolean b)
                   throws JSONException
Append either the value true or the value false.

Parameters:
b - A boolean.
Returns:
this
Throws:
JSONException

value

public JSONStringer value(double d)
                   throws JSONException
Append a double value.

Parameters:
d - A double.
Returns:
this
Throws:
JSONException - If the number is not finite.

value

public JSONStringer value(long l)
                   throws JSONException
Append a long value.

Parameters:
l - A long.
Returns:
this
Throws:
JSONException

value

public JSONStringer value(Object o)
                   throws JSONException
Append an object value.

Parameters:
o - The object to append. It can be null, or a Boolean, Number, String, JSONObject, or JSONArray.
Returns:
this
Throws:
JSONException - If the value is out of sequence.

toString

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

Overrides:
toString in class Object
Returns:
The JSON text.

Build 1.0_r1(from source)

Please submit a feedback, bug or feature