Package com.aspectran.core.util.json

Class JsonWriter

java.lang.Object

com.aspectran.core.util.json.JsonWriter

All Implemented Interfaces:

java.io.Flushable

Direct Known Subclasses:

ContentsJsonWriter

public class JsonWriter
extends java.lang.Object
implements java.io.Flushable

Converts an object to a JSON formatted string. If pretty-printing is enabled, includes spaces, tabs and new-lines to make the format more readable. Pretty-printing is disabled by default. The default indentation string is a tab character.

Created: 2008. 06. 12 PM 8:20:54

Author:

Juho Jeong

Constructor Summary

Constructors

Constructor	Description
JsonWriter(java.io.Writer writer)	Instantiates a new JsonWriter.
JsonWriter(java.io.Writer writer, boolean prettyPrint)	Instantiates a new JsonWriter.
JsonWriter(java.io.Writer writer, java.lang.String indentString)	Instantiates a new JsonWriter.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the writer.
protected void	closeCurlyBracket()	Close brace.
protected void	closeSquareBracket()	Close square bracket.
void	flush()
protected void	indent()	Write a tab character to a character stream.
protected void	nextLine()	Write a new line character to a character stream.
protected void	openCurlyBracket()	Open brace.
protected void	openSquareBracket()	Open square bracket.
static java.lang.String	stringify(java.lang.Object object)	Converts an object to a JSON formatted string.
static java.lang.String	stringify(java.lang.Object object, boolean prettyPrint)	Converts an object to a JSON formatted string.
static java.lang.String	stringify(java.lang.Object object, java.lang.String indentString)	Converts an object to a JSON formatted string.
void	write(java.lang.Object object)	Write an object to a character stream.
protected void	writeBoolean(java.lang.Boolean value)	Writes a Boolean object to a character stream.
protected void	writeComma()	Write a comma character to a character stream.
protected void	writeName(java.lang.String name)	Writes a key name to a character stream.
protected void	writeNull()	Write a string "null" to a character stream.
protected void	writeNumber(java.lang.Number value)	Writes a Number object to a character stream.
protected void	writeString(java.lang.String value)	Writes a string to a character stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonWriter

public JsonWriter(java.io.Writer writer)

Instantiates a new JsonWriter. Pretty-printing is disabled by default.

Parameters:

writer - the character-output stream

JsonWriter

public JsonWriter(java.io.Writer writer,
                  boolean prettyPrint)

Instantiates a new JsonWriter. If pretty-printing is enabled, includes spaces, tabs and new-lines to make the format more readable. The default indentation string is a tab character.

Parameters:

writer - the character-output stream

prettyPrint - enables or disables pretty-printing

JsonWriter

public JsonWriter(java.io.Writer writer,
                  java.lang.String indentString)

Instantiates a new JsonWriter. If pretty-printing is enabled, includes spaces, tabs and new-lines to make the format more readable.

Parameters:

writer - the character-output stream

indentString - the string that should be used for indentation when pretty-printing is enabled

Method Detail

write

public void write(java.lang.Object object)
           throws java.io.IOException,
                  java.lang.reflect.InvocationTargetException

Write an object to a character stream.

Parameters:

object - the object to write to a character-output stream.

Throws:

java.io.IOException - an I/O error occurs.

java.lang.reflect.InvocationTargetException - the invocation target exception

indent

protected void indent()
               throws java.io.IOException

Write a tab character to a character stream.

Throws:

java.io.IOException - an I/O error occurs

writeName

protected void writeName(java.lang.String name)
                  throws java.io.IOException

Writes a key name to a character stream.

Parameters:

name - the string to write to a character-output stream

Throws:

java.io.IOException - an I/O error occurs

writeString

protected void writeString(java.lang.String value)
                    throws java.io.IOException

Writes a string to a character stream. If value is null, write a null string ("").

Parameters:

value - the string to write to a character-output stream

Throws:

java.io.IOException - an I/O error occurs

writeBoolean

protected void writeBoolean(java.lang.Boolean value)
                     throws java.io.IOException

Writes a Boolean object to a character stream.

Parameters:

value - a Boolean object to write to a character-output stream

Throws:

java.io.IOException - an I/O error occurs

writeNumber

protected void writeNumber(java.lang.Number value)
                    throws java.io.IOException

Writes a Number object to a character stream.

Parameters:

value - a Number object to write to a character-output stream

Throws:

java.io.IOException - an I/O error occurs

writeNull

protected void writeNull()
                  throws java.io.IOException

Write a string "null" to a character stream.

Throws:

java.io.IOException - an I/O error occurs

writeComma

protected void writeComma()
                   throws java.io.IOException

Write a comma character to a character stream.

Throws:

java.io.IOException - an I/O error occurs

nextLine

protected void nextLine()
                 throws java.io.IOException

Write a new line character to a character stream.

Throws:

java.io.IOException - an I/O error occurs

openCurlyBracket

protected void openCurlyBracket()
                         throws java.io.IOException

Open brace.

Throws:

java.io.IOException - an I/O error occurs

closeCurlyBracket

protected void closeCurlyBracket()
                          throws java.io.IOException

Close brace.

Throws:

java.io.IOException - an I/O error occurs

openSquareBracket

protected void openSquareBracket()
                          throws java.io.IOException

Open square bracket.

Throws:

java.io.IOException - an I/O error occurs

closeSquareBracket

protected void closeSquareBracket()
                           throws java.io.IOException

Close square bracket.

Throws:

java.io.IOException - an I/O error occurs

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes the writer.

Throws:

java.io.IOException - an I/O error occurs

stringify

public static java.lang.String stringify(java.lang.Object object)

Converts an object to a JSON formatted string. Pretty-printing is disabled by default.

Parameters:

object - an object to convert to a JSON formatted string

Returns:

the JSON formatted string

stringify

public static java.lang.String stringify(java.lang.Object object,
                                         boolean prettyPrint)

Converts an object to a JSON formatted string. If pretty-printing is enabled, includes spaces, tabs and new-lines to make the format more readable. The default indentation string is a tab character.

Parameters:

object - an object to convert to a JSON formatted string

prettyPrint - enables or disables pretty-printing

Returns:

the JSON formatted string

stringify

public static java.lang.String stringify(java.lang.Object object,
                                         java.lang.String indentString)

Converts an object to a JSON formatted string. If pretty-printing is enabled, includes spaces, tabs and new-lines to make the format more readable.

Parameters:

object - an object to convert to a JSON formatted string

indentString - the string that should be used for indentation when pretty-printing is enabled

Returns:

the JSON formatted string