JSONStringer

Class Overview

Implements toString() and toString(). Most application developers should use those methods directly and disregard this API. For example:

 JSONObject object = ... String json = object.toString(); Stringers only
 encode well-formed JSON strings. In particular:
 

• The stringer must have exactly one top-level array or object.
• Lexical scopes must be balanced: every call to array() must have a matching call to endArray() and every call to object() must have a matching call to endObject().
• Arrays may not contain keys (property names).
• Objects must alternate keys (property names) and values.
• Values are inserted with either literal value calls, or by nesting arrays or objects.

Calls that would result in a malformed JSON string will fail with a JSONException. This class provides no facility for pretty-printing (ie. indenting) output. To encode indented output, use toString(int) or toString(int).

Some implementations of the API support at most 20 levels of nesting. Attempts to create more than 20 levels of nesting may fail with a JSONException.

Each stringer may be used to encode a single top level value. Instances of this class are not thread safe. Although this class is nonfinal, it was not designed for inheritance and should not be subclassed. In particular, self-use by overrideable methods is not specified. See Effective Java Item 17, "Design and Document or inheritance or else prohibit it" for further information.

Summary

Public Constructors
	JSONStringer()

Public Methods
JSONStringer	array() Begins encoding a new array.
JSONStringer	endArray() Ends encoding the current array.
JSONStringer	endObject() Ends encoding the current object.
JSONStringer	key(String name) Encodes the key (property name) to this stringer.
JSONStringer	object() Begins encoding a new object.
String	toString() Returns the encoded JSON string.
JSONStringer	value(long value) Encodes value to this stringer.
JSONStringer	value(double value) Encodes value to this stringer.
JSONStringer	value(boolean value) Encodes value to this stringer.
JSONStringer	value(Object value) Encodes value.

[Expand] Inherited Methods

From class java.lang.Object boolean equals(Object obj) Indicates whether some other object is "equal to" this one. final Class<?> getClass() Returns the runtime class of an object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.