net.sf.mpxj.json

Class JsonStreamWriter

java.lang.Object

net.sf.mpxj.json.JsonStreamWriter

public class JsonStreamWriter
extends Object

Writes JSON data to an output stream.

Constructor Summary

Constructors

Constructor and Description
JsonStreamWriter(OutputStream stream, Charset encoding) Constructor.

Method Summary

Modifier and Type	Method and Description
void	flush() Flush the output stream.
boolean	getPretty() Retrieve the pretty-print flag.
void	setPretty(boolean pretty) Set the pretty-print flag.
void	writeEndList() End writing a list.
void	writeEndObject() End writing an object.
void	writeList(String name, List<Object> values) Write a named list attribute containing simple values.
void	writeNameValuePair(String name, boolean value) Write a boolean attribute.
void	writeNameValuePair(String name, double value) Write a double attribute.
void	writeNameValuePair(String name, int value) Write an int attribute.
void	writeNameValuePair(String name, LocalDateTime value) Write a Date attribute as a timestamp.
void	writeNameValuePair(String name, long value) Write a long attribute.
void	writeNameValuePair(String name, String value) Write a string attribute.
void	writeNameValuePairAsDate(String name, LocalDate value) Write a date attribute.
void	writeNameValuePairAsTime(String name, LocalTime value) Write a time attribute.
void	writeStartList(String name) Begin writing a named list attribute.
void	writeStartObject(String name) Begin writing a named object attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonStreamWriter

public JsonStreamWriter(OutputStream stream,
                        Charset encoding)

Constructor.

Parameters:

stream - target output stream

encoding - target encoding

Method Detail

getPretty

public boolean getPretty()

Retrieve the pretty-print flag.

Returns:

true if pretty printing is enabled

setPretty

public void setPretty(boolean pretty)

Set the pretty-print flag.

Parameters:

pretty - true if pretty printing is enabled

flush

public void flush()
           throws IOException

Flush the output stream.

Throws:

IOException

writeStartObject

public void writeStartObject(String name)
                      throws IOException

Begin writing a named object attribute.

Parameters:

name - attribute name

Throws:

IOException

writeList

public void writeList(String name,
                      List<Object> values)
               throws IOException

Write a named list attribute containing simple values.

Parameters:

name - attribute name

values - list of attribute values

Throws:

IOException

writeStartList

public void writeStartList(String name)
                    throws IOException

Begin writing a named list attribute.

Parameters:

name - attribute name

Throws:

IOException

writeEndObject

public void writeEndObject()
                    throws IOException

End writing an object.

Throws:

IOException

writeEndList

public void writeEndList()
                  throws IOException

End writing a list.

Throws:

IOException

writeNameValuePair

public void writeNameValuePair(String name,
                               String value)
                        throws IOException

Write a string attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePair

public void writeNameValuePair(String name,
                               int value)
                        throws IOException

Write an int attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePair

public void writeNameValuePair(String name,
                               long value)
                        throws IOException

Write a long attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePair

public void writeNameValuePair(String name,
                               double value)
                        throws IOException

Write a double attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePair

public void writeNameValuePair(String name,
                               boolean value)
                        throws IOException

Write a boolean attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePair

public void writeNameValuePair(String name,
                               LocalDateTime value)
                        throws IOException

Write a Date attribute as a timestamp.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePairAsDate

public void writeNameValuePairAsDate(String name,
                                     LocalDate value)
                              throws IOException

Write a date attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException

writeNameValuePairAsTime

public void writeNameValuePairAsTime(String name,
                                     LocalTime value)
                              throws IOException

Write a time attribute.

Parameters:

name - attribute name

value - attribute value

Throws:

IOException