us.hebi.quickbuf

Class JsonSource

java.lang.Object

us.hebi.quickbuf.JsonSource

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class JsonSource
extends Object
implements Closeable

Reads proto messages from a JSON format compatible with

https://developers.google.com/protocol-buffers/docs/proto3#json

Since:

08 Sep 2020

Author:

Florian Enner

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ignoreUnknownFields

Constructor Summary

Constructors

Constructor and Description
JsonSource()

Method Summary

Modifier and Type	Method and Description
abstract void	beginArray()
abstract boolean	beginObject() Consumes the begin object token.
protected static void	decodeBase64(RepeatedByte input, RepeatedByte output)
protected static void	decodeBase64(String input, RepeatedByte output)
abstract void	endArray()
abstract void	endObject()
abstract boolean	isAtEnd() Returns true if the source has reached the end of the input, or the end of an object or array.
boolean	isAtField(FieldName fieldName)
protected abstract boolean	isAtNull()
static JsonSource	newInstance(byte[] bytes)
static JsonSource	newInstance(byte[] bytes, int offset, int length)
static JsonSource	newInstance(InputStream inputStream)
static JsonSource	newInstance(RepeatedByte bytes)
static JsonSource	newInstance(String string)
<ProtoMsg extends ProtoMessage<ProtoMsg>> ProtoMsg	parseMessage(MessageFactory<ProtoMsg> factory) Parses a root-level object of the given message type and checks for required field initialization
<ProtoMsg extends ProtoMessage<ProtoMsg>> RepeatedMessage<ProtoMsg>	parseRepeatedMessage(MessageFactory<ProtoMsg> factory) Parses a root-level array of the given message type and checks for required field initialization
abstract boolean	readBool() Read a bool field value from the source.
abstract void	readBytes(RepeatedByte store) Read a bytes field value from the source.
abstract ProtoSource	readBytesAsSource()
abstract double	readDouble() Read a double field value from the source.
abstract <T extends ProtoEnum<?>> T	readEnum(ProtoEnum.EnumConverter<T> converter) Read a enum field value from the source.
int	readFieldHash()
int	readFieldHashOrZero()
protected abstract CharSequence	readFieldName()
int	readFixed32() Read a fixed32 field value from the source.
long	readFixed64() Read a fixed64 field value from the source.
float	readFloat() Read a float field value from the source.
<ProtoMsg extends ProtoMessage<ProtoMsg>> ProtoMsg	readGroup(ProtoMsg msg) Read a group field value from the source.
abstract int	readInt32() Read an int32 field value from the source.
abstract long	readInt64() Read an int64 field value from the source.
<ProtoMsg extends ProtoMessage<ProtoMsg>> ProtoMsg	readMessage(ProtoMsg msg) Reads a message value from the source and merges the contents into the provided message
void	readRepeatedBool(RepeatedBoolean value)
void	readRepeatedBytes(RepeatedBytes value)
void	readRepeatedDouble(RepeatedDouble value)
<E extends ProtoEnum<?>> void	readRepeatedEnum(RepeatedEnum<E> value, ProtoEnum.EnumConverter<E> converter)
void	readRepeatedFixed32(RepeatedInt value)
void	readRepeatedFixed64(RepeatedLong value)
void	readRepeatedFloat(RepeatedFloat value)
void	readRepeatedGroup(RepeatedMessage<?> value)
void	readRepeatedInt32(RepeatedInt value)
void	readRepeatedInt64(RepeatedLong value)
<ProtoMsg extends ProtoMessage<ProtoMsg>> RepeatedMessage<ProtoMsg>	readRepeatedMessage(RepeatedMessage<ProtoMsg> value)
void	readRepeatedSFixed32(RepeatedInt value)
void	readRepeatedSFixed64(RepeatedLong value)
void	readRepeatedSInt32(RepeatedInt value)
void	readRepeatedSInt64(RepeatedLong value)
void	readRepeatedString(RepeatedString value)
void	readRepeatedUInt32(RepeatedInt value)
void	readRepeatedUInt64(RepeatedLong value)
int	readSFixed32() Read an sfixed32 field value from the source.
long	readSFixed64() Read an sfixed64 field value from the source.
int	readSInt32() Read an sint32 field value from the source.
long	readSInt64() Read an sint64 field value from the source.
abstract void	readString(Utf8String store) Read a string field value from the source.
int	readUInt32() Read a uint32 field value from the source.
long	readUInt64() Read a uint64 field value from the source.
JsonSource	setIgnoreUnknownFields(boolean ignoreUnknownFields) Allows to serialize enums as human readable strings or as JSON numbers.
void	skipUnknownEnumValue()
void	skipUnknownField()
protected abstract void	skipValue() Skips the current value
boolean	trySkipNullValue()

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

