org.json

Interface JSONComponent

All Known Subinterfaces:

JSONArray, JSONObject

All Known Implementing Classes:

AbstractUnmodifiableJSONObject, ImmutableJSONArray, ImmutableJSONObject, ListBasedJSONArray, MapBasedJSONObject, UnmodifiableJSONArray, UnmodifiableJSONObject, WritableJSONArray, WritableJSONObject

public interface JSONComponent

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() Make a JSON text of this JSONObject.
java.lang.String	toString(int indentFactor) Make a prettyprinted JSON text of this JSONObject.
java.lang.String	toString(int indentFactor, int indent) Make a prettyprinted JSON text of this JSONObject.
java.lang.Appendable	write(java.lang.Appendable writer) Write the contents of the JSONComponent as JSON text to a writer.

Method Detail

toString

java.lang.String toString()

Make a JSON text of this JSONObject. For compactness, no whitespace is added. If this would not result in a syntactically correct JSON text, then null will be returned instead.

Warning: This method assumes that the data structure is acyclical.

Overrides:

toString in class java.lang.Object

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

toString

java.lang.String toString(int indentFactor)

Make a prettyprinted JSON text of this JSONObject.

Warning: This method assumes that the data structure is acyclical.

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

toString

java.lang.String toString(int indentFactor,
                          int indent)

Make a prettyprinted JSON text of this JSONObject.

Warning: This method assumes that the data structure is acyclical.

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

indent - The indentation of the top level.

Returns:

a printable, displayable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

Throws:

java.lang.RuntimeException - If the object contains an invalid number.

write

java.lang.Appendable write(java.lang.Appendable writer)
                    throws java.io.IOException

Write the contents of the JSONComponent as JSON text to a writer. For compactness, no whitespace is added.

Warning: This method assumes that the data structure is acyclical.

Returns:

The writer.

Throws:

java.io.IOException