org.json.write

Class WriterUtil

java.lang.Object

org.json.write.WriterUtil

public final class WriterUtil
extends java.lang.Object

Static writer methods.

Method Summary

Modifier and Type	Method and Description
static boolean	isSimpleValue(java.lang.Object value) Is this value a simple value for the purposes of writing a JSON structure.
static void	writeBoolean(boolean value, java.lang.Appendable writer) Write the given boolean to the given Appendable.
static void	writeBoolean(java.lang.Boolean value, java.lang.Appendable writer) Write the given Boolean to the given Appendable.
static void	writeDouble(double d, java.lang.Appendable writer) Write the given double to the given Appendable.
static void	writeEnum(java.lang.Enum<?> value, java.lang.Appendable writer) Write the given Enum to the given Appendable as a String.
static void	writeJSONAppendable(JSONAppendable value, java.lang.Appendable writer) Write the JSONAppendable as a JSON value to a writer.
static void	writeJSONString(JSONString value, java.lang.Appendable writer) Write the contents of the JSONString as a JSON value to a writer.
static void	writeLong(long number, java.lang.Appendable writer) Write the given long to the given Appendable.
static void	writeNull(java.lang.Appendable writer) Write the value null to the given Appendable.
static void	writeNumber(java.lang.Number number, java.lang.Appendable writer) Write the given Number to the given Appendable.
static void	writeSimpleValue(java.lang.Object value, java.lang.Appendable writer) Write the contents of the Object as JSON text to a writer.
static void	writeString(java.lang.CharSequence string, java.lang.Appendable w) Produce a string in double quotes with backslash sequences in all the right places.

Methods inherited from class java.lang.Object

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

Method Detail

isSimpleValue

public static boolean isSimpleValue(java.lang.Object value)

Is this value a simple value for the purposes of writing a JSON structure.

Parameters:

value - the Object value to be tested

Returns:

true if this value is a simple JSON value, otherwise false

writeSimpleValue

public static void writeSimpleValue(java.lang.Object value,
                                    java.lang.Appendable writer)
                             throws JSONException

Write the contents of the Object as JSON text to a writer.

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

Parameters:

value - The value to be written

writer - Writes the serialized JSON

Throws:

JSONException - there was a problem writing the Object

writeJSONAppendable

public static void writeJSONAppendable(JSONAppendable value,
                                       java.lang.Appendable writer)
                                throws JSONException

Write the JSONAppendable as a JSON value to a writer.

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

Parameters:

value - The JSONAppendable to be written

writer - Writes the serialized JSON

Throws:

JSONException - there was a problem writing the JSONAppendable

writeJSONString

public static void writeJSONString(JSONString value,
                                   java.lang.Appendable writer)
                            throws JSONException

Write the contents of the JSONString as a JSON value to a writer.

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

Parameters:

value - The JSONString to be written

writer - Writes the serialized JSON

Throws:

JSONException - there was a problem writing the JSONString

writeEnum

public static void writeEnum(java.lang.Enum<?> value,
                             java.lang.Appendable writer)
                      throws JSONException

Write the given Enum to the given Appendable as a String.

Parameters:

value - An Enum

writer - The Appendable to which the Enum value is written

Throws:

JSONException - there was a problem writing the Enum

writeString

public static void writeString(java.lang.CharSequence string,
                               java.lang.Appendable w)
                        throws JSONException

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 character sequence to be quoted

w - the Appendable to which the quoted character sequence will be written

Throws:

JSONException - there was a problem writing to the Appendable

writeDouble

public static void writeDouble(double d,
                               java.lang.Appendable writer)
                        throws JSONException

Write the given double to the given Appendable.

Parameters:

d - A double

writer - The Appendable to which the double value is written

Throws:

JSONException - there was a problem writing the double

writeLong

public static void writeLong(long number,
                             java.lang.Appendable writer)
                      throws JSONException

Write the given long to the given Appendable.

Parameters:

number - A long

writer - The Appendable to which the number value is written

Throws:

JSONException - there was a problem writing the long

writeNumber

public static void writeNumber(java.lang.Number number,
                               java.lang.Appendable writer)
                        throws JSONException

Write the given Number to the given Appendable.

Parameters:

number - A Number

writer - The Appendable to which the number value is written

Throws:

JSONException - there was a problem writing the Number

writeBoolean

public static void writeBoolean(java.lang.Boolean value,
                                java.lang.Appendable writer)
                         throws JSONException

Write the given Boolean to the given Appendable.

Parameters:

value - A Boolean

writer - The Appendable to which the boolean value is written

Throws:

JSONException - there was a problem writing the Boolean

writeBoolean

public static void writeBoolean(boolean value,
                                java.lang.Appendable writer)
                         throws JSONException

Write the given boolean to the given Appendable.

Parameters:

value - A boolean

writer - The Appendable to which the boolean value is written

Throws:

JSONException - there was a problem writing the boolean

writeNull

public static void writeNull(java.lang.Appendable writer)
                      throws JSONException

Write the value null to the given Appendable.

Parameters:

writer - The Appendable to which the null value is written

Throws:

JSONException - there was a problem writing null