org.json.write

Interface StructureWriter

All Superinterfaces:

StructureIdentifier

All Known Implementing Classes:

NullStructureWriter, SimpleStructureWriter

public interface StructureWriter
extends StructureIdentifier

Strategy interface for writing a JSON structure, either a JSON Object or a JSON Array. A strategy class can implement a compact or a pretty-print output.

Method Summary

Modifier and Type	Method and Description
void	beginStructure(java.lang.Appendable writer) Begin the structure represented by this object, either a JSON Object or a JSON Array.
boolean	booleanValue(boolean value, java.lang.Appendable writer) Write a boolean value to the given Appendable.
boolean	doubleValue(double value, java.lang.Appendable writer) Write a double value to the given Appendable.
boolean	endStructure(java.lang.Appendable writer) End the structure represented by this object, either a JSON Object or a JSON Array.
char	getStructureType() Returns the type of this structure as a char value.
boolean	jsonAppendableValue(JSONAppendable value, java.lang.Appendable writer) Write a JSONAppendable value to the given Appendable.
boolean	jsonStringValue(JSONString value, java.lang.Appendable writer) Write a JSONString value to the given Appendable.
void	key(java.lang.String key, java.lang.Appendable writer) Write a key for a JSON Object.
boolean	longValue(long value, java.lang.Appendable writer) Write a long value to the given Appendable.
boolean	nullValue(java.lang.Appendable writer) Write a JSON null value to the given Appendable.
boolean	simpleValue(java.lang.Object value, java.lang.Appendable writer) Write a simple value to the given Appendable.
void	subValue(java.lang.Appendable writer) Indicates that a sub-structure is about to be written.

Methods inherited from interface org.json.util.StructureIdentifier

getIdentifier

Method Detail

beginStructure

void beginStructure(java.lang.Appendable writer)
             throws JSONException

Begin the structure represented by this object, either a JSON Object or a JSON Array.

Parameters:

writer - the Appendable to write any beginning structure content

Throws:

JSONException - there was a problem beginning the structure

key

void key(java.lang.String key,
         java.lang.Appendable writer)
  throws JSONException

Write a key for a JSON Object.

Parameters:

key - the key to be written

writer - the Appendable to write the key

Throws:

JSONException - this structure is not a JSON Object, the key is null, or there was another problem writing the key

subValue

void subValue(java.lang.Appendable writer)
       throws JSONException

Indicates that a sub-structure is about to be written. Write any JSON content necessary prior to beginning the sub-structure.

Parameters:

writer - the Appendable to write any delimiters or separators

Throws:

JSONException - there was a problem writing the delimiter

simpleValue

boolean simpleValue(java.lang.Object value,
                    java.lang.Appendable writer)
             throws JSONException

Write a simple value to the given Appendable.

Parameters:

value - the value to be written

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

See Also:

WriterUtil.isSimpleValue(Object)

jsonStringValue

boolean jsonStringValue(JSONString value,
                        java.lang.Appendable writer)
                 throws JSONException

Write a JSONString value to the given Appendable.

Parameters:

value - the value to be written

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

jsonAppendableValue

boolean jsonAppendableValue(JSONAppendable value,
                            java.lang.Appendable writer)
                     throws JSONException

Write a JSONAppendable value to the given Appendable.

Parameters:

value - the value to be written

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

nullValue

boolean nullValue(java.lang.Appendable writer)
           throws JSONException

Write a JSON null value to the given Appendable.

Parameters:

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

booleanValue

boolean booleanValue(boolean value,
                     java.lang.Appendable writer)
              throws JSONException

Write a boolean value to the given Appendable.

Parameters:

value - the value to be written

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

doubleValue

boolean doubleValue(double value,
                    java.lang.Appendable writer)
             throws JSONException

Write a double value to the given Appendable.

Parameters:

value - the value to be written

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

longValue

boolean longValue(long value,
                  java.lang.Appendable writer)
           throws JSONException

Write a long value to the given Appendable.

Parameters:

value - the value to be written

writer - the Appendable to which the JSON value will be written

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem writing the value

endStructure

boolean endStructure(java.lang.Appendable writer)
              throws JSONException

End the structure represented by this object, either a JSON Object or a JSON Array.

Parameters:

writer - the Appendable to write any end structure content

Returns:

true to indicate JSON writing has been completed, and no more content may be written, otherwise false to indicate more JSON data may be written

Throws:

JSONException - there was a problem ending the structure

getStructureType

char getStructureType()

Returns the type of this structure as a char value. The values, by convention, are:

• 'i' — the initial structure, before any JSON Object or JSON Array has been written
• 'o' — a JSON Object
• 'a' — a JSON Array

Returns:

the type of this structure, as a char value