org.yuanheng.cookjson

Class TextJsonGenerator

java.lang.Object

org.yuanheng.cookjson.TextJsonGenerator

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, JsonGenerator, CookJsonGenerator

Direct Known Subclasses:

PrettyTextJsonGenerator

public class TextJsonGenerator
extends Object
implements CookJsonGenerator

This is a straightforward implementation of text based JSON output in space saving format. For nicely indented format, use PrettyTextJsonGenerator.

Author:

Heng Yuan

Field Summary

Fields inherited from interface javax.json.stream.JsonGenerator

PRETTY_PRINTING

Constructor Summary

Constructors

Constructor and Description
TextJsonGenerator(OutputStream os)
TextJsonGenerator(Writer out)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
int	getBinaryFormat() Gets the binary format for storing byte[].
boolean	isKeyNameEscaped() Check if key name is escaped.
void	setBinaryFormat(int binaryFormat) Sets the binary format for storing byte[].
void	setKeyNameEscaped(boolean b) By default, key name is escaped.
JsonGenerator	write(BigDecimal value)
JsonGenerator	write(BigInteger value)
JsonGenerator	write(boolean value)
JsonGenerator	write(byte[] value) Writes the specified data as a binary value within the current array context.
JsonGenerator	write(double value)
JsonGenerator	write(int value)
JsonGenerator	write(JsonValue value)
JsonGenerator	write(long value)
JsonGenerator	write(String value)
JsonGenerator	write(String name, BigDecimal value)
JsonGenerator	write(String name, BigInteger value)
JsonGenerator	write(String name, boolean value)
JsonGenerator	write(String name, byte[] value) Writes the specified data as a binary value within the current object context.
JsonGenerator	write(String name, double value)
JsonGenerator	write(String name, int value)
JsonGenerator	write(String name, JsonValue value)
JsonGenerator	write(String name, long value)
JsonGenerator	write(String name, String value)
JsonGenerator	writeEnd()
JsonGenerator	writeNull()
JsonGenerator	writeNull(String name)
JsonGenerator	writeStartArray()
JsonGenerator	writeStartArray(String name)
JsonGenerator	writeStartObject()
JsonGenerator	writeStartObject(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextJsonGenerator

public TextJsonGenerator(OutputStream os)

TextJsonGenerator

public TextJsonGenerator(Writer out)

Method Detail

writeStartObject

public JsonGenerator writeStartObject()

Specified by:

writeStartObject in interface JsonGenerator

writeStartObject

public JsonGenerator writeStartObject(String name)

Specified by:

writeStartObject in interface JsonGenerator

writeStartArray

public JsonGenerator writeStartArray()

Specified by:

writeStartArray in interface JsonGenerator

writeStartArray

public JsonGenerator writeStartArray(String name)

Specified by:

writeStartArray in interface JsonGenerator

write

public JsonGenerator write(String name,
                           JsonValue value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           byte[] value)

Description copied from interface: CookJsonGenerator

Writes the specified data as a binary value within the current object context. Depends on the implementation, it can be written as binary, or as Base64 / Hexadecimal strings.

Specified by:

write in interface CookJsonGenerator

Parameters:

name - the key name.

value - a binary data to be written

Returns:

this.

See Also:

CookJsonBinary

write

public JsonGenerator write(String name,
                           String value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           BigInteger value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           BigDecimal value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           int value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           long value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           double value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(String name,
                           boolean value)

Specified by:

write in interface JsonGenerator

writeNull

public JsonGenerator writeNull(String name)

Specified by:

writeNull in interface JsonGenerator

writeEnd

public JsonGenerator writeEnd()

Specified by:

writeEnd in interface JsonGenerator

write

public JsonGenerator write(JsonValue value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(byte[] value)

Description copied from interface: CookJsonGenerator

Writes the specified data as a binary value within the current array context. Depends on the implementation, it can be written as binary, or as Base64 / Hexadecimal strings.

Specified by:

write in interface CookJsonGenerator

Parameters:

value - a binary data to be written

Returns:

this.

See Also:

CookJsonBinary

write

public JsonGenerator write(String value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(BigDecimal value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(BigInteger value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(int value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(long value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(double value)

Specified by:

write in interface JsonGenerator

write

public JsonGenerator write(boolean value)

Specified by:

write in interface JsonGenerator

writeNull

public JsonGenerator writeNull()

Specified by:

writeNull in interface JsonGenerator

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JsonGenerator

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in interface JsonGenerator

isKeyNameEscaped

public boolean isKeyNameEscaped()

Check if key name is escaped.

Returns:

true if key name is escaped. false otherwise.

setKeyNameEscaped

public void setKeyNameEscaped(boolean b)

By default, key name is escaped. However, if you know the name is safe (or pre-escaped), you can avoid having them escaped.

This is useful in certain situations where the same key names were repeatedly used. Such as exporting data to JSON from JDBC ResultSet.

Parameters:

b - true if the key name should be escaped. false otherwise.

getBinaryFormat

public int getBinaryFormat()

Gets the binary format for storing byte[].

It is one of BinaryFormat.BINARY_FORMAT_BASE64 and BinaryFormat.BINARY_FORMAT_HEX.

Returns:

the binaryFormat

setBinaryFormat

public void setBinaryFormat(int binaryFormat)

Sets the binary format for storing byte[]. The default is Base64.

It is one of BinaryFormat.BINARY_FORMAT_BASE64 and BinaryFormat.BINARY_FORMAT_HEX.

Parameters:

binaryFormat - the binary format