Module jakarta.json

Package org.glassfish.json

Class JsonPrettyGeneratorImpl

java.lang.Object

org.glassfish.json.JsonPrettyGeneratorImpl

All Implemented Interfaces:

JsonGenerator, Closeable, Flushable, AutoCloseable

public class JsonPrettyGeneratorImpl
extends Object

Author:

Jitendra Kotamraju

Field Summary

Fields inherited from interface jakarta.json.stream.JsonGenerator

PRETTY_PRINTING

Constructor Summary

Constructors

Constructor	Description
JsonPrettyGeneratorImpl(OutputStream out, Charset encoding, BufferPool bufferPool)
JsonPrettyGeneratorImpl(OutputStream out, BufferPool bufferPool)
JsonPrettyGeneratorImpl(Writer writer, BufferPool bufferPool)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this generator and frees any resources associated with it.
void	flush()	Flushes the underlying output source.
protected boolean	inNone()
JsonGenerator	write(boolean value)	Writes a JSON true or false value within the current array, field or root context.
JsonGenerator	write(double value)	Writes the specified value as a JSON number value within the current array, field or root context.
JsonGenerator	write(int value)	Writes the specified value as a JSON number value within the current array, field or root context.
JsonGenerator	write(long value)	Writes the specified value as a JSON number value within the current array, field or root context.
JsonGenerator	write(JsonValue value)	Writes the specified value as a JSON value within the current array, field or root context.
JsonGenerator	write(String value)	Writes the specified value as a JSON string value within the current array, field or root context.
JsonGenerator	write(String name, boolean value)	Writes a JSON name/boolean value pair in the current object context.
JsonGenerator	write(String name, double value)	Writes a JSON name/number value pair in the current object context.
JsonGenerator	write(String name, int value)	Writes a JSON name/number value pair in the current object context.
JsonGenerator	write(String name, long value)	Writes a JSON name/number value pair in the current object context.
JsonGenerator	write(String name, JsonValue value)	Writes a JSON name/value pair in the current object context.
JsonGenerator	write(String name, String fieldValue)	Writes a JSON name/string value pair in the current object context.
JsonGenerator	write(String name, BigDecimal value)	Writes a JSON name/number value pair in the current object context.
JsonGenerator	write(String name, BigInteger value)	Writes a JSON name/number value pair in the current object context.
JsonGenerator	write(BigDecimal value)	Writes the specified value as a JSON number value within the current array, field or root context.
JsonGenerator	write(BigInteger value)	Writes the specified value as a JSON number value within the current array, field or root context.
protected void	writeColon()
protected void	writeComma()
JsonGenerator	writeEnd()	Writes the end of the current context.
JsonGenerator	writeKey(String name)	Writes the JSON name with a colon.
JsonGenerator	writeNull()	Writes a JSON null value within the current array, field or root context.
JsonGenerator	writeNull(String name)	Writes a JSON name/null value pair in an current object context.
JsonGenerator	writeStartArray()	Writes the JSON start array character.
JsonGenerator	writeStartArray(String name)	Writes the JSON name/start array character pair with in the current object context.
JsonGenerator	writeStartObject()	Writes the JSON start object character.
JsonGenerator	writeStartObject(String name)	Writes the JSON name/start object character pair in the current object context.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonPrettyGeneratorImpl

public JsonPrettyGeneratorImpl(Writer writer,
                               BufferPool bufferPool)

JsonPrettyGeneratorImpl

public JsonPrettyGeneratorImpl(OutputStream out,
                               BufferPool bufferPool)

JsonPrettyGeneratorImpl

public JsonPrettyGeneratorImpl(OutputStream out,
                               Charset encoding,
                               BufferPool bufferPool)

Method Detail

writeStartObject

public JsonGenerator writeStartObject()

Description copied from interface: JsonGenerator

Writes the JSON start object character. It starts a new child object context within which JSON name/value pairs can be written to the object. This method is valid only in an array context, field context or in no context (when a context is not yet started). This method can only be called once in no context.

Specified by:

writeStartObject in interface JsonGenerator

Returns:

this generator

writeStartObject

public JsonGenerator writeStartObject(String name)

Description copied from interface: JsonGenerator

Writes the JSON name/start object character pair in the current object context. It starts a new child object context within which JSON name/value pairs can be written to the object.

Specified by:

writeStartObject in interface JsonGenerator

Parameters:

name - a name within the JSON name/object pair to be written

Returns:

this generator

writeStartArray

public JsonGenerator writeStartArray()

Description copied from interface: JsonGenerator

Writes the JSON start array character. It starts a new child array context within which JSON values can be written to the array. This method is valid only in an array context, field context or in no context (when a context is not yet started). This method can only be called once in no context.

Specified by:

writeStartArray in interface JsonGenerator

Returns:

this generator

writeStartArray

public JsonGenerator writeStartArray(String name)

Description copied from interface: JsonGenerator

Writes the JSON name/start array character pair with in the current object context. It starts a new child array context within which JSON values can be written to the array.

Specified by:

writeStartArray in interface JsonGenerator

Parameters:

name - a name within the JSON name/array pair to be written

Returns:

this generator

writeEnd

public JsonGenerator writeEnd()

Description copied from interface: JsonGenerator

