us.hebi.quickbuf

Class JsonSink

java.lang.Object

us.hebi.quickbuf.JsonSink

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public abstract class JsonSink
extends Object
implements Closeable, Flushable

Prints proto messages in a JSON compatible format

Since:

26 Oct 2019

Author:

Florian Enner

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	preserveProtoFieldNames
protected boolean	writeEnumsAsInts

Constructor Summary

Constructors

Constructor and Description
JsonSink()

Method Summary

Modifier and Type	Method and Description
protected abstract void	beginArray()
abstract JsonSink	beginObject()
abstract JsonSink	clear() Clears internal state.
protected abstract void	endArray()
abstract JsonSink	endObject()
RepeatedByte	getBytes()
CharSequence	getChars()
static JsonSink	newInstance() Create a new JsonSink with a new internal buffer.
static JsonSink	newInstance(RepeatedByte output) Create a new JsonSink that writes directly to the given output.
static JsonSink	newPrettyInstance() Create a new JsonSink with a new internal buffer.
JsonSink	reserve(int length) Ensures that the underlying buffer can hold at least the desired number of bytes.
JsonSink	setOutput(RepeatedByte output) Changes the output to the given bytes.
JsonSink	setPreserveProtoFieldNames(boolean preserveProtoFieldNames) The serialized JSON object keys map to the value defined by the 'json_name' option, or the lowerCamelCase version of the field name in the proto file.
JsonSink	setPrettyPrinting(boolean prettyPrinting) Sets the output to be pretty printed (newlines and spaces) for increased readability, or minified (default without whitespace) for efficiency.
JsonSink	setWriteEnumsAsInts(boolean writeEnumsAsInts) Serializes enum values as JSON integers rather than human- readable strings.
protected void	writeBinary(RepeatedByte value)
JsonSink	writeBool(FieldName name, boolean value)
protected abstract void	writeBoolean(boolean value)
JsonSink	writeBytes(FieldName name, RepeatedByte value)
JsonSink	writeDouble(FieldName name, double value)
JsonSink	writeEnum(FieldName name, int value, ProtoEnum.EnumConverter<?> converter)
protected void	writeEnumValue(int number, ProtoEnum.EnumConverter<?> converter)
protected abstract void	writeFieldName(FieldName name)
JsonSink	writeFixed32(FieldName name, int value)
JsonSink	writeFixed64(FieldName name, long value)
JsonSink	writeFloat(FieldName name, float value)
JsonSink	writeGroup(FieldName name, ProtoMessage value)
JsonSink	writeInt32(FieldName name, int value)
JsonSink	writeInt64(FieldName name, long value)
JsonSink	writeMessage(FieldName name, ProtoMessage<?> value)
JsonSink	writeMessage(ProtoMessage<?> value) Writes a top level object {content}
JsonSink	writeMessageSilent(ProtoMessage<?> value) Convenience overload for writing to in-memory sinks that don't throw IOException
protected abstract void	writeMessageValue(ProtoMessage<?> value)
protected abstract void	writeNumber(double value)
protected abstract void	writeNumber(float value)
protected abstract void	writeNumber(int value)
protected abstract void	writeNumber(long value)
JsonSink	writeRepeatedBool(FieldName name, RepeatedBoolean value)
JsonSink	writeRepeatedBytes(FieldName name, RepeatedBytes value)
JsonSink	writeRepeatedDouble(FieldName name, RepeatedDouble value)
JsonSink	writeRepeatedEnum(FieldName name, RepeatedEnum<?> value)
JsonSink	writeRepeatedFixed32(FieldName name, RepeatedInt value)
JsonSink	writeRepeatedFixed64(FieldName name, RepeatedLong value)
JsonSink	writeRepeatedFloat(FieldName name, RepeatedFloat value)
JsonSink	writeRepeatedGroup(FieldName name, RepeatedMessage<?> value)
JsonSink	writeRepeatedInt32(FieldName name, RepeatedInt value)
JsonSink	writeRepeatedInt64(FieldName name, RepeatedLong value)
JsonSink	writeRepeatedMessage(FieldName name, RepeatedMessage<?> value)
JsonSink	writeRepeatedMessage(RepeatedMessage<?> value) Writes a top-level array [content]
JsonSink	writeRepeatedMessageSilent(RepeatedMessage<?> value) Convenience overload for writing to in-memory sinks that don't throw IOException
JsonSink	writeRepeatedSFixed32(FieldName name, RepeatedInt value)
JsonSink	writeRepeatedSFixed64(FieldName name, RepeatedLong value)
JsonSink	writeRepeatedSInt32(FieldName name, RepeatedInt value)
JsonSink	writeRepeatedSInt64(FieldName name, RepeatedLong value)
JsonSink	writeRepeatedString(FieldName name, RepeatedString value)
JsonSink	writeRepeatedUInt32(FieldName name, RepeatedInt value)
JsonSink	writeRepeatedUInt64(FieldName name, RepeatedLong value)
JsonSink	writeSFixed32(FieldName name, int value)
JsonSink	writeSFixed64(FieldName name, long value)
JsonSink	writeSInt32(FieldName name, int value)
JsonSink	writeSInt64(FieldName name, long value)
protected abstract void	writeString(CharSequence value)
JsonSink	writeString(FieldName name, CharSequence value)
JsonSink	writeString(FieldName name, Utf8String value)
protected abstract void	writeString(Utf8String value)
JsonSink	writeUInt32(FieldName name, int value)
JsonSink	writeUInt64(FieldName name, long value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Field Detail

writeEnumsAsInts

protected boolean writeEnumsAsInts

preserveProtoFieldNames

protected boolean preserveProtoFieldNames

Constructor Detail

JsonSink

public JsonSink()

Method Detail

newInstance

public static JsonSink newInstance(RepeatedByte output)

Create a new JsonSink that writes directly to the given output. If more bytes are written than fit in the array, the size will grow as needed.

Note that growing is quite inefficient, so the buffers should have an appropriate initial size and be reused.

newInstance

public static JsonSink newInstance()

Create a new JsonSink with a new internal buffer. The size of the buffer will grow as needed. The resulting buffer can be accessed with getBytes()

The output is minimized JSON without extra whitespace for sending data over the wire. Enums are serialized as strings by default.

newPrettyInstance

public static JsonSink newPrettyInstance()

Create a new JsonSink with a new internal buffer. The size of the buffer will grow as needed. The resulting buffer can be accessed with getBytes()

The output contains extra whitespace to improve human readability

setOutput

public JsonSink setOutput(RepeatedByte output)

Changes the output to the given bytes. This resets any existing internal state and is equivalent to creating a new instance.

reserve

public JsonSink reserve(int length)

Ensures that the underlying buffer can hold at least the desired number of bytes.

clear

public abstract JsonSink clear()

Clears internal state. This is equivalent to creating a new instance.

getBytes

public RepeatedByte getBytes()

Returns:

the current output as raw utf8 bytes

getChars

public CharSequence getChars()

Returns:

the current output as char sequence

setWriteEnumsAsInts

public JsonSink setWriteEnumsAsInts(boolean writeEnumsAsInts)

Serializes enum values as JSON integers rather than human- readable strings. Compatible parsers are able to parse either case.

Unknown values will still be serialized as numbers.

Parameters:

writeEnumsAsInts - true if values should use strings

Returns:

this

setPreserveProtoFieldNames

public JsonSink setPreserveProtoFieldNames(boolean preserveProtoFieldNames)

The serialized JSON object keys map to the value defined by the 'json_name' option, or the lowerCamelCase version of the field name in the proto file.

This option lets users choose to preserve the original field names as defined in the proto file. Conforming parsers accept both keys.

Parameters:

preserveProtoFieldNames - true uses the original field names as JSON object keys

Returns:

this

setPrettyPrinting

public JsonSink setPrettyPrinting(boolean prettyPrinting)

Sets the output to be pretty printed (newlines and spaces) for increased readability, or minified (default without whitespace) for efficiency.

Parameters:

prettyPrinting - true adds whitespace to make the result more human-readable

Returns:

this

writeMessageSilent

public JsonSink writeMessageSilent(ProtoMessage<?> value)

Convenience overload for writing to in-memory sinks that don't throw IOException

writeRepeatedMessageSilent

public JsonSink writeRepeatedMessageSilent(RepeatedMessage<?> value)

Convenience overload for writing to in-memory sinks that don't throw IOException

writeMessage

public JsonSink writeMessage(ProtoMessage<?> value)
                      throws IOException

Writes a top level object {content}

Throws:

IOException

writeRepeatedMessage

public JsonSink writeRepeatedMessage(RepeatedMessage<?> value)
                              throws IOException

Writes a top-level array [content]

Throws:

IOException

writeFixed64

public JsonSink writeFixed64(FieldName name,
                             long value)
                      throws IOException

Throws:

IOException

writeSFixed64

public JsonSink writeSFixed64(FieldName name,
                              long value)
                       throws IOException

Throws:

IOException

writeUInt64

public JsonSink writeUInt64(FieldName name,
                            long value)
                     throws IOException

Throws:

IOException

writeSInt64

public JsonSink writeSInt64(FieldName name,
                            long value)
                     throws IOException

Throws:

IOException

writeFixed32

public JsonSink writeFixed32(FieldName name,
                             int value)
                      throws IOException

Throws:

IOException

writeSFixed32

public JsonSink writeSFixed32(FieldName name,
                              int value)
                       throws IOException

Throws:

IOException

writeUInt32

public JsonSink writeUInt32(FieldName name,
                            int value)
                     throws IOException

Throws:

IOException

writeSInt32

public JsonSink writeSInt32(FieldName name,
                            int value)
                     throws IOException

Throws:

IOException

writeGroup

public JsonSink writeGroup(FieldName name,
                           ProtoMessage value)
                    throws IOException

Throws:

IOException

writeRepeatedFixed64

public JsonSink writeRepeatedFixed64(FieldName name,
                                     RepeatedLong value)
                              throws IOException

Throws:

IOException

writeRepeatedSFixed64

public JsonSink writeRepeatedSFixed64(FieldName name,
                                      RepeatedLong value)
                               throws IOException

Throws:

IOException

writeRepeatedUInt64

public JsonSink writeRepeatedUInt64(FieldName name,
                                    RepeatedLong value)
                             throws IOException

Throws:

IOException

writeRepeatedSInt64

public JsonSink writeRepeatedSInt64(FieldName name,
                                    RepeatedLong value)
                             throws IOException

Throws:

IOException

writeRepeatedFixed32

public JsonSink writeRepeatedFixed32(FieldName name,
                                     RepeatedInt value)
                              throws IOException

Throws:

IOException

writeRepeatedSFixed32

public JsonSink writeRepeatedSFixed32(FieldName name,
                                      RepeatedInt value)
                               throws IOException

Throws:

IOException

writeRepeatedUInt32

public JsonSink writeRepeatedUInt32(FieldName name,
                                    RepeatedInt value)
                             throws IOException

Throws:

IOException

writeRepeatedSInt32

public JsonSink writeRepeatedSInt32(FieldName name,
                                    RepeatedInt value)
                             throws IOException

Throws:

IOException

writeRepeatedGroup

public JsonSink writeRepeatedGroup(FieldName name,
                                   RepeatedMessage<?> value)
                            throws IOException

Throws:

IOException

writeDouble

public JsonSink writeDouble(FieldName name,
                            double value)
                     throws IOException

Throws:

IOException

writeFloat

public JsonSink writeFloat(FieldName name,
                           float value)
                    throws IOException

Throws:

IOException

writeInt64

public JsonSink writeInt64(FieldName name,
                           long value)
                    throws IOException

Throws:

IOException

writeInt32

public JsonSink writeInt32(FieldName name,
                           int value)
                    throws IOException

Throws:

IOException

writeEnum

public JsonSink writeEnum(FieldName name,
                          int value,
                          ProtoEnum.EnumConverter<?> converter)
                   throws IOException

Throws:

IOException

writeBool

public JsonSink writeBool(FieldName name,
                          boolean value)
                   throws IOException

Throws:

IOException

writeBytes

public JsonSink writeBytes(FieldName name,
                           RepeatedByte value)
                    throws IOException

Throws:

IOException

writeMessage

public JsonSink writeMessage(FieldName name,
                             ProtoMessage<?> value)
                      throws IOException

Throws:

IOException

writeString

public JsonSink writeString(FieldName name,
                            Utf8String value)
                     throws IOException

Throws:

IOException

writeString

public JsonSink writeString(FieldName name,
                            CharSequence value)
                     throws IOException

Throws:

IOException

writeRepeatedDouble

public JsonSink writeRepeatedDouble(FieldName name,
                                    RepeatedDouble value)
                             throws IOException

Throws:

IOException

writeRepeatedInt64

public JsonSink writeRepeatedInt64(FieldName name,
                                   RepeatedLong value)
                            throws IOException

Throws:

IOException

writeRepeatedFloat

public JsonSink writeRepeatedFloat(FieldName name,
                                   RepeatedFloat value)
                            throws IOException

Throws:

IOException

writeRepeatedInt32

public JsonSink writeRepeatedInt32(FieldName name,
                                   RepeatedInt value)
                            throws IOException

Throws:

IOException

writeRepeatedMessage

public JsonSink writeRepeatedMessage(FieldName name,
                                     RepeatedMessage<?> value)
                              throws IOException

Throws:

IOException

writeRepeatedString

public JsonSink writeRepeatedString(FieldName name,
                                    RepeatedString value)
                             throws IOException

Throws:

IOException

writeRepeatedEnum

public JsonSink writeRepeatedEnum(FieldName name,
                                  RepeatedEnum<?> value)
                           throws IOException

Throws:

IOException

writeRepeatedBool

public JsonSink writeRepeatedBool(FieldName name,
                                  RepeatedBoolean value)
                           throws IOException

Throws:

IOException

writeRepeatedBytes

public JsonSink writeRepeatedBytes(FieldName name,
                                   RepeatedBytes value)
                            throws IOException

Throws:

IOException

writeEnumValue

protected void writeEnumValue(int number,
                              ProtoEnum.EnumConverter<?> converter)
                       throws IOException

Throws:

IOException

writeFieldName

protected abstract void writeFieldName(FieldName name)
                                throws IOException

Parameters:

name - utf8 encoded bytes including end quotes and colon

Throws:

IOException

writeNumber

protected abstract void writeNumber(double value)
                             throws IOException

Throws:

IOException

writeNumber

protected abstract void writeNumber(float value)
                             throws IOException

Throws:

IOException

writeNumber

protected abstract void writeNumber(long value)
                             throws IOException

Throws:

IOException

writeNumber

protected abstract void writeNumber(int value)
                             throws IOException

Throws:

IOException

writeBoolean

protected abstract void writeBoolean(boolean value)
                              throws IOException

Throws:

IOException

writeString

protected abstract void writeString(Utf8String value)
                             throws IOException

Throws:

IOException

writeString

protected abstract void writeString(CharSequence value)
                             throws IOException

Throws:

IOException

writeBinary

protected void writeBinary(RepeatedByte value)
                    throws IOException

Throws:

IOException

writeMessageValue

protected abstract void writeMessageValue(ProtoMessage<?> value)
                                   throws IOException

Throws:

IOException

beginObject

public abstract JsonSink beginObject()
                              throws IOException

Throws:

IOException

endObject

public abstract JsonSink endObject()
                            throws IOException

Throws:

IOException

beginArray

protected abstract void beginArray()
                            throws IOException

Throws:

IOException

endArray

protected abstract void endArray()
                          throws IOException

Throws:

IOException