net.sf.json
Interface JSON

All Superinterfaces:

Serializable

All Known Implementing Classes:

JSONArray, JSONNull, JSONObject

public interface JSON
extends Serializable

Marker interface, identifies a valid JSON value.
A JSON value may be a JSONObject, a JSONArray or a JSONNull.

Author:

Andres Almiray

Method Summary

boolean	isArray() Returns true if this object is a JSONArray, false otherwise.
boolean	isEmpty() Returns true if this object has no elements or keys.
int	size() Returns the number of properties in an object or the size of the array.
String	toString(int indentFactor) Make a prettyprinted JSON text.
String	toString(int indentFactor, int indent) Make a prettyprinted JSON text.
Writer	write(Writer writer) Write the contents as JSON text to a writer.

Method Detail

isArray

boolean isArray()

Returns true if this object is a JSONArray, false otherwise.

isEmpty

boolean isEmpty()

Returns true if this object has no elements or keys.

Throws:

JSONException - if called on a 'null' object

size

int size()

Returns the number of properties in an object or the size of the array.

Returns:

the size of an json object or array

Throws:

JSONException - if called on a 'null' object

toString

String toString(int indentFactor)

Make a prettyprinted JSON text.

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

Throws:

JSONException - If the object contains an invalid number.

toString

String toString(int indentFactor,
                int indent)

Make a prettyprinted JSON text.

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:

JSONException - If the object contains an invalid number.

write

Writer write(Writer writer)

Write the contents 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:

JSONException