Writes the end of the current context. If the current context is an array context, this method writes the end-of-array character (']'). If the current context is an object context, this method writes the end-of-object character ('}'). After writing the end of the current context, the parent context becomes the new current context. If parent context is field context, it is closed.

Specified by:

writeEnd in interface JsonGenerator

Returns:

this generator

writeComma

protected void writeComma()

writeColon

protected void writeColon()

flush

public void flush()

Description copied from interface: JsonGenerator

Flushes the underlying output source. If the generator has saved any characters in a buffer, writes them immediately to the underlying output source before flushing it.

Specified by:

flush in interface Flushable

Specified by:

flush in interface JsonGenerator

write

public JsonGenerator write(String name,
                           String fieldValue)

Description copied from interface: JsonGenerator

Writes a JSON name/string value pair in the current object context. The specified value is written as JSON string value.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/string pair to be written in current JSON object

fieldValue - a value in the JSON name/string pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String name,
                           int value)

Description copied from interface: JsonGenerator

Writes a JSON name/number value pair in the current object context. The specified value is written as a JSON number value. The string new BigDecimal(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/number pair to be written in current JSON object

value - a value in the JSON name/number pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String name,
                           long value)

Description copied from interface: JsonGenerator

Writes a JSON name/number value pair in the current object context. The specified value is written as a JSON number value. The string new BigDecimal(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/number pair to be written in current JSON object

value - a value in the JSON name/number pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String name,
                           double value)

Description copied from interface: JsonGenerator

Writes a JSON name/number value pair in the current object context. The specified value is written as a JSON number value. The string BigDecimal.valueOf(double).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/number pair to be written in current JSON object

value - a value in the JSON name/number pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String name,
                           BigInteger value)

Description copied from interface: JsonGenerator

Writes a JSON name/number value pair in the current object context. The specified value is written as a JSON number value. The string new BigDecimal(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/number pair to be written in current JSON object

value - a value in the JSON name/number pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String name,
                           BigDecimal value)

Description copied from interface: JsonGenerator

Writes a JSON name/number value pair in the current object context. The specified value is written as a JSON number value. The specified value's toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/number pair to be written in current JSON object

value - a value in the JSON name/number pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String name,
                           boolean value)

Description copied from interface: JsonGenerator

Writes a JSON name/boolean value pair in the current object context. If value is true, it writes the JSON true value, otherwise it writes the JSON false value.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/boolean pair to be written in current JSON object

value - a value in the JSON name/boolean pair to be written in current JSON object

Returns:

this generator

writeNull

public JsonGenerator writeNull(String name)

Description copied from interface: JsonGenerator

Writes a JSON name/null value pair in an current object context.

Specified by:

writeNull in interface JsonGenerator

Parameters:

name - a name in the JSON name/null pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(JsonValue value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON value within the current array, field or root context.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator

write

public JsonGenerator write(String name,
                           JsonValue value)

Description copied from interface: JsonGenerator

Writes a JSON name/value pair in the current object context.

Specified by:

write in interface JsonGenerator

Parameters:

name - a name in the JSON name/value pair to be written in current JSON object

value - a value in the JSON name/value pair to be written in current JSON object

Returns:

this generator

write

public JsonGenerator write(String value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON string value within the current array, field or root context.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator

write

public JsonGenerator write(int value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON number value within the current array, field or root context. The string new BigDecimal(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator

write

public JsonGenerator write(long value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON number value within the current array, field or root context. The string new BigDecimal(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator

write

public JsonGenerator write(double value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON number value within the current array, field or root context. The string BigDecimal.valueOf(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator

write

public JsonGenerator write(BigInteger value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON number value within the current array, field or root context. The string new BigDecimal(value).toString() is used as the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator.

See Also:

JsonNumber

write

public JsonGenerator write(BigDecimal value)

Description copied from interface: JsonGenerator

Writes the specified value as a JSON number value within the current array, field or root context. The specified value's toString() is used as the the text value for writing.

Specified by:

write in interface JsonGenerator

Parameters:

value - a value to be written in current JSON array

Returns:

this generator

See Also:

JsonNumber

write

public JsonGenerator write(boolean value)

Description copied from interface: JsonGenerator

Writes a JSON true or false value within the current array, field or root context. If value is true, this method writes the JSON true value, otherwise it writes the JSON false value.

Specified by:

write in interface JsonGenerator

Parameters:

value - a boolean value

Returns:

this generator

writeNull

public JsonGenerator writeNull()

Description copied from interface: JsonGenerator

Writes a JSON null value within the current array, field or root context.

Specified by:

writeNull in interface JsonGenerator

Returns:

this generator

writeKey

public JsonGenerator writeKey(String name)

Description copied from interface: JsonGenerator

Writes the JSON name with a colon. It starts a field context, in which valid options are writing a value, starting an object or an array. Writing value closes field context, if object or array is started after field name, field context will be closed after object/array close.

Specified by:

writeKey in interface JsonGenerator

Parameters:

name - name of json field

Returns:

this generator

inNone

protected boolean inNone()

close

public void close()

Description copied from interface: JsonGenerator

Closes this generator and frees any resources associated with it. This method closes the underlying output source.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface JsonGenerator