org.json.write

Class SimpleStructureWriter

java.lang.Object

org.json.write.SimpleStructureWriter

All Implemented Interfaces:

StructureIdentifier, StructureWriter

public final class SimpleStructureWriter
extends java.lang.Object
implements StructureWriter

Initial structure writer for when a JSONWriter is only writing a simple value.

Method Summary

Modifier and Type	Method and Description
void	beginStructure(java.lang.Appendable writer) Throws a JSONException to indicate this writer can't write a structure itself.
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) Throws a JSONException to indicate this writer can't write an end structure.
java.lang.String	getIdentifier() Returns null for no identifier.
static SimpleStructureWriter	getInstance(int indent) Factory method for SimpleStructureWriter.
char	getStructureType() Returns 'i' to indicate the initial structure.
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) Throws a JSONException to indicate this writer can't write a key.
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) This method does nothing itself, but allows a sub-structure to be written.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SimpleStructureWriter getInstance(int indent)

Factory method for SimpleStructureWriter. Simplifies to a singleton instance if the given indent level is zero.

Parameters:

indent - the indent level for the simple value

Returns:

a SimpleStructureWriter

beginStructure

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

Throws a JSONException to indicate this writer can't write a structure itself.

Specified by:

beginStructure in interface StructureWriter

Parameters:

writer - the Appendable to write any beginning structure content

Throws:

JSONException - no structure can be written by this writer

key

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

Throws a JSONException to indicate this writer can't write a key.

Specified by:

key in interface StructureWriter

Parameters:

key - the key to be written

writer - the Appendable to write the key

Throws:

JSONException - no key can be written by this writer

subValue

public void subValue(java.lang.Appendable writer)

This method does nothing itself, but allows a sub-structure to be written.

Specified by:

subValue in interface StructureWriter

Parameters:

writer - the Appendable to write any delimiters or separators

simpleValue

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

Write a simple value to the given Appendable.

Specified by:

simpleValue in interface StructureWriter

Parameters:

value - the value to be written

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

See Also:

WriterUtil.isSimpleValue(Object)

jsonStringValue

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

Write a JSONString value to the given Appendable.

Specified by:

jsonStringValue in interface StructureWriter

Parameters:

value - the value to be written

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

jsonAppendableValue

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

Write a JSONAppendable value to the given Appendable.

Specified by:

jsonAppendableValue in interface StructureWriter

Parameters:

value - the value to be written

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

nullValue

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

Write a JSON null value to the given Appendable.

Specified by:

nullValue in interface StructureWriter

Parameters:

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

booleanValue

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

Write a boolean value to the given Appendable.

Specified by:

booleanValue in interface StructureWriter

Parameters:

value - the value to be written

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

doubleValue

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

Write a double value to the given Appendable.

Specified by:

doubleValue in interface StructureWriter

Parameters:

value - the value to be written

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

longValue

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

Write a long value to the given Appendable.

Specified by:

longValue in interface StructureWriter

Parameters:

value - the value to be written

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

Returns:

true to indicate JSON writing is complete

Throws:

JSONException - there was a problem writing the value

endStructure

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

Throws a JSONException to indicate this writer can't write an end structure.

Specified by:

endStructure in interface StructureWriter

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 - no end structure can be written by this writer

getIdentifier

public java.lang.String getIdentifier()

Returns null for no identifier.

Specified by:

getIdentifier in interface StructureIdentifier

Returns:

null

See Also:

JSONPointerUtils.toJSONPointer(Iterable)

getStructureType

public char getStructureType()

Returns 'i' to indicate the initial structure.

Specified by:

getStructureType in interface StructureWriter

Returns:

the type of this structure, as a char value