Field Detail

ignoreUnknownFields

protected boolean ignoreUnknownFields

Constructor Detail

JsonSource

public JsonSource()

Method Detail

newInstance

public static JsonSource newInstance(byte[] bytes)

newInstance

public static JsonSource newInstance(byte[] bytes,
                                     int offset,
                                     int length)

newInstance

public static JsonSource newInstance(RepeatedByte bytes)

newInstance

public static JsonSource newInstance(InputStream inputStream)

newInstance

public static JsonSource newInstance(String string)

parseMessage

public <ProtoMsg extends ProtoMessage<ProtoMsg>> ProtoMsg parseMessage(MessageFactory<ProtoMsg> factory)
                                                                throws IOException

Parses a root-level object of the given message type and checks for required field initialization

Throws:

IOException

parseRepeatedMessage

public <ProtoMsg extends ProtoMessage<ProtoMsg>> RepeatedMessage<ProtoMsg> parseRepeatedMessage(MessageFactory<ProtoMsg> factory)
                                                                                         throws IOException

Parses a root-level array of the given message type and checks for required field initialization

Throws:

IOException

setIgnoreUnknownFields

public JsonSource setIgnoreUnknownFields(boolean ignoreUnknownFields)

Allows to serialize enums as human readable strings or as JSON numbers. Compatible parsers are able to parse either case.

Unknown values will still be serialized as numbers.

Parameters:

ignoreUnknownFields - true if values should use strings

Returns:

this

skipUnknownField

public void skipUnknownField()
                      throws IOException

Throws:

IOException

skipUnknownEnumValue

public void skipUnknownEnumValue()
                          throws IOException

Throws:

IOException

readDouble

public abstract double readDouble()
                           throws IOException

Read a double field value from the source.

JSON value will be a number or one of the special string values "NaN", "Infinity", and "-Infinity". Either numbers or strings are accepted. Exponent notation is also accepted. -0 is considered equivalent to 0.

Throws:

IOException

readInt32

public abstract int readInt32()
                       throws IOException

Read an int32 field value from the source. Either numbers or strings are accepted.

Throws:

IOException

readInt64

public abstract long readInt64()
                        throws IOException

Read an int64 field value from the source. Either numbers or strings are accepted.

Throws:

IOException

readBool

public abstract boolean readBool()
                          throws IOException

Read a bool field value from the source. Parsers accept true or false.

Throws:

IOException

readEnum

public abstract <T extends ProtoEnum<?>> T readEnum(ProtoEnum.EnumConverter<T> converter)
                                             throws IOException

Read a enum field value from the source.

The name of the enum value as specified in proto is used. Parsers accept both enum names and integer values.

Returns:

enum object, or null if unknown

Throws:

IOException

readString

public abstract void readString(Utf8String store)
                         throws IOException

Read a string field value from the source.

Throws:

IOException

readBytes

public abstract void readBytes(RepeatedByte store)
                        throws IOException

Read a bytes field value from the source.

Either standard or URL-safe base64 encoding with/without paddings are accepted.

Throws:

IOException

readBytesAsSource

public abstract ProtoSource readBytesAsSource()
                                       throws IOException

Returns:

a ProtoSource of the binary bytes

Throws:

IOException

readMessage

public <ProtoMsg extends ProtoMessage<ProtoMsg>> ProtoMsg readMessage(ProtoMsg msg)
                                                               throws IOException

Reads a message value from the source and merges the contents into the provided message

Throws:

IOException

skipValue

protected abstract void skipValue()
                           throws IOException

Skips the current value

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Read a float field value from the source.

Throws:

IOException

readUInt64

public long readUInt64()
                throws IOException

Read a uint64 field value from the source.

Throws:

IOException

readFixed64

public long readFixed64()
                 throws IOException

Read a fixed64 field value from the source.

Throws:

IOException

readFixed32

public int readFixed32()
                throws IOException

Read a fixed32 field value from the source.

Throws:

IOException

readGroup

public <ProtoMsg extends ProtoMessage<ProtoMsg>> ProtoMsg readGroup(ProtoMsg msg)
                                                             throws IOException

Read a group field value from the source.

Throws:

IOException

readUInt32

public int readUInt32()
               throws IOException

Read a uint32 field value from the source.

Throws:

IOException

readSFixed32

public int readSFixed32()
                 throws IOException

Read an sfixed32 field value from the source.

Throws:

IOException

readSFixed64

public long readSFixed64()
                  throws IOException

Read an sfixed64 field value from the source.

Throws:

IOException

readSInt32

public int readSInt32()
               throws IOException

Read an sint32 field value from the source.

Throws:

IOException

readSInt64

public long readSInt64()
                throws IOException

Read an sint64 field value from the source.

Throws:

IOException

readRepeatedFixed64

public void readRepeatedFixed64(RepeatedLong value)
                         throws IOException

Throws:

IOException

readRepeatedSFixed64

public void readRepeatedSFixed64(RepeatedLong value)
                          throws IOException

Throws:

IOException

readRepeatedUInt64

public void readRepeatedUInt64(RepeatedLong value)
                        throws IOException

Throws:

IOException

readRepeatedSInt64

public void readRepeatedSInt64(RepeatedLong value)
                        throws IOException

Throws:

IOException

readRepeatedFixed32

public void readRepeatedFixed32(RepeatedInt value)
                         throws IOException

Throws:

IOException

readRepeatedSFixed32

public void readRepeatedSFixed32(RepeatedInt value)
                          throws IOException

Throws:

IOException

readRepeatedUInt32

public void readRepeatedUInt32(RepeatedInt value)
                        throws IOException

Throws:

IOException

readRepeatedSInt32

public void readRepeatedSInt32(RepeatedInt value)
                        throws IOException

Throws:

IOException

readRepeatedGroup

public void readRepeatedGroup(RepeatedMessage<?> value)
                       throws IOException

Throws:

IOException

readRepeatedDouble

public void readRepeatedDouble(RepeatedDouble value)
                        throws IOException

Throws:

IOException

readRepeatedInt64

public void readRepeatedInt64(RepeatedLong value)
                       throws IOException

Throws:

IOException

readRepeatedFloat

public void readRepeatedFloat(RepeatedFloat value)
                       throws IOException

Throws:

IOException

readRepeatedInt32

public void readRepeatedInt32(RepeatedInt value)
                       throws IOException

Throws:

IOException

readRepeatedMessage

public <ProtoMsg extends ProtoMessage<ProtoMsg>> RepeatedMessage<ProtoMsg> readRepeatedMessage(RepeatedMessage<ProtoMsg> value)
                                                                                        throws IOException

Throws:

IOException

readRepeatedString

public void readRepeatedString(RepeatedString value)
                        throws IOException

Throws:

IOException

readRepeatedEnum

public <E extends ProtoEnum<?>> void readRepeatedEnum(RepeatedEnum<E> value,
                                                      ProtoEnum.EnumConverter<E> converter)
                                               throws IOException

Throws:

IOException

readRepeatedBool

public void readRepeatedBool(RepeatedBoolean value)
                      throws IOException

Throws:

IOException

readRepeatedBytes

public void readRepeatedBytes(RepeatedBytes value)
                       throws IOException

Throws:

IOException

beginArray

public abstract void beginArray()
                         throws IOException

Throws:

IOException

endArray

public abstract void endArray()
                       throws IOException

Throws:

IOException

beginObject

public abstract boolean beginObject()
                             throws IOException

Consumes the begin object token. Fails if it encounters anything else.

Returns:

always true. Not void for backwards compatibility reasons.

Throws:

IOException

endObject

public abstract void endObject()
                        throws IOException

Throws:

IOException

isAtEnd

public abstract boolean isAtEnd()
                         throws IOException

Returns true if the source has reached the end of the input, or the end of an object or array.

Throws:

IOException

trySkipNullValue

public boolean trySkipNullValue()
                         throws IOException

Throws:

IOException

isAtNull

protected abstract boolean isAtNull()
                             throws IOException

Throws:

IOException

readFieldHash

public final int readFieldHash()
                        throws IOException

Throws:

IOException

readFieldHashOrZero

public final int readFieldHashOrZero()
                              throws IOException

Returns:

next field hash or zero if hasNext() returns false

Throws:

IOException

isAtField

public boolean isAtField(FieldName fieldName)

Parameters:

fieldName - expected field

Returns:

true if the next value is for the expected field and not null

readFieldName

protected abstract CharSequence readFieldName()
                                       throws IOException

Returns:

a char sequence that does not get modified between subsequent calls to this method

Throws:

IOException

decodeBase64

protected static void decodeBase64(String input,
                                   RepeatedByte output)

decodeBase64

protected static void decodeBase64(RepeatedByte input,
                                   RepeatedByte output)