org.json

Class JSONComponents

java.lang.Object

org.json.JSONComponents

public class JSONComponents
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JSONComponents()

Method Summary

Modifier and Type	Method and Description
static void	escapeChars(java.lang.String string, java.lang.Appendable buf) Append a string with backslash sequences in all the right places.
static java.lang.String	numberToString(java.lang.Number number) Produce a string from a Number.
static java.lang.String	quote(java.lang.String string) Produce a string in double quotes with backslash sequences in all the right places.
static void	quote(java.lang.String string, java.lang.Appendable buf)
static java.lang.Object	stringToValue(java.lang.String string) Try to convert a string into a number, boolean, or null.
static void	testValidity(java.lang.Object o) Throw an exception if the object is a NaN or infinite number.
static java.lang.String	valueToString(java.lang.Object value) Make a JSON text of an Object value.
static void	writeValue(java.lang.Object value, java.lang.Appendable buf)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONComponents

public JSONComponents()

Method Detail

escapeChars

public static void escapeChars(java.lang.String string,
                               java.lang.Appendable buf)
                        throws java.io.IOException

Append a string with backslash sequences in all the right places. A backslash will be inserted within </, producing <\/, allowing JSON text to be delivered in HTML. In JSON text, a string cannot contain a control character or an unescaped quote or backslash.

Parameters:

string - A String

buf - The Appendable that the escaped String will be appended onto.

Throws:

java.io.IOException - if it is not possible to write to the buf

stringToValue

public static java.lang.Object stringToValue(java.lang.String string)

Try to convert a string into a number, boolean, or null. If the string can't be converted, return the string.

Parameters:

string - A String.

Returns:

A simple JSON value.

quote

public static java.lang.String quote(java.lang.String string)

Produce a string in double quotes with backslash sequences in all the right places. A backslash will be inserted within </, producing <\/, allowing JSON text to be delivered in HTML. In JSON text, a string cannot contain a control character or an unescaped quote or backslash.

Parameters:

string - A String

Returns:

A String correctly formatted for insertion in a JSON text.

quote

public static void quote(java.lang.String string,
                         java.lang.Appendable buf)
                  throws java.io.IOException

Throws:

java.io.IOException

testValidity

public static void testValidity(java.lang.Object o)
                         throws JSONRuntimeException

Throw an exception if the object is a NaN or infinite number.

Parameters:

o - The object to test.

Throws:

JSONRuntimeException - If o is a non-finite number.

numberToString

public static java.lang.String numberToString(java.lang.Number number)
                                       throws JSONRuntimeException

Produce a string from a Number.

Parameters:

number - A Number

Returns:

A String.

Throws:

JSONRuntimeException - If n is a non-finite number.

valueToString

public static java.lang.String valueToString(java.lang.Object value)

Make a JSON text of an Object value. If the object has an value.toJSONString() method, then that method will be used to produce the JSON text. The method is required to produce a strictly conforming text. If the object does not contain a toJSONString method (which is the most common case), then a text will be produced by other means. If the value is an array or Collection, then a JSONArray will be made from it and its toJSONString method will be called. If the value is a MAP, then a JSONObject will be made from it and its toJSONString method will be called. Otherwise, the value's toString method will be called, and the result will be quoted.

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

Parameters:

value - The value to be serialized.

Returns:

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

Throws:

JSONRuntimeException - If the value is or contains an invalid number.

writeValue

public static void writeValue(java.lang.Object value,
                              java.lang.Appendable buf)
                       throws java.io.IOException

Throws:

java.io.IOException