Class JsonGenerator (1.42.3)

public abstract class JsonGenerator implements Closeable, Flushable

Abstract low-level JSON serializer.

Implementation has no fields and therefore thread-safe, but sub-classes are not necessarily thread-safe.

Inheritance

Object > JsonGenerator

Implements

Closeable, Flushable

Constructors

JsonGenerator()

public JsonGenerator()

Methods

close()

public abstract void close()

Closes the serializer and the underlying output stream or writer, and releases any memory associated with it.

Exceptions
TypeDescription
IOException

enablePrettyPrint()

public void enablePrettyPrint()

Requests that the output be pretty printed (by default it is not).

Default implementation does nothing, but implementations may override to provide actual pretty printing.

Exceptions
TypeDescription
IOException

possible I/O exception (unused in default implementation)

flush()

public abstract void flush()

Flushes any buffered content to the underlying output stream or writer.

Exceptions
TypeDescription
IOException

getFactory()

public abstract JsonFactory getFactory()

Returns the JSON factory from which this generator was created.

Returns
TypeDescription
JsonFactory

serialize(Object value)

public final void serialize(Object value)

Serializes the given JSON value object, or if value is null it does no serialization.

Parameter
NameDescription
valueObject
Exceptions
TypeDescription
IOException

writeBoolean(boolean state)

public abstract void writeBoolean(boolean state)

Writes a literal JSON boolean value ('true' or 'false').

Parameter
NameDescription
stateboolean
Exceptions
TypeDescription
IOException

writeEndArray()

public abstract void writeEndArray()

Writes a JSON end array character ']'.

Exceptions
TypeDescription
IOException

writeEndObject()

public abstract void writeEndObject()

Writes a JSON end object character '}'.

Exceptions
TypeDescription
IOException

writeFieldName(String name)

public abstract void writeFieldName(String name)

Writes a JSON quoted field name.

Parameter
NameDescription
nameString
Exceptions
TypeDescription
IOException

writeNull()

public abstract void writeNull()

Writes a literal JSON null value.

Exceptions
TypeDescription
IOException

writeNumber(double v)

public abstract void writeNumber(double v)

Writes a JSON double value.

Parameter
NameDescription
vdouble
Exceptions
TypeDescription
IOException

writeNumber(float v)

public abstract void writeNumber(float v)

Writes a JSON float value.

Parameter
NameDescription
vfloat
Exceptions
TypeDescription
IOException

writeNumber(int v)

public abstract void writeNumber(int v)

Writes a JSON int value.

Parameter
NameDescription
vint
Exceptions
TypeDescription
IOException

writeNumber(String encodedValue)

public abstract void writeNumber(String encodedValue)

Writes a JSON numeric value that has already been encoded properly.

Parameter
NameDescription
encodedValueString
Exceptions
TypeDescription
IOException

writeNumber(BigDecimal v)

public abstract void writeNumber(BigDecimal v)

Writes a JSON big decimal value.

Parameter
NameDescription
vBigDecimal
Exceptions
TypeDescription
IOException

writeNumber(BigInteger v)

public abstract void writeNumber(BigInteger v)

Writes a JSON big integer value.

Parameter
NameDescription
vBigInteger
Exceptions
TypeDescription
IOException

writeNumber(long v)

public abstract void writeNumber(long v)

Writes a JSON long value.

Parameter
NameDescription
vlong
Exceptions
TypeDescription
IOException

writeStartArray()

public abstract void writeStartArray()

Writes a JSON start array character '['.

Exceptions
TypeDescription
IOException

writeStartObject()

public abstract void writeStartObject()

Writes a JSON start object character '{'.

Exceptions
TypeDescription
IOException

writeString(String value)

public abstract void writeString(String value)

Writes a JSON quoted string value.

Parameter
NameDescription
valueString
Exceptions
TypeDescription
IOException