Package io.avaje.jsonb

Interface JsonReader

All Superinterfaces:

AutoCloseable, Closeable

public interface JsonReader
extends Closeable

Reads json content as a stream of JSON tokens and content.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JsonReader.Token	A structure, name, or value type in a JSON-encoded string.

Method Summary

Modifier and Type	Method	Description
void	beginArray()	Read array begin.
void	beginObject()	Read begin object.
void	close()	Close the resources of the reader.
JsonReader.Token	currentToken()	Return the current Token.
void	endArray()	Read array end.
void	endObject()	Read end object.
boolean	hasNextElement()	Return true if there is a next element in an ARRAY.
boolean	hasNextField()	Return true if there is a next field to be read in an OBJECT.
boolean	isNullValue()	Return true if the value to be read is a null.
String	location()	Return the current location.
void	names(PropertyNames names)	Set the current property names.
String	nextField()	Return the next field.
BigInteger	readBigInteger()	Read and return the next value as a BigInteger.
boolean	readBoolean()	Read and return the next value as a boolean.
BigDecimal	readDecimal()	Read and return the next value as a BigDecimal.
double	readDouble()	Read and return the next value as a double.
int	readInt()	Read and return the next value as an int.
long	readLong()	Read and return the next value as a long.
String	readString()	Read and return the next value as String.
void	skipValue()	Skip the next value.
void	unmappedField(String fieldName)	Reading json with an unmapped field, throw an Exception if failOnUnmapped is true.

Method Detail

names

void names(PropertyNames names)

Set the current property names.

Can be used by the reader to optimise the reading of known names.

beginArray

void beginArray()

Read array begin.

endArray

void endArray()

Read array end.

hasNextElement

boolean hasNextElement()

Return true if there is a next element in an ARRAY.

beginObject

void beginObject()

Read begin object.

endObject

void endObject()

Read end object.

hasNextField

boolean hasNextField()

Return true if there is a next field to be read in an OBJECT.

nextField

String nextField()

Return the next field.

isNullValue

boolean isNullValue()

Return true if the value to be read is a null.

readBoolean

boolean readBoolean()

Read and return the next value as a boolean.

readInt

int readInt()

Read and return the next value as an int.

readLong

long readLong()

Read and return the next value as a long.

readDouble

double readDouble()

Read and return the next value as a double.

readDecimal

BigDecimal readDecimal()

Read and return the next value as a BigDecimal.

readBigInteger

BigInteger readBigInteger()

Read and return the next value as a BigInteger.

readString

String readString()

Read and return the next value as String.

location

String location()

Return the current location. This is typically used when reporting errors.

currentToken

JsonReader.Token currentToken()

Return the current Token.

close

void close()

Close the resources of the reader.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

skipValue

void skipValue()

Skip the next value.

unmappedField

void unmappedField(String fieldName)

Reading json with an unmapped field, throw an Exception if failOnUnmapped is